vlf4ions documentation

This project contains the functions and procedures necessary to detect solar flares in real-time with an AWESOME antenna. It also contains useful functions to analyse the data in post-processing.

Note

This project is under active development

Contents

First steps

• Installation
  • Required files
  • Installation
• Quickstart
  • Defining the receiver
  • Defining the transmitter
  • Paths
  • Defining email alerts
  • Nowcast
  • Updating df values
  • Main script
  • Results
• Main objects
  • Receiver
  • Station
  • Alerts
  • Nowcast
  • Diagram

Reading the data

• Reading files
• Amplitude calibration
• Phase correction
  • Correcting the phase with the polarisation parameters
  • Method to correct the phase
• Flagging the data
  • Antenna shutdown
  • Transmitter off
  • Nighttime
  • Phase not well demodulated

Flare detection

• Breakpoints detection
  • Incremental algorithm
  • Time resolution and \(\delta\)
• Breakpoint analysis
  • Detection threshold

Ionosphere estimates

• Estimating solar X-ray flux
  • Before using the code
  • Computation of DP
  • Probability combination
  • Prior
  • Results
    • Results in post-processing:
    • Results in real-time:
• Estimating the electron density
  • Background
  • Use of the LMP model
  • Finding the correct \(h'\) and \(\beta\)
• Plotting the results

Additional information

• Bibliography
• Modules and functions
  • vlf4ions
    • vlf4ions.analyse_change_points
      • analyse_breakpoint()
    • vlf4ions.class_definition
      • receiver
      • email_alerts
        • email_alerts.update_detection_body()
        • email_alerts.get_path_to_fluxestimate()
        • email_alerts.craft_newsletter()
        • email_alerts.send_email()
      • station
        • station.update_df()
        • station.update_breakpoints()
        • station.get_pdf_coeff()
        • station.compute_DA_DP()
    • vlf4ions.compute_electron_density
      • get_quiet_hb()
      • LMP_findminimum()
      • compute_Ne()
    • vlf4ions.correct_phase
      • correctionphase()
      • unwrap_moco()
      • correctionphaseparDw()
      • compute_df()
    • vlf4ions.detect_change_points
      • find_break_point_realtime()
      • detect_change_points()
    • vlf4ions.flag
      • flags()
    • vlf4ions.forecast_nowcast
      • plot_probas()
      • nowcast
        • nowcast.run()
    • vlf4ions.manage_statefile
      • get_lastbreakpoint()
      • write_newbreakpoint()
      • write_fluxestimate()
      • write_file_with_df()
    • vlf4ions.plot_map
      • plot_map()
    • vlf4ions.polarisation
      • EllipseParams()
    • vlf4ions.read_files
      • read_Narrowband_postprocessing()
      • read_Narrowband_real_time()
    • vlf4ions.sunrise_sunset
      • get_sza()
      • get_sunrise_sunset()
      • check_if_daytime()
      • is_daytime()
• Troubleshooting
  • Limits on the flux estimation
  • High breakpoint slopes, but DP is zero
  • There were no breakpoint detected for more than two hours
  • A flare occured just before midnight

Add your content using reStructuredText syntax. See the reStructuredText documentation for details.