joseki.profiles.afgl_1986¶

AFGL 1986 atmosphere’s thermophysical profiles.

The profiles are generated from data files stored in joseki/data/afgl_1986. These data files correspond to tables 1a-f and 2a-d of the technical report [ACC+86].

Attributes¶

`DATA_FILES`
`INSTITUTION`
`REFERENCE`
`SOURCE`
`TABLE_2_DATA_FILES`
`URL`
`URLDATE`
`logger`

Classes¶

`AFGL1986MidlatitudeSummer`	AFGL 1986 midlatitude summer atmosphere thermophysical profile.
`AFGL1986MidlatitudeWinter`	AFGL 1986 midlatitude winter atmosphere thermophysical profile.
`AFGL1986SubarcticSummer`	AFGL 1986 subarctic summer atmosphere thermophysical profile.
`AFGL1986SubarcticWinter`	AFGL 1986 subarctic winter atmosphere thermophysical profile.
`AFGL1986Tropical`	AFGL 1986 tropical atmosphere thermophysical profile.
`AFGL1986USStandard`	AFGL 1986 US Standard atmosphere thermophysical profile.
`Identifier`	AFGL 1986 atmospheric profile identifier enumeration.

Functions¶

`dataframe_to_dataset`(df, identifier[, ...])	Convert the output of the parse method to a xarray.Dataset.
`get_dataset`(identifier[, additional_molecules])	Read data files for a given atmospheric profile.
`parse`(identifier)	Parse table data files for a given atmospheric profile.
`to_dataset`(identifier[, z, interp_method, conserve_column])	Helper Profile.to_dataset() method.

Module Contents¶

class joseki.profiles.afgl_1986.AFGL1986MidlatitudeSummer[source]¶

Bases: joseki.profiles.core.Profile

AFGL 1986 midlatitude summer atmosphere thermophysical profile.

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.afgl_1986.AFGL1986MidlatitudeWinter[source]¶

Bases: joseki.profiles.core.Profile

AFGL 1986 midlatitude winter atmosphere thermophysical profile.

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.afgl_1986.AFGL1986SubarcticSummer[source]¶

Bases: joseki.profiles.core.Profile

AFGL 1986 subarctic summer atmosphere thermophysical profile.

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.afgl_1986.AFGL1986SubarcticWinter[source]¶

Bases: joseki.profiles.core.Profile

AFGL 1986 subarctic winter atmosphere thermophysical profile.

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.afgl_1986.AFGL1986Tropical[source]¶

Bases: joseki.profiles.core.Profile

AFGL 1986 tropical atmosphere thermophysical profile.

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.afgl_1986.AFGL1986USStandard[source]¶

Bases: joseki.profiles.core.Profile

AFGL 1986 US Standard atmosphere thermophysical profile.

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.afgl_1986.Identifier(*args, **kwds)[source]¶

Bases: enum.Enum

AFGL 1986 atmospheric profile identifier enumeration.

MIDLATITUDE_SUMMER = 'midlatitude_summer'¶

MIDLATITUDE_WINTER = 'midlatitude_winter'¶

SUBARCTIC_SUMMER = 'subarctic_summer'¶

SUBARCTIC_WINTER = 'subarctic_winter'¶

TROPICAL = 'tropical'¶

US_STANDARD = 'us_standard'¶

joseki.profiles.afgl_1986.dataframe_to_dataset(df, identifier, additional_molecules=True)[source]¶

Convert the output of the parse method to a xarray.Dataset.

Parameters:

df (pandas.DataFrame) – Atmospheric profile data.
identifier (Identifier) – Atmospheric profile identifier.
additional_molecules (bool) – If True, include molecules 8-28 as numbered in [Anderson+1986](bibliography.md#Anderson+1986). Else, discard molecules 8-28.

Returns:

Atmospheric profile dataset.

Return type:

xarray.Dataset

Notes

Use the z column of the output pandas.DataFrame of read_raw_data as data coordinate and all other columns as data variables. All data variables and coordinates of the returned xarray.Dataset are associated metadata (standard name, long name and units). Raw data units are documented in the technical report AFGL Atmospheric Constituent Profiles (0-120 km), Anderson et al., 1986 [Anderson+1986](bibliography.md#Anderson+1986). dataset attributes are added.

joseki.profiles.afgl_1986.get_dataset(identifier, additional_molecules=True)[source]¶

Read data files for a given atmospheric profile.

Parameters:

identifier (Identifier) – Atmospheric profile identifier. See [Identifier](reference.md#src.joseki.profiles.afgl_1986.Identifier) for possible values.
additional_molecules (bool) – If True, include molecules 8-28 as numbered in [Anderson+1986](bibliography.md#Anderson+1986). Else, discard molecules 8-28.

Returns:

Atmospheric profile dataset.

Return type:

xarray.Dataset

Notes

Chain calls to [parse](reference.md#src.joseki.profiles.afgl_1986.parse) and [dataframe_to_dataset](reference.md#src.joseki.profiles.afgl_1986.dataframe_to_dataset).

joseki.profiles.afgl_1986.parse(identifier)[source]¶

Parse table data files for a given atmospheric profile.

Parameters:: identifier (Identifier) – Atmospheric profile identifier.
Returns:: Atmospheric profile dataset.
Return type:: pandas.DataFrame

Notes

Read the relevant raw data files corresponding to the atmospheric profile. These raw data files correspond to tables 1 and 2 from the technical report [AFGL Atmospheric Constituent Profiles (0-120 km), Anderson et al., 1986](bibliography.md#Anderson+1986). Each atmospheric profile has 5 tables, i.e. 5 raw data files, associated to it. Only the first of these tables is specific to each atmospheric profile. All 5 raw data files are read into pandas.DataFrame objects and then concatenated after dropping the duplicate columns.

joseki.profiles.afgl_1986.to_dataset(identifier, z=None, interp_method=None, conserve_column=False, **kwargs)[source]¶

Helper Profile.to_dataset() method.

Parameters:

identifier (Identifier) – AFGL 1986 atmosphere thermophysical profile identifier. See [Identifier](reference.md#src.joseki.profiles.afgl_1986.Identifier) for possible values.
z (Optional[pint.Quantity]) – New level altitudes. If None, return the original dataset Else, interpolate the dataset to the new level altitudes. Default is None.
interp_method (Mapping[str, str]) – Interpolation method for each data variable. Default is None.
conserve_column (bool) – If True, ensure that column densities are conserved during interpolation.
kwargs (Any) – Additional arguments passed to [get_dataset](reference.md#src.joseki.profiles.afgl_1986.get_dataset).

Returns:

Atmosphere thermophysical profile dataset.

Return type:

xarray.Dataset

joseki.profiles.afgl_1986.DATA_FILES¶

joseki.profiles.afgl_1986.INSTITUTION = 'Air Force Geophysics Laboratory'¶

joseki.profiles.afgl_1986.REFERENCE = 'Anderson, G.P. and Chetwynd J.H. and Clough S.A. and Shettle E.P. and Kneizys F.X., AFGL...¶

joseki.profiles.afgl_1986.SOURCE = 'Atmospheric model (U.S. Standard Atmosphere) adapted from satellite data and/or...¶

joseki.profiles.afgl_1986.TABLE_2_DATA_FILES = ('table_2a.csv', 'table_2b.csv', 'table_2c.csv', 'table_2d.csv')¶

joseki.profiles.afgl_1986.URL = 'https://archive.org/details/DTIC_ADA175173'¶

joseki.profiles.afgl_1986.URLDATE = '2022-12-12'¶

joseki.profiles.afgl_1986.logger¶