pyarts.arts

Interface directly to the C++ types, functions and modules via python

Modules

`constants`	Contain copies of constants of Arts internals
`convert`	Contains several unit conversion functions used in Arts
`disort`	DISORT solver internal types
`file`	Contain methods to handle files available to ARTS via its path environment.
`globals`	Global settings and data
`hitran`	Helpers to interface with HITRAN
`interp`	Interpolation methods
`lbl`	Line-by-line helper functions
`math`	Contains select mathematics from Arts internal functions
`physics`	Contains simple physics functions in arts
`predef`	Contains predefined absorption models
`rtepack`	Interface to some of the core RTE functionality
`zeeman`	Zeeman effect calculations

Classes

`AbsorptionBand`	Contains all information about bands of related absorption lines
`AbsorptionBandSortingOption`	Group name: “AbsorptionBandSortingOption”
`AbsorptionBands`	A map of `QuantumIdentifier` to `AbsorptionBand`
`AbsorptionCutoffTypeOld`	Group name: “AbsorptionCutoffTypeOld”
`AbsorptionLine`	Data for an absorption line
`AbsorptionLines`	Contains line-by-line absorption information for a number of related absorption lines
`AbsorptionLookupTable`	A table of lookup calculations.
`AbsorptionLookupTables`	A map of tables of of lookup calculations.
`AbsorptionMirroringTypeOld`	Group name: “AbsorptionMirroringTypeOld”
`AbsorptionNormalizationTypeOld`	Group name: “AbsorptionNormalizationTypeOld”
`AbsorptionPopulationTypeOld`	Group name: “AbsorptionPopulationTypeOld”
`AbsorptionSingleLine`	Single absorption line
`AbsorptionVectorDataGriddedARO1`
`AbsorptionVectorDataGriddedARO2`
`AbsorptionVectorDataGriddedARO3`
`AbsorptionVectorDataGriddedARO4`
`AbsorptionVectorDataGriddedTRO1`
`AbsorptionVectorDataGriddedTRO2`
`AbsorptionVectorDataGriddedTRO3`
`AbsorptionVectorDataGriddedTRO4`
`AbsorptionVectorDataSpectralARO1`
`AbsorptionVectorDataSpectralARO2`
`AbsorptionVectorDataSpectralARO3`
`AbsorptionVectorDataSpectralARO4`
`AbsorptionVectorDataSpectralTRO1`
`AbsorptionVectorDataSpectralTRO2`
`AbsorptionVectorDataSpectralTRO3`
`AbsorptionVectorDataSpectralTRO4`
`Agenda`	Describes a set of function calls and variable definitions
`Any`	Meta type for when methods can take any argument (avoid manual use)
`ArrayOfAbsorptionLines`	A list of `AbsorptionLines`
`ArrayOfAbsorptionSingleLine`	List of `AbsorptionSingleLine`
`ArrayOfAgenda`	A list of `Agenda`
`ArrayOfArrayOfAbsorptionLines`	A list of `ArrayOfAbsorptionLines`
`ArrayOfArrayOfArrayOfPropagationPathPoint`	A list of `ArrayOfArrayOfPropagationPathPoint`.
`ArrayOfArrayOfGriddedField1`	A list of `ArrayOfGriddedField1`
`ArrayOfArrayOfGriddedField2`	A list of `ArrayOfGriddedField2`
`ArrayOfArrayOfGriddedField3`	A list of `ArrayOfGriddedField3`
`ArrayOfArrayOfIndex`	A list of `ArrayOfIndex`
`ArrayOfArrayOfMatrix`	A list of `ArrayOfMatrix`
`ArrayOfArrayOfMuelmatMatrix`	A list of `ArrayOfMuelmatMatrix`.
`ArrayOfArrayOfMuelmatVector`	A list of `ArrayOfMuelmatVector`.
`ArrayOfArrayOfPropagationPathPoint`	A list of `ArrayOfPropagationPathPoint`.
`ArrayOfArrayOfPropmatMatrix`	A list of `ArrayOfPropmatMatrix`.
`ArrayOfArrayOfPropmatVector`	A list of `ArrayOfPropmatVector`.
`ArrayOfArrayOfScatteringMetaData`	A list of `ArrayOfScatteringMetaData`
`ArrayOfArrayOfSingleScatteringData`	A list of `ArrayOfSingleScatteringData`
`ArrayOfArrayOfSpeciesTag`	A list of `ArrayOfSpeciesTag`
`ArrayOfArrayOfStokvecMatrix`	A list of `ArrayOfStokvecMatrix`.
`ArrayOfArrayOfStokvecVector`	A list of `ArrayOfStokvecVector`.
`ArrayOfArrayOfString`	A list of `ArrayOfString`
`ArrayOfArrayOfTensor3`	A list of `ArrayOfTensor3`
`ArrayOfArrayOfTensor6`	A list of `ArrayOfTensor6`
`ArrayOfArrayOfTime`	A list of `ArrayOfTime`
`ArrayOfArrayOfVector`	A list of `ArrayOfVector`
`ArrayOfAscendingGrid`	A list of `AscendingGrid`.
`ArrayOfAtmPoint`	A list of `AtmPoint`
`ArrayOfAtmTargets`	List of atmospheric targets
`ArrayOfCIARecord`	A list of `CIARecord`
`ArrayOfGriddedField1`	A list of `GriddedField1`
`ArrayOfGriddedField1Named`	A list of `GriddedField1Named`
`ArrayOfGriddedField2`	A list of `GriddedField2`
`ArrayOfGriddedField3`	A list of `GriddedField3`
`ArrayOfGriddedField4`	A list of `GriddedField4`
`ArrayOfIndex`	A list of `Index`
`ArrayOfLineTarget`	List of line targets
`ArrayOfMatrix`	A list of `Matrix`
`ArrayOfMuelmat`	A list of `Muelmat`
`ArrayOfMuelmatMatrix`	A list of `MuelmatMatrix`.
`ArrayOfMuelmatTensor3`	A list of `MuelmatTensor3`.
`ArrayOfMuelmatVector`	A list of `MuelmatVector`.
`ArrayOfNamedGriddedField2`	A list of `NamedGriddedField2`
`ArrayOfNumeric`	A list of `Numeric`
`ArrayOfPropagationPathPoint`	A list of `PropagationPathPoint`.
`ArrayOfPropmat`	A list of `Propmat`
`ArrayOfPropmatMatrix`	A list of `PropmatMatrix`.
`ArrayOfPropmatVector`	A list of `PropmatVector`.
`ArrayOfQuantumIdentifier`	A list of `QuantumIdentifier`
`ArrayOfScatteringMetaData`	A list of `ScatteringMetaData`
`ArrayOfScatteringSpecies`	Represents species of scattering paritlces in the atmosphere.
`ArrayOfSensorObsel`	List of `SensorObsel`.
`ArrayOfSensorPosLosVector`
`ArrayOfSingleScatteringData`	A list of `SingleScatteringData`
`ArrayOfSparse`	A list of `Sparse`
`ArrayOfSpeciesEnum`	A list of `SpeciesEnum`
`ArrayOfSpeciesIsotope`	List of `SpeciesIsotope`.
`ArrayOfSpeciesTag`	A list of `SpeciesTag`
`ArrayOfStokvec`	A list of `Stokvec`
`ArrayOfStokvecMatrix`	A list of `StokvecMatrix`.
`ArrayOfStokvecTensor3`	A list of `StokvecTensor3`.
`ArrayOfStokvecVector`	A list of `StokvecVector`.
`ArrayOfString`	A list of `String`
`ArrayOfSun`	A list of `Sun`
`ArrayOfSurfaceTarget`	List of surface targets
`ArrayOfTelsemAtlas`	A list of `TelsemAtlas`
`ArrayOfTensor3`	A list of `Tensor3`
`ArrayOfTensor4`	A list of `Tensor4`
`ArrayOfTensor5`	A list of `Tensor5`
`ArrayOfTensor6`	A list of `Tensor6`
`ArrayOfTensor7`	A list of `Tensor7`
`ArrayOfTime`	A list of `Time`
`ArrayOfVector`	A list of `Vector`
`ArrayOfVector2`	A list of `Vector2`
`ArrayOfVector3`	A list of `Vector3`
`ArrayOfXsecRecord`	A list of cross-section records
`AscendingGrid`	A sorted grid of always ascending values.
`AtmData`	An atmospheric point
`AtmField`	An atmospheric field
`AtmKey`	Group name: “AtmKey”
`AtmPoint`	An atmospheric point
`AtmTarget`	Atmospheric target
`Block`	A single block matrix
`BlockMatrix`	A block matrix for the covariance matrix
`BulkScatteringPropertiesAROGridded1`
`BulkScatteringPropertiesAROGridded2`
`BulkScatteringPropertiesAROGridded3`
`BulkScatteringPropertiesAROGridded4`
`BulkScatteringPropertiesAROSpectral1`
`BulkScatteringPropertiesAROSpectral2`
`BulkScatteringPropertiesAROSpectral3`
`BulkScatteringPropertiesAROSpectral4`
`CIARecord`	Contains information to compute collision induced absorption for a pair of species
`CallbackOperator`	Used to inject custom code into `Agenda`
`ComplexGriddedField2`	A 2 dimensional gridded set of complex data
`ComplexMatrix`	A complex matrix
`ComplexTensor3`	A complex tensor3
`ComplexTensor4`
`ComplexVector`	A complex vector
`CovarianceMatrix`	A covariance matrix
`CxxWorkspace`	The core ARTS Workspace
`DescendingGrid`	A sorted grid of always Descending values.
`DisortBDRF`	A bidirectional reflectance function
`DisortBDRFOperator`	A BDRF operator for DISORT
`DisortSettings`	The settings required to run Disort.
`DoubleGaussGrid`
`EarthEllipsoid`	Group name: “EarthEllipsoid”
`EuropaEllipsoid`	Group name: “EuropaEllipsoid”
`ExtinctionMatrixDataGriddedARO1`
`ExtinctionMatrixDataGriddedARO2`
`ExtinctionMatrixDataGriddedARO3`
`ExtinctionMatrixDataGriddedARO4`
`ExtinctionMatrixDataGriddedTRO1`
`ExtinctionMatrixDataGriddedTRO2`
`ExtinctionMatrixDataGriddedTRO3`
`ExtinctionMatrixDataGriddedTRO4`
`ExtinctionMatrixDataSpectralARO1`
`ExtinctionMatrixDataSpectralARO2`
`ExtinctionMatrixDataSpectralARO3`
`ExtinctionMatrixDataSpectralARO4`
`ExtinctionMatrixDataSpectralTRO1`
`ExtinctionMatrixDataSpectralTRO2`
`ExtinctionMatrixDataSpectralTRO3`
`ExtinctionMatrixDataSpectralTRO4`
`FejerGrid`
`FieldComponent`	Group name: “FieldComponent”
`FileType`	Group name: “FileType”
`GanymedeEllipsoid`	Group name: “GanymedeEllipsoid”
`GasAbsLookup`	An absorption lookup table
`GaussLegendreGrid`
`GridType`	Group name: “GridType”
`GriddedField1`	A 1 dimensional gridded set of `Numeric` data
`GriddedField1Named`	A 3 dimensional gridded set of `Numeric` data
`GriddedField2`	A 2 dimensional gridded set of `Numeric` data
`GriddedField3`	A 3 dimensional gridded set of `Numeric` data
`GriddedField4`	A 4 dimensional gridded set of `Numeric` data
`GriddedField5`	A 5 dimensional gridded set of `Numeric` data
`GriddedField6`	A 6 dimensional gridded set of `Numeric` data
`HenyeyGreensteinScatterer`
`HitranLineStrengthOption`	Group name: “HitranLineStrengthOption”
`HitranType`	Group name: “HitranType”
`HydrostaticPressureOption`	Group name: “HydrostaticPressureOption”
`Index`	A 64 bit signed integer type
`IndexVector`	A vector of indices
`InterpolationExtrapolation`	Group name: “InterpolationExtrapolation”
`IoEllipsoid`	Group name: “IoEllipsoid”
`IrregularZenithAngleGrid`
`IsoRatioOption`	Group name: “IsoRatioOption”
`JacobianTargetType`	A type of target for use in Jacobian Matrix calculations
`JacobianTargets`	A list of targets for use in Jacobian Matrix calculations
`JacobianTargetsDiagonalCovarianceMatrixMap`	A map target types to matrix and inverse matrix pairs of `BlockMatrix`
`JupiterEllipsoid`	Group name: “JupiterEllipsoid”
`LineByLineCutoffType`	Group name: “LineByLineCutoffType”
`LineByLineLineshape`	Group name: “LineByLineLineshape”
`LineByLineVariable`	Group name: “LineByLineVariable”
`LineList`	A list of absorption lines
`LineShapeModel`	Multi-species line shape model
`LineShapeModelCoefficient`	Group name: “LineShapeModelCoefficient”
`LineShapeModelFIXMENAMEODR`	Line shape model
`LineShapeModelList`	A list of line shape models
`LineShapeModelParameters`	A temperature model calculator
`LineShapeModelType`	Group name: “LineShapeModelType”
`LineShapeModelVariable`	Group name: “LineShapeModelVariable”
`LineShapeOutput`	Derived line shape parameters
`LineShapeSingleSpeciesModel`	Single species line shape model
`LineShapeSpeciesModel`	Line shape model for a species
`LineShapeTemperatureModelOld`	Group name: “LineShapeTemperatureModelOld”
`LineShapeTypeOld`	Group name: “LineShapeTypeOld”
`LineShapeVariableOld`	Group name: “LineShapeVariableOld”
`LineShapeVariableTemperatureModelList`	A list of line shape models with temperature coefficients
`LineTarget`	Line target
`LinemixingEcsData`	A map of line mixing data
`LobattoGrid`
`MCAntenna`	An antenna object used by `MCGeneral`
`MGDSingleMoment`
`MarsEllipsoid`	Group name: “MarsEllipsoid”
`Matrix`	A 2 dimensional array of `Numeric`
`MatrixOfDisortBDRF`	A 2 dimensional array of `DisortBDRF`
`Method`	The method class of ARTS
`MissingFieldComponentError`	Group name: “MissingFieldComponentError”
`MoonEllipsoid`	Group name: “MoonEllipsoid”
`Muelmat`	A single Mueller 4x4 matrix.
`MuelmatMatrix`	A matrix of `Muelmat`.
`MuelmatTensor3`	A `Tensor3` of `Muelmat`.
`MuelmatVector`	A vector of `Muelmat`.
`NamedGriddedField2`	A 3 dimensional gridded set of `Numeric` data
`NamedGriddedField3`	A 4 dimensional gridded set of `Numeric` data
`Numeric`	IEEE 754 binary64 floating point number
`NumericBinaryOperator`	A simple functional type.
`NumericTernaryOperator`	A simple functional type.
`NumericUnaryOperator`	A simple functional type.
`PairOfBlockMatrix`	A pair of `BlockMatrix` objects
`ParticleHabit`
`ParticleProperties`
`ParticulateProperty`	Group name: “ParticulateProperty”
`PartitionFunctionsType`	Group name: “PartitionFunctionsType”
`PathPositionType`	Group name: “PathPositionType”
`PhaseMatrixDataTROGridded1`
`PhaseMatrixDataTROGridded2`
`PhaseMatrixDataTROGridded3`
`PhaseMatrixDataTROGridded4`
`PhaseMatrixDataTROSpectral1`
`PhaseMatrixDataTROSpectral2`
`PhaseMatrixDataTROSpectral3`
`PhaseMatrixDataTROSpectral4`
`PlanetOrMoonType`	Group name: “PlanetOrMoonType”
`PolarizationChoice`	Group name: “PolarizationChoice”
`PredefinedModelData`	Contains any data required for a predefined model
`PropagationPathPoint`	A simple path-point of a propagation path
`Propmat`	A single propagation matrix.
`PropmatMatrix`	A matrix of `Propmat`.
`PropmatVector`	A vector of `Propmat`.
`QuantumIdentifier`	An ID for an absorption species state
`QuantumNumberLocalState`	A local state of quantum numbers
`QuantumNumberType`	Group name: “QuantumNumberType”
`QuantumNumberValue`	A single quantum number with a value
`QuantumNumberValueList`	A list of unique `QuantumNumberValue`
`Range`	A range, used to select parts of a matpack type
`Rational`	Holds a rational number as two `Index` n / d
`ScatteringHabit`
`ScatteringMetaData`	Holds meta data about the scattering
`ScatteringSpeciesProperty`	Meta data for scattering spefcies.
`SensorJacobianModelType`	Group name: “SensorJacobianModelType”
`SensorKeyType`	Group name: “SensorKeyType”
`SensorObsel`	A single observation element.
`SensorPosLos`	A position and line-of-sight of a sensor.
`SensorPosLosVector`	Vector of `SensorPosLos`.
`SingleScatteringData`	Holds single scattering data
`SingleScatteringDataAROGridded1`
`SingleScatteringDataAROSpectral1`
`SingleScatteringDataTROGridded1`
`SingleScatteringDataTROGridded2`
`SingleScatteringDataTROGridded3`
`SingleScatteringDataTROGridded4`
`SingleScatteringDataTROSpectral1`
`SingleScatteringDataTROSpectral2`
`SingleScatteringDataTROSpectral3`
`SingleScatteringDataTROSpectral4`
`Sparse`	A sparse version of `Matrix`
`SpeciesEnum`	Group name: “SpeciesEnum”
`SpeciesEnumVectors`	A map of `SpeciesEnum` to `Vector`
`SpeciesIsotope`	Contains descriptions about an isotope.
`SpeciesIsotopologueRatios`	Isotopologue ratios for a species
`SpeciesTag`	A tagged absorption species
`SpeciesTagType`	Group name: “SpeciesTagType”
`SpectralRadianceOperator`	An operator for getting the `spectral_radiance`
`SpectralRadianceUnitType`	Group name: “SpectralRadianceUnitType”
`Stokvec`	A single Stokes vector (of length 4).
`StokvecGriddedField6`	A 6-dimensional gridof `Stokvec`.
`StokvecMatrix`	A matrix of `Stokvec`.
`StokvecTensor3`	A `Tensor3` but of `Stokvec`.
`StokvecTensor4`	A `Tensor4` but of `Stokvec`.
`StokvecTensor5`	A `Tensor5` but of `Stokvec`.
`StokvecTensor6`	A `Tensor6` but of `Stokvec`.
`StokvecVector`	A vector of `Stokvec`.
`String`	Basic string type
`Sun`	A single sun.
`SurfData`	Surface data
`SurfaceField`	A surface field that keeps relevant surface parameters
`SurfaceKey`	Group name: “SurfaceKey”
`SurfacePoint`	A surface point.
`SurfacePropertyTag`	A surface property
`SurfaceTarget`	Surface target
`SurfaceTypeTag`	A surface type
`TelsemAtlas`	A telsem atlas
`TemperatureModel`	Temperature model
`Tensor3`	A 3 dimensional array of `Numeric`
`Tensor4`	A 4 dimensional array of `Numeric`
`Tensor5`	A 5 dimensional array of `Numeric`
`Tensor6`	A 6 dimensional array of `Numeric`
`Tensor7`	A 7 dimensional array of `Numeric`
`TessemNN`	Data required by TESSEM to calculate surface emissivity
`Time`	Represents a time stamp
`TimeStepType`	Group name: “TimeStepType”
`Vector`	A 1 dimensional array of `Numeric`
`Vector2`	A fixed-size 2D version of `Vector`.
`Vector3`	A fixed-size 3D version of `Vector`.
`VenusEllipsoid`	Group name: “VenusEllipsoid”
`VibrationalEnergyLevels`	A map of vibrational energy levels for NLTE calculations
`WorkspaceVariable`	A workspace variable
`XsecRecord`	A single cross-section record
`ZeemanLineModel`	Zeeman model
`ZeemanModel`	A Zeeman model
`ZeemanPolarization`	Options for ZeemanPolarization
`ZenithAngleGrid`
`cppdisort`	A DISORT object
`disort_settings_agendaPredefined`	Group name: “disort_settings_agendaPredefined”
`propagation_matrix_agendaPredefined`	Group name: “propagation_matrix_agendaPredefined”
`propagation_matrix_scattering_agendaPredefined`	Group name: “propagation_matrix_scattering_agendaPredefined”
`ray_path_observer_agendaPredefined`	Group name: “ray_path_observer_agendaPredefined”
`spectral_radiance_observer_agendaPredefined`	Group name: “spectral_radiance_observer_agendaPredefined”
`spectral_radiance_space_agendaPredefined`	Group name: “spectral_radiance_space_agendaPredefined”
`spectral_radiance_surface_agendaPredefined`	Group name: “spectral_radiance_surface_agendaPredefined”

Functions

`frequency_shift()`	Get the frequency-shifted frequency grid at a point in the atmosphere.
`igrf()`	Compute the magnetic field according to IGRF
`stringify_keys()`	Overloaded function.