sasktran2.climatology.atomic_oxygen

Contents

sasktran2.climatology.atomic_oxygen#

Functions

number_density(altitudes_m, time, ...[, ...])

Return atomic oxygen number density on an altitude grid.

sasktran2.climatology.atomic_oxygen.number_density(altitudes_m: ArrayLike, time: datetime | date | datetime64 | float, latitude_degrees: float, lower_fill_value: float | None = 0.0, upper_fill_value: float | None = None) ndarray[source]#

Return atomic oxygen number density on an altitude grid.

Parameters:
  • altitudes_m (array-like) – Altitudes in metres. Values must be within 40 km to 130 km.

  • time (datetime, date, np.datetime64, or float) – Time used for interpolation. Numeric values are interpreted as fractional month numbers, where 1 is January and 12 is December. Values between month integers are linearly interpolated, with December wrapping to January.

  • latitude_degrees (float) – Geographic latitude in degrees. Values must be within -80 to 80 degrees.

  • lower_fill_value (float or None, optional) – Number density in m^-3 to use below 40 km. If None, the 40 km value is used. The default is 0.

  • upper_fill_value (float or None, optional) – Number density in m^-3 to use above 130 km. If None, the 130 km value is used. The default is None.

Returns:

Atomic oxygen number density in m^-3, with the same shape as altitudes_m.

Return type:

np.ndarray