vlf4ions.forecast_nowcast

Functions

plot_probas(probas, flux, path_to_results, ...)

Plots the flux estimation from the values of DP.

Classes

nowcast(stations, receiver, alerts[, ...])

Looks at the state of all received stations, and estimate the X-flux from the Sun.
vlf4ions.forecast_nowcast.plot_probas(probas, flux, path_to_results, today, stations_on)[source]

Plots the flux estimation from the values of DP. Returns the values above which there a 10%, 50% and 75% chance that the flux is.

Parameters:

  • probas – probability density function estimated from the station DP

  • flux – Defined internally, possible flux values (from 1e-6 to 1e-3 W/m^2)

  • path_to_results (string) – path to the place where the plot will be stored

  • today (datetime) – Date and time of the call to the function (defined internally)

  • stations_on (string) – Names of the stations which are transmitting in daytime

Returns:

flux above which there is a 10%, 50% or 75% chance of the flux value being

class vlf4ions.forecast_nowcast.nowcast(stations, receiver, alerts, reading_time=':00', ten=6.6e-06, fifty=2.2e-06, seventyfive=1.4e-06, debug=0)[source]

Bases: object

Looks at the state of all received stations, and estimate the X-flux from the Sun. If needed, sends alerts to specified recipients.

Parameters:

  • stations – List of station class instances

  • receiver – Receiver class instance

  • alerts – List of potential alerts to send. Each alert may have different sender, recipients or trigger.

  • reading_time – Second after the minute when the nowcast is done. It must not interfere with the times when the reading_time of each station. Default: ‘:00’.

  • ten – Flux value above which there is a ten percent probability for the flux estimation

  • fifty – Flux value above which there is a fifty percent probability for the flux estimation

  • seventyfive – Flux value above which there is a seventy five percent probability for the flux estimation

  • debug – If it is 1, show the values of DP for each station each time it is called. If it is 2, also show there flags

run(path_to_probas, path_to_results, path_to_CSVfiles)[source]

Compute flux estimate and electron density over each path and plots them

Parameters:

  • path_to_probas – path to the files where the mu/sigma values are stored for the probability computation

  • path_to_results – path where the plots will be stored

  • path_to_CSVfiles – path to the results from LMP