rtm_wrapper.simulation#

Simulation sweep specification.

Sweeps systematically vary fields in Inputs tree. Typically, sweeps are used with an executor from execution to perform an RTM simulation for each input variation.

Module Contents#

Classes#

Inputs

Common input specification for RTM simulations.

SweepSimulation

Sweep specification over model inputs.

Attributes#

SweepScript

Dictionary description of a simulation sweep.
SweepScript: typing_extensions.TypeAlias#

Dictionary description of a simulation sweep.

class Inputs(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.Parameter

Common input specification for RTM simulations.

Warning

Temporary / unstable representation.

Parameters:

kwargs (Any) –

altitude_sensor: rtm_wrapper.parameters.ParameterField[Any]#

Sensor altitude description.

altitude_target: rtm_wrapper.parameters.ParameterField[Any]#

Target altitude description.

atmosphere: rtm_wrapper.parameters.ParameterField[Any]#

Atmosphere description.

aerosol_profile: rtm_wrapper.parameters.ParameterField[Any]#

Aerosol profile description.

geometry: rtm_wrapper.parameters.ParameterField[Any]#

Geometry description.

ground: rtm_wrapper.parameters.ParameterField[Any]#

Ground / background / target description.

wavelength: rtm_wrapper.parameters.ParameterField[Any]#

Spectrum description.

class SweepSimulation(script: SweepScript, base: Inputs)[source]#

Sweep specification over model inputs.

Warning

Temporary / unstable representation.

Parameters:

  • script (SweepScript) – Sweep description.

  • base (Inputs) – Base input tree whose fields will be overriden during the sweep according to the sweep script.