pyarts3.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
`path`	Submodule for path-related functionality
`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`	What kind of sorting should the bands be sorted by?
`AbsorptionBands`	A map of `QuantumIdentifier` to `AbsorptionBand`
`AbsorptionLine`	A single absorption line
`AbsorptionLookupTable`	A table of lookup calculations.
`AbsorptionLookupTables`	A map of `SpeciesEnum` to `AbsorptionLookupTable`.
`AbsorptionVectorDataGriddedARO4`	Absorption vector data
`AbsorptionVectorDataGriddedTRO4`	Absorption vector data
`AbsorptionVectorDataSpectralARO4`	Absorption vector data
`AbsorptionVectorDataSpectralTRO4`	Absorption vector data
`Agenda`	Describes a set of function calls and variable definitions
`Any`	Meta type for any workspace group (see Workspace Groups)
`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`.
`ArrayOfAtmData`	A list of `AtmData`
`ArrayOfAtmPoint`	A list of `AtmPoint`
`ArrayOfAtmTargets`	List of atmospheric targets
`ArrayOfCIARecord`	A list of `CIARecord`
`ArrayOfErrorTarget`	List of error targets
`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`
`ArrayOfQuantumLevelIdentifier`	A list of `QuantumLevelIdentifier`
`ArrayOfScatteringMetaData`	A list of `ScatteringMetaData`
`ArrayOfScatteringSpecies`	Represents species of scattering paritlces in the atmosphere.
`ArrayOfSensorObsel`	List of `SensorObsel`.
`ArrayOfSensorPosLosVector`	Array of SensorPosLosVector
`ArrayOfSensorTarget`	List of sensor targets
`ArrayOfSingleScatteringData`	A list of `SingleScatteringData`
`ArrayOfSparse`	A list of `Sparse`
`ArrayOfSpeciesEnum`	A list of `SpeciesEnum`
`ArrayOfSpeciesIsotope`	List of `SpeciesIsotope`.
`ArrayOfSpeciesTag`	A list of `SpeciesTag`
`ArrayOfSpecmat`	A list of `Specmat`
`ArrayOfSpecmatMatrix`	A list of `SpecmatMatrix`.
`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`
`ArrayOfSubsurfacePoint`	A list of `SubsurfacePoint`
`ArrayOfSun`	A list of `Sun`
`ArrayOfSurfacePoint`	Array of SurfacePoint
`ArrayOfSurfaceTarget`	List of surface targets
`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 `XsecRecord`
`AscendingGrid`	A sorted `Vector` of always ascending values.
`AtmData`	An atmospheric data field.
`AtmField`	An atmospheric field.
`AtmKey`	A key to identify an atmospheric property.
`AtmPoint`	An atmospheric point.
`AzimuthGrid`	A 1-dimensional vector of `Numeric` that are guaranteed to be within the range [0, 360).
`BinnedPSD`	Binned PSD returning a fixed particle concentration defined over a sequence of size bins with particle number zeros outside of size bins and temperature range.
`Block`	A single block matrix
`BlockMatrix`	The data for a single `Block`, likely part of a `CovarianceMatrix`.
`BulkScatteringPropertiesTROGridded4`	Bulk scattering properties
`BulkScatteringPropertiesTROSpectral4`	Bulk scattering properties
`CIARecord`	Contains information to compute collision induced absorption (CIA) 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`	A complex tensor4
`ComplexVector`	A complex vector
`CovarianceMatrix`	A covariance matrix is a square matrix that describes the covariance of some property.
`CxxWorkspace`	The core ARTS Workspace
`DescendingGrid`	A sorted `Vector` of always descending values.
`DisortBDRF`	A bidirectional reflectance function
`DisortBDRFOperator`	A BDRF operator for DISORT
`DisortFlux`	The flux result variable for Disort.
`DisortRadiance`	The radiance result variable for Disort.
`DisortSettings`	The settings required to run Disort.
`DoubleGaussGrid`	Double Gaussian grid
`EarthEllipsoid`	Choice of ellipsoid.
`ErrorKey`	Error key
`EuropaEllipsoid`	Choice of ellipsoid.
`ExtSSACallback`	A callback to get [extinction, ssa] from a single scattering albedo and extinction field.
`ExtinctionMatrixDataGriddedARO4`	Extinction matrix data
`ExtinctionMatrixDataGriddedTRO4`	Extinction matrix data
`ExtinctionMatrixDataSpectralARO4`	Extinction matrix data
`ExtinctionMatrixDataSpectralTRO4`	Extinction matrix data
`FejerGrid`	Fejer grid
`FieldComponent`	Selection of a field component
`FileType`	A choice of file format types.
`GanymedeEllipsoid`	Choice of ellipsoid.
`GaussLegendreGrid`	Gaussian Legendre grid
`GeodeticField2`	A 2-dimensional gridof `Numeric`.
`GeodeticField3`	A 3-dimensional gridof `Numeric`.
`GridType`	Type of Lagrange interpolation weights.
`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
`GriddedSpectralField6`	A 6-dimensional gridof `Stokvec`.
`HenyeyGreensteinScatterer`	Henyey-Greenstein scatterer
`HitranLineStrengthOption`	The way line strength is computed in ARTS when reading Hitran data.
`HydrostaticPressureOption`	These options control how the hydrostatic pressure is computed in ARTS.
`Index`	A 64 bit signed integer type
`IndexVector`	A vector of indices
`InterpolationExtrapolation`	Instructions about how to handle extrapolation of interpolated data.
`IoEllipsoid`	Choice of ellipsoid.
`IrregularZenithAngleGrid`	Irregular zenith angle grid
`IsoRatioOption`	The type of isotopologue ratio to use.
`JacobianAtmTarget`	Atmospheric target
`JacobianErrorTarget`	Error target
`JacobianLineTarget`	Line target
`JacobianSensorTarget`	Sensor target
`JacobianSurfaceTarget`	Surface target
`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`	Choice of ellipsoid.
`LatGrid`	A 1-dimensional vector of `Numeric` that are guaranteed to be within the range [-90, 90].
`LineByLineCutoffType`	A type of line by line cutoff.
`LineByLineLineshape`	A type of line shape for line by line calculations.
`LineByLineVariable`	A type of line by line variable.
`LineList`	A list of `AbsorptionLine`
`LineShapeModel`	Line shape model
`LineShapeModelCoefficient`	The type of line shape model coefficients. See `LineShapeModelType` for more information.
`LineShapeModelList`	A list of line shape models
`LineShapeModelType`	The type of line shape model to use.
`LineShapeModelVariable`	The type of line shape model variable.
`LineShapeSpeciesModel`	Line shape model for a species
`LineShapeVariableTemperatureModelList`	A list of line shape models with temperature coefficients
`LinemixingEcsData`	A map from `SpeciesIsotope` to `LinemixingSpeciesEcsData`
`LinemixingSingleEcsData`	Data for single species ECS.
`LinemixingSpeciesEcsData`	A map from `SpeciesEnum` to `LinemixingSingleEcsData`
`LobattoGrid`	Lobatto grid
`LonGrid`	A 1-dimensional vector of `Numeric` that are guaranteed to be within the range [-180, 180).
`MGDSingleMoment`	Modified gamma PSD single moment
`MarsEllipsoid`	Choice of ellipsoid.
`Matrix`	A 2 dimensional array of `Numeric`
`MatrixOfDisortBDRF`	A 2 dimensional array of `DisortBDRF`
`Method`	The method class of ARTS
`MissingFieldComponentError`	What kind of error is it to miss a field component?
`MoonEllipsoid`	Choice of ellipsoid.
`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`	Particle habit
`ParticleProperties`	Particle properties
`ParticulateProperty`	Numerical properties used to numerically represent particle populations.
`PartitionFunctionsData`	Data for partition functions, used in the line-by-line model
`PartitionFunctionsType`	Type of partition function data.
`PathPositionType`	A type of position in a path.
`PhaseMatrixDataTROGridded4`	Phase matrix data
`PhaseMatrixDataTROSpectral4`	Phase matrix data
`PlanetOrMoonType`	The type of planetary body that should be considered.
`PolarizationChoice`	Named polarization states to help create relevant `Stokvec`.
`PredefinedModelData`	A map of `SpeciesIsotope` to `PredefinedModelDataVariant`
`PredefinedModelDataVariant`	One of the following:
`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
`QuantumIdentifierGriddedField1Map`	A map from `QuantumIdentifier` to `GriddedField1`.
`QuantumIdentifierNumericMap`	A map from `QuantumIdentifier` to `Numeric`.
`QuantumIdentifierVectorMap`	A map from `QuantumIdentifier` to `Vector`.
`QuantumLevel`	A map of level quantum number data
`QuantumLevelIdentifier`	An ID for an absorption species state
`QuantumNumberType`	The type of value for a quantum number.
`QuantumState`	A map of two-levels quantum number data
`QuantumUpperLower`	Upper and lower quantum number values
`QuantumValue`	A single quantum number value
`Range`	A range, used to select parts of a matpack type
`Rational`	Holds a rational number as two `Index` n / d
`ScatteringGeneralSpectralTRO`	Scattering general spectral TRO
`ScatteringGeneralSpectralTROFunc`	A callback to get the bulk scattering properties of a species.
`ScatteringHabit`	A scattering habit combines a particle habit with a PSD so that it can be used as a scattering species.
`ScatteringMetaData`	Holds meta data about the scattering
`ScatteringSpeciesProperty`	Meta data for scattering spefcies.
`ScatteringTroSpectralVector`	Scattering TRO spectral vector
`SensorJacobianModelType`	How to model the sensor Jacobian model target.
`SensorKeyType`	A key for identifying a sensor property
`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`	Single scattering data
`SingleScatteringDataAROSpectral1`	Single scattering data
`SingleScatteringDataTROGridded4`	Single scattering data
`SingleScatteringDataTROSpectral4`	Single scattering data
`SizeParameter`	Parameters used to represent the size of particles.
`SortedGriddedField1`	A 1-dimensional gridof `Numeric`.
`SortedGriddedField2`	A 2-dimensional gridof `Numeric`.
`SortedGriddedField3`	A 3-dimensional gridof `Numeric`.
`SortedGriddedField4`	A 4-dimensional gridof `Numeric`.
`SortedGriddedField5`	A 5-dimensional gridof `Numeric`.
`SortedGriddedField6`	A 6-dimensional gridof `Numeric`.
`Sparse`	A sparse version of `Matrix`
`SpeciesEnum`	The valid species for the ARTS system.
`SpeciesEnumVectors`	A map of `SpeciesEnum` to `Vector`
`SpeciesIsotope`	Contains name and data about an isotope.
`SpeciesIsotopologueRatios`	Isotopologue ratios for a species
`SpeciesTag`	A tagged absorption species
`SpeciesTagType`	Type of species tag.
`Specmat`	A single Complex Mueller 4x4 matrix.
`SpecmatMatrix`	A matrix of `Muelmat`.
`SpecmatTensor3`	A 3-tensor of `Specmat`
`SpecmatVector`	A vector of `Specmat`
`SpectralRadianceOperator`	An operator for getting the `spectral_radiance`
`SpectralRadianceTransformOperator`	Transformation of `spectral_radiance` and `spectral_radiance_jacobian`
`SpectralRadianceUnitType`	Choice of spectral radiance unit in conversions.
`Stokvec`	A single Stokes vector (of length 4).
`StokvecMatrix`	A matrix of `Stokvec`.
`StokvecSortedGriddedField1`	A 1-dimensional grid of `Stokvec`.
`StokvecSortedGriddedField2`	A 2-dimensional grid of `Stokvec`.
`StokvecSortedGriddedField3`	A 3-dimensional grid of `Stokvec`.
`StokvecSortedGriddedField4`	A 4-dimensional grid of `Stokvec`.
`StokvecSortedGriddedField5`	A 5-dimensional grid of `Stokvec`.
`StokvecSortedGriddedField6`	A 6-dimensional gridof `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`.
`StridedRange`	A strided range, used to select parts of a matpack type
`String`	Basic string type
`SubsurfaceField`	A sub-surface field.
`SubsurfaceKey`	A key to identify a subsurface property.
`SubsurfacePoint`	A surface point.
`Sun`	A single sun.
`SurfaceData`	Surface data
`SurfaceField`	A surface field.
`SurfaceKey`	A key to identify a surface property.
`SurfacePoint`	A surface point.
`SurfacePropertyTag`	A surface property.
`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`
`Time`	Represents a time stamp
`TimeStepType`	Time step for the integration. Is often accompanied by a value.
`Vector`	A 1 dimensional array of `Numeric`
`Vector2`	A fixed-size 2D version of `Vector`.
`Vector3`	A fixed-size 3D version of `Vector`.
`VenusEllipsoid`	Choice of ellipsoid.
`Wsv`	A workspace variable wrapper - no manual use required
`XsecRecord`	A single cross-section record
`ZeemanLineModel`	Zeeman model
`ZenithGrid`	A 1-dimensional vector of `Numeric` that are guaranteed to be within the range [0, 180].
`ZenithGriddedField1`	A 1-dimensional gridof `Numeric`.
`cppdisort`	A DISORT object
`disort_settings_agendaOperator`	This is the operator for free customization of the agenda: `disort_settings_agenda`.
`disort_settings_agenda_setup_layer_emission_type`	For atmospheric emission settings with `disort_settings_agendaSetup()`.
`disort_settings_agenda_setup_scattering_type`	For atmospheric scattering settings with `disort_settings_agendaSetup()`.
`disort_settings_agenda_setup_space_type`	For space boundary settings with `disort_settings_agendaSetup()`.
`disort_settings_agenda_setup_sun_type`	For direct radiation settings with `disort_settings_agendaSetup()`.
`disort_settings_agenda_setup_surface_type`	For surface boundary settings with `disort_settings_agendaSetup()`.
`inversion_iterate_agendaOperator`	This is the operator for free customization of the agenda: `inversion_iterate_agenda`.
`measurement_inversion_agendaOperator`	This is the operator for free customization of the agenda: `measurement_inversion_agenda`.
`propagation_matrix_agendaOperator`	This is the operator for free customization of the agenda: `propagation_matrix_agenda`.
`propagation_matrix_scattering_agendaOperator`	This is the operator for free customization of the agenda: `propagation_matrix_scattering_agenda`.
`propagation_matrix_scattering_spectral_agendaOperator`	This is the operator for free customization of the agenda: `propagation_matrix_scattering_spectral_agenda`.
`ray_path_observer_agendaOperator`	This is the operator for free customization of the agenda: `ray_path_observer_agenda`.
`ray_path_observer_agendaSetGeometricMaxStep`	For use with `ray_path_observer_agendaSetGeometric()`. Determines how to densify the geometric path.
`spectral_radiance_observer_agendaOperator`	This is the operator for free customization of the agenda: `spectral_radiance_observer_agenda`.
`spectral_radiance_space_agendaOperator`	This is the operator for free customization of the agenda: `spectral_radiance_space_agenda`.
`spectral_radiance_surface_agendaOperator`	This is the operator for free customization of the agenda: `spectral_radiance_surface_agenda`.

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.