joseki.profiles.ussa_1976

Module to compute the U.S. Standard Atmosphere 1976.

The U.S. Standard Atmosphere 1976 is a Earth atmosphere thermophysical model described in the technical report [NOAA+1976](bibliography.md#NOAA+1976).

Submodules

Attributes

factory

logger

schema

Classes

Profile

Abstract class for atmosphere thermophysical profiles.

USSA1976

Class to compute the U.S. Standard Atmosphere 1976.

Functions

compute([z, variables])

Compute U.S. Standard Atmosphere 1976 data set on specified altitude grid.

history()

to_quantity(value[, units])

Convert to a pint.Quantity.

Package Contents

class joseki.profiles.ussa_1976.Profile[source]

Bases: abc.ABC

Abstract class for atmosphere thermophysical profiles.

abstract to_dataset(z=None, interp_method=None, conserve_column=False, **kwargs)[source]

Return the profile as a dataset.

Parameters:

  • z (Optional[pint.Quantity]) – Altitude grid. If the profile can be evaluated at arbitrary altitudes, this parameter is passed to the evaluating method for that profile. If the profile is defined on a fixed altitude grid, this parameter is used to interpolate the profile on the specified altitude grid.

  • interp_method (Optional[Mapping[str, str]]) – Interpolation method for each variable. If None, the default interpolation method is used. Interpolation may be required if the profile is defined on a fixed altitude grid, and the altitude grid is not the same as the one used to define the profile. Interpolation may also not be required, e.g. if the profile is defined by analytical function(s) of the altitude variable.

  • conserve_column (bool) – If True, ensure that column densities are conserved during interpolation.

  • kwargs (Any) – Parameters passed to lower-level methods.

Returns:

Atmospheric profile.

Return type:

xarray.Dataset

class joseki.profiles.ussa_1976.USSA1976[source]

Bases: joseki.profiles.core.Profile

Class to compute the U.S. Standard Atmosphere 1976.

The U.S. Standard Atmosphere 1976 is a Earth atmosphere thermophysical model described in the technical report [NNU76].

to_dataset(z=None, interp_method=None, conserve_column=False, **kwargs)[source]

Return the profile as a dataset.

Parameters:

  • z (Optional[pint.Quantity]) – Altitude grid. If the profile can be evaluated at arbitrary altitudes, this parameter is passed to the evaluating method for that profile. If the profile is defined on a fixed altitude grid, this parameter is used to interpolate the profile on the specified altitude grid.

  • interp_method (Optional[Mapping[str, str]]) – Interpolation method for each variable. If None, the default interpolation method is used. Interpolation may be required if the profile is defined on a fixed altitude grid, and the altitude grid is not the same as the one used to define the profile. Interpolation may also not be required, e.g. if the profile is defined by analytical function(s) of the altitude variable.

  • conserve_column (bool) – If True, ensure that column densities are conserved during interpolation.

  • kwargs (Any) – Parameters passed to lower-level methods.

Returns:

Atmospheric profile.

Return type:

xarray.Dataset

joseki.profiles.ussa_1976.compute(z=DEFAULT_Z, variables=None)[source]

Compute U.S. Standard Atmosphere 1976 data set on specified altitude grid.

Parameters:

  • z (array) – Altitude [m].

  • variables (list, optional) – Names of the variables to compute.

Returns:

Data set holding the values of the different atmospheric variables.

Return type:

Dataset

Raises:

ValueError – When altitude is out of bounds, or when variables are invalid.

joseki.profiles.ussa_1976.history()[source]
Return type:

str

joseki.profiles.ussa_1976.to_quantity(value, units=None)[source]

Convert to a pint.Quantity.

Parameters:

  • value (pint.Quantity | dict | int | float | list | numpy.ndarray | xarray.DataArray) – Value which will be converted. If value is an ArrayLike, it is assumed to be dimensionless (unless units is set). If a DataArray is passed and units_error is True, it is assumed to have a units key in its attrs field; otherwise, it is assumed to be dimensionless.

  • units (None | str) – Units to assign. If None, the units are inferred from the value argument.

Returns:

The corresponding quantity.

Return type:

pint.Quantity

Notes

This function can also be used on DataArray and Dataset coordinate variables.

joseki.profiles.ussa_1976.factory
joseki.profiles.ussa_1976.logger
joseki.profiles.ussa_1976.schema