@datafire/amentum_space_atmosphere v3.0.0

@datafire/amentum_space_atmosphere

Client library for Atmosphere API - calculate composition and density of the atmosphere

Installation and Usage

npm install --save @datafire/amentum_space_atmosphere

let amentum_space_atmosphere = require('@datafire/amentum_space_atmosphere').create();

.then(data => {
  console.log(data);
});

Description

Instantly access empirical models of atmospheric density and composition that are recommended by the Committee on Space Research (COSPAR) for satellite drag calculations. NRLMSISE-00 is recommended for composition calculations and was developed by the US Naval Research Laboratory. JB2008 is a newer model and is recommended for density calculations at altitudes above 80 km. It was developed by Space Environment Technologies and the US Air Force Space Command. We provide access to both models via an easy-to-use web API. The API also automatically updates: - the indices needed by the JB2008 model to account for global density variations due to geomagnetic storms and EUV heating. - the Ap and F10.7 cm radio flux indices for the NRLMSISE00 model (unless provided by the user). The API is rate limited to 10,000 calls per month for non commercial use. Contact team@amentum.space if you have any questions or need to discuss commercial use and forecasting features. Help us improve the quality of our web APIs by completing our 2 minute survey here. Amentum Pty Ltd is not responsible nor liable for any loss or damage of any sort incurred as a result of using the API. Copyright Amentum Pty Ltd 2020.

Actions

app.api.endpoints.JB2008.sample_atmosphere

Computes Exospheric temperature above the input position (K) Temperature at the input position (K) Total mass density at the input position (kg/m3) Valid for altitudes in the interval 80, 40000 km

amentum_space_atmosphere.app.api.endpoints.JB2008.sample_atmosphere({
  "year": 0,
  "month": 0,
  "day": 0,
  "altitude": 0,
  "geodetic_latitude": 0,
  "geodetic_longitude": 0,
  "utc": 0
}, context)

Input

• input object
  • year required integer: Year in YYYY format
  • month required integer: Month in MM format
  • day required integer: Day in DD format
  • altitude required number: Altitude in (km)
  • geodetic_latitude required number: GeodeticLatitude (deg) -90 to 90 deg
  • geodetic_longitude required number: GeodeticLongitude (deg) 0 to 360 deg
  • utc required number: Coordinated Universal Time (hrs)

Output

• output object
  • at_alt_temp object
    • units string
    • value number
  • exospheric_temp object
    • units string
    • value number
  • total_mass_density object
    • units string
    • value number

app.api.endpoints.NRLMSISE00.sample_atmosphere

Computes Number densities (/m3) of He, O, N2, O2, Ar, H, N. Anomalous oxygen number density (/m3). Exospheric temperature (K). Temperature at altitude (K). Total mass density (kg/m3). Daily F10.7 cm radio flux (SFU) for previous day, obtained from the US National Oceanic and Atmospheric Administration if not specified by the user. 81 day average of F10.7 flux (SFU) centered on the specified date, obtained from the US National Oceanic and Atmospheric Administration if not specified by the user. Average of ap values in the 24 hours preceding, calculated from data provided by GFZ German Research Centre for Geosciences if not specified by the user.

Total mass density is the sum of the masses of the species in equilibrium at the thermospheric temperature T(z) and the mass density of the anomalous oxygen component. Valid for altitudes in the interval 0, 1000 km.

amentum_space_atmosphere.app.api.endpoints.NRLMSISE00.sample_atmosphere({
  "year": 0,
  "month": 0,
  "day": 0,
  "altitude": 0,
  "geodetic_latitude": 0,
  "geodetic_longitude": 0,
  "utc": 0
}, context)

Input

• input object
  • year required integer: Year in YYYY format
  • month required integer: Month in MM format
  • day required integer: Day in DD format
  • altitude required number: Altitude in (km)
  • geodetic_latitude required number: GeodeticLatitude (deg) -90 to 90 deg
  • geodetic_longitude required number: GeodeticLongitude (deg) 0 to 360 deg
  • utc required number: Coordinated Universal Time (hrs)
  • f107a number: (Optional) 81 day average of F10.7 flux (SFU) centered on the specified day. F107 and F107A values correspond to the 10.7 cm radio flux at the actual distance of Earth from Sun rather than radio flux at 1 AU. F107, F107A, AP effects can be neglected below 80 km. If unspecified, values provided by the US National Oceanic and Atmospheric Administration are retrieved automatically.
  • f107 number: (Optional) Daily F10.7 cm radio flux for previous day (SFU). F107 and F107A values correspond to the 10.7 cm radio flux at the actual distance of Earth from Sun rather than radio flux at 1 AU. F107, F107A, AP effects can be neglected below 80 km. If unspecified, values provided by the US National Oceanic and Atmospheric Administration are retrieved automatically.
  • ap number: (Optional) The Ap-index provides a daily average level for geomagnetic activity F107, F107A, AP effects can be neglected below 80 km. If unspecified, the average of values in the 24 hours preceding the date-time are automatically calculated from data provided by GFZ German Research Centre for Geosciences.

Output

• output object
  • Ar_density object
    • units string
    • value number
  • H_density object
    • units string
    • value number
  • He_density object
    • units string
    • value number
  • N2_density object
    • units string
    • value number
  • N_density object
    • units string
    • value number
  • O2_density object
    • units string
    • value number
  • O_density object
    • units string
    • value number
  • anomalous_O_density object
    • units string
    • value number
  • ap object
    • value number
  • at_alt_temp object
    • units string
    • value number
  • exospheric_temp object
    • units string
    • value number
  • f107 object
    • units string
    • value number
  • f107a object
    • units string
    • value number
  • total_mass_density object
    • units string
    • value number

Definitions

This integration has no definitions