Auroral Transport Model (ATM)

Perform forward ATM calculation

Perform a forward calculation using VERSION 1 of the TREx Auroral Transport Model and the supplied input parameters.

Input notes:

  • timestamp
    • timestamp is expected to be in UTC, and is valid for any value up to the end of the previous day
    • the 'Z' character at the end of the timestamp is optional, and will be ignored if it is supplied
  • latitude and longitude are to be in geodetic coordinates (-90 to 90 lat, -180 to 180 lon)
  • maxwellian_characteristic_energy must be specified if the maxwellian_energy_flux is not 0
  • gaussian_peak_energy must be specified if the gaussian_energy_flux is not 0
  • gaussian_spectral_width must be specified if the gaussian_energy_flux is not 0
  • valid values for nrlmsis_model_version are '00' and '2.0'
  • The ATM model is 1D and time-independent. However, the optional parameters timescale_auroral and timescale_transport provide limited support for time-dependent and transport process.
    • timescale_auroral (T0) is the duration of the precipitation; default value is 600 sec
    • timescale_transport is defined by L/v0, in which L is the dimension of the auroral structure, and v0 is the cross-structure drift speed. Default value is 600 sec.
    • the model quasi-analytically solves the continuity equation under a square input (with time duration T0 and spatial width L) input of precipitation. The initial/boundary conditions are given by IRI. The output yields the mean density/VER over [0-L] at time T0.
  • units
    • timescale parameters: seconds
    • maxwellian energy flux: erg/cm2/s
    • maxwellian characteristic energy: eV
    • gaussian energy flux: erg/cm2/s
    • gaussian peak energy: eV
    • gaussian spectral width: eV
  • custom spectrum
    • energy in eV, flux in 1/cm2/s/eV
    • energy and flux arrays must be the same length
  • by default requests are cached; use the 'no_cache' parameter to disable this functionality

Output notes:

  • output parameter of the request are toggles the enable/disable each field's inclusion in the response
  • all output parameters are false by default
  • altitude is in kilometers
  • emission data: 1-D array -- volume emission rate (1/cm^3/s)
  • plasma electron density: 1-D array -- density (cm^-3)
  • plasma O2+ density: 1-D array -- density (cm^-3)
  • plasma NO+ density: 1-D array -- density (cm^-3)
  • plasma O+ density: 1-D array -- density (cm^-3)
  • plasma ionisation rate: 1-D array -- ionisation rate (1/cm^3/s)
  • plasma electron temperature: 1-D array -- temperature (K)
  • plasma ion temperature: 1-D array -- temperature (K)
  • plasma peterson conductivity: 1-D array -- conductivity (S/m)
  • plasma hall conductivity: 1-D array -- conductivity (S/m)
  • neutral O2 density: 1-D array -- density (cm^-3)
  • neutral O density: 1-D array -- density (cm^-3)
  • neutral N2 density: 1-D array -- density (cm^-3)
  • neutral N density: 1-D array -- density (cm^-3)
  • neutral temperature: 1-D array -- temperature (K)
post/api/v1/atm/forward

Request

Request body

atm_model_version'1.0'
timestampstring date-time required
geodetic_latitudenumber required
geodetic_longitudenumber required
maxwellian_energy_fluxnumber
gaussian_energy_fluxnumber
maxwellian_characteristic_energynumber
gaussian_peak_energynumber
gaussian_spectral_widthnumber
nrlmsis_model_version'00' | '2.0'
oxygen_correction_factornumber
timescale_auroralinteger
timescale_transportinteger
no_cacheboolean

Response

Calculated outputs

calculation_duration_msnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.