Welcome to TraceT’s documentation!

This documentation is designed for users and developers of the TraceT web application.

Research users will find the first three sections most useful as it explains what TraceT is (Introduction), how to use it (Using TraceT) and the methods it uses (Trigger Logic)

Developers or administrators will find the following three sections more useful as it includes how to install and maintain the server (Web Application), explanations of the software methodologies and layout (Developer Documentation) and the documentation of the TraceT python module (TraceT Package).

Introduction:

• TraceT
• Overview of TraceT
• Nomenclature

Using TraceT:

• Creating a New Proposal
  • Step 1: Creating the Proposal
  • Step 2: Check the Flowchart
  • Step 3: Update Alert Permissions
  • Step 4: Notify Users to Update their Alerts
• Creating a New User
  • Create a User
  • Update Alert Permissions
  • Notify the User to Add Alerts
  • Verifying Your Phone Number on Twilio
• Using the database
  • Uploading a VOEvent

Trigger Logic:

• Event Handling
• Gamma-ray Burst Triggering Logic

Web Application:

• Database Installation
  • Dependancies
  • Environment Variables
  • Start the Postgres Database
  • Setup database for the first time
  • Create a superuser
  • Delete Postgres Database
• Web Application Installation
  • Opening the Nimbus Instance Firewall
  • Goal 1: IP as URL
  • Static files errors
  • Try a simple domain
  • Getting a ssl certificate
• Running Server
  • Checking for errors and inspecting logs
  • Starting the server
  • Restarting the server
  • Stopping the server
  • Installing updates
• Restarting Nimbus Instance

Developer Documentation:

• Web Application Software Layout
• How Events are input
• How Events are Handled
• Setting up the pre-push hook for tests
  • Install from requirements
  • Install pre-push hook
  • Test pre-push hook

TraceT Package:

• parse_xml Module
  • parsed_VOEvent Class
    • parsed_VOEvent
  • get_telescope Function
    • get_telescope()
  • get_event_type Function
    • get_event_type()
  • load_swift_source_database Function
    • load_swift_source_database()
  • get_source_types Function
    • get_source_types()
  • get_position_info Function
    • get_position_info()
• trigger_logic Module
  • worth_observing_grb Function
    • worth_observing_grb()
• triggerservice Module
  • web_api Function
    • web_api()
  • busy Function
    • busy()
  • vcsfree Function
    • vcsfree()
  • obslist Function
    • obslist()
  • trigger Function
    • trigger()
  • triggerbuffer Function
    • triggerbuffer()

Further Reading:

• Glossary of terms
• MWA Frequency Specifications
  • Example 1: A Contiguous Channel
  • Example 2: Picket Fence
  • Example 3: Two bands
  • Example 4: 12 Pairs of Contiguous Channels
• Event Telescope Notes
  • Fermi
  • SWIFT