sasktran2.constituent.Manual

sasktran2.constituent.Manual#

class sasktran2.constituent.Manual(extinction: ndarray, ssa: ndarray, legendre_moments: ndarray | None = None, delta_scale: bool = False)[source]#

Bases: Constituent

An implementation of a manual constituent where the user provides the extinction, single scattering albedo, and optionally the Legendre moments.

Note that this is manual in the sense that the user provides all necessary atmospheric quantities directly, on the model grid. No interpolation is done between levels, or between “wavelength” calculations.

The legendre_moments must also be provided with the same number of moments as the model, including the batching of spherical legendre moments if using multiple stokes parameters.

Parameters:

  • extinction (numpy.ndarray) – Extinction cross section in m^-1. Shape [num_altitudes, num_wavelengths]

  • ssa (numpy.ndarray) – Single scattering albedo (unitless). Shape [num_altitudes, num_wavelengths]

  • legendre_moments (numpy.ndarray | None, optional) – Legendre moments (unitless), by default None. Shape [num_moments, num_altitudes, num_wavelengths]

  • delta_scale (bool, optional) – Whether to apply delta-scaling to the scattering properties, by default False.

__init__(extinction: ndarray, ssa: ndarray, legendre_moments: ndarray | None = None, delta_scale: bool = False) → None[source]#

An implementation of a manual constituent where the user provides the extinction, single scattering albedo, and optionally the Legendre moments.

Note that this is manual in the sense that the user provides all necessary atmospheric quantities directly, on the model grid. No interpolation is done between levels, or between “wavelength” calculations.

The legendre_moments must also be provided with the same number of moments as the model, including the batching of spherical legendre moments if using multiple stokes parameters.

Parameters:

  • extinction (numpy.ndarray) – Extinction cross section in m^-1. Shape [num_altitudes, num_wavelengths]

  • ssa (numpy.ndarray) – Single scattering albedo (unitless). Shape [num_altitudes, num_wavelengths]

  • legendre_moments (numpy.ndarray | None, optional) – Legendre moments (unitless), by default None. Shape [num_moments, num_altitudes, num_wavelengths]

  • delta_scale (bool, optional) – Whether to apply delta-scaling to the scattering properties, by default False.

Methods

__init__(extinction, ssa[, ...])

An implementation of a manual constituent where the user provides the extinction, single scattering albedo, and optionally the Legendre moments.

add_to_atmosphere(atmo)

register_derivative(atmo, name)

Attributes

extinction

leg_coeff

ssa