sasktran2.optical.HITRANAbsorber

sasktran2.optical.HITRANAbsorber#

class sasktran2.optical.HITRANAbsorber(molecule: str, line_fn='voigt', **kwargs)[source]#

Bases: OpticalProperty

Absorption cross sections calculated using discrete absorption lines from the HITRAN database and broadened using the internal SASKTRAN2 Voigt line shape function.

Notes:

The HITRAN database is not included with SASKTRAN2 and must be downloaded separately. The hitran-api package is required.

Broadening is calculated “online” rather than using pre-computed tables. This is slower but allows for more flexibility in the calculation.

Derivatives with respect to pressure/temperature are currently not supported

Parameters:

  • molecule (str) – HITRAN Molecule identifier, e.g. “CO2”, “H2O”, “O3”, “CH4”

  • line_fn (str) – Line shape function to use, currently only “voigt” is supported

  • kwargs (dict) – Additional keyword arguments to pass to the line broadening function

__init__(molecule: str, line_fn='voigt', **kwargs)[source]#

Absorption cross sections calculated using discrete absorption lines from the HITRAN database and broadened using the internal SASKTRAN2 Voigt line shape function.

Notes:

The HITRAN database is not included with SASKTRAN2 and must be downloaded separately. The hitran-api package is required.

Broadening is calculated “online” rather than using pre-computed tables. This is slower but allows for more flexibility in the calculation.

Derivatives with respect to pressure/temperature are currently not supported

Parameters:

  • molecule (str) – HITRAN Molecule identifier, e.g. “CO2”, “H2O”, “O3”, “CH4”

  • line_fn (str) – Line shape function to use, currently only “voigt” is supported

  • kwargs (dict) – Additional keyword arguments to pass to the line broadening function

Methods

__init__(molecule[, line_fn])

Absorption cross sections calculated using discrete absorption lines from the HITRAN database and broadened using the internal SASKTRAN2 Voigt line shape function.

atmosphere_quantities(atmo, **kwargs)

cross_section_derivatives(wavelengths_nm, ...)

cross_sections(wavelengths_nm, altitudes_m, ...)

optical_derivatives(atmo, **kwargs)