joseki.profiles

Atmosphere thermophysical profiles.

Submodules

Attributes

factory

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.

MIPASMidlatitudeDay

MIPAS midlatitude day reference atmosphere.

MIPASMidlatitudeNight

MIPAS Midlatitude night reference atmosphere.

MIPASPolarSummer

MIPAS Polar summer reference atmosphere.

MIPASPolarWinter

MIPAS Polar winter reference atmosphere.

MIPASTropical

MIPAS Tropical reference atmosphere.

USSA1976

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

Package Contents

class joseki.profiles.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.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.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.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.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.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.MIPASMidlatitudeDay[source]

Bases: joseki.profiles.core.Profile

MIPAS midlatitude day reference atmosphere.

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.MIPASMidlatitudeNight[source]

Bases: joseki.profiles.core.Profile

MIPAS Midlatitude night reference atmosphere.

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.MIPASPolarSummer[source]

Bases: joseki.profiles.core.Profile

MIPAS Polar summer reference atmosphere.

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.MIPASPolarWinter[source]

Bases: joseki.profiles.core.Profile

MIPAS Polar winter reference atmosphere.

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.MIPASTropical[source]

Bases: joseki.profiles.core.Profile

MIPAS Tropical reference atmosphere.

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.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.factory