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

What kind of sorting should the bands be sorted by?

AbsorptionBands

A map of QuantumIdentifier to AbsorptionBand

AbsorptionLine

Data for an absorption line

AbsorptionLookupTable

A table of lookup calculations.

AbsorptionLookupTables

A map of tables of of lookup calculations.

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 when methods can take any argument (avoid manual use)

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

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

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 line 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

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

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 cross-section records

AscendingGrid

A sorted grid of always ascending values.

AtmData

An atmospheric point

AtmField

An atmospheric field

AtmKey

A key to identify an atmospheric property.

AtmPoint

An atmospheric point

AtmTarget

Atmospheric target

Block

A single block matrix

BlockMatrix

A block matrix for the covariance matrix

BulkScatteringPropertiesTROGridded4

Bulk scattering properties

BulkScatteringPropertiesTROSpectral4

Bulk scattering properties

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

A complex tensor4

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

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

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

HenyeyGreensteinScatterer

Henyey-Greenstein scatterer

HitranLineStrengthOption

The way line strength is computed in ARTS when reading Hitran data.

HydrostaticPressureOption

What kind of error is it to miss a field component?

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.

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.

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 absorption lines

LineShapeModelCoefficient

The type of line shape model coefficients. See LineShapeModelType for more information.

LineShapeModelFIXMENAMEODR

Line shape model

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

LineTarget

Line target

LinemixingEcsData

A map of line mixing data

LobattoGrid

Lobatto grid

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.

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

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

The type of value for a quantum number.

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

ScatteringGeneralSpectralTRO

Scattering general spectral TRO

ScatteringGeneralSpectralTROFunc

A callback to get the bulk scattering properties of a species.

ScatteringHabit

Scattering habit

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.

SensorTarget

Error target

SingleScatteringData

Holds single scattering data

SingleScatteringDataAROGridded1

Single scattering data

SingleScatteringDataAROSpectral1

Single scattering data

SingleScatteringDataTROGridded4

Single scattering data

SingleScatteringDataTROSpectral4

Single scattering data

Sparse

A sparse version of Matrix

SpeciesEnum

The valid species for the ARTS system.

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

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

SpectralRadianceUnitType

Choice of spectral radiance unit in conversions.

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.

StridedRange

A strided range, used to select parts of a matpack type

String

Basic string type

Sun

A single sun.

SurfaceData

Surface data

SurfaceField

A surface field that keeps relevant surface parameters

SurfaceKey

A key to identify a surface property.

SurfacePoint

A surface point.

SurfacePropertyTag

A surface property

SurfaceTarget

Surface target

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

ZenithAngleGrid

Zenith angle grid

cppdisort

A DISORT object

disort_settings_agendaOperator

An agenda for setting up Disort.

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

Work in progress …

propagation_matrix_agendaOperator

Compute the propagation matrix, the non-LTE source vector, and their derivatives

propagation_matrix_scattering_agendaOperator

Compute the propagation matrix, the non-LTE source vector, and their derivatives

propagation_matrix_scattering_spectral_agendaOperator

Get the scattering propagation matrix, the scattering absorption vector, and the scattering spectral phase matrix

ray_path_observer_agendaOperator

Get the propagation path as it is obeserved.

spectral_radiance_observer_agendaOperator

Spectral radiance as seen from the input position and environment

spectral_radiance_space_agendaOperator

Spectral radiance as seen of space.

spectral_radiance_surface_agendaOperator

Spectral radiance as seen of the surface.

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.