pyarts.arts

Interface directly to the C++ types via python

Classes

`AbsorptionLines`	Contains line-by-line absorption information for a number of related absorption lines
`AbsorptionSingleLine`	Single absorption line
`Agenda`	Describes a set of function calls and variable definitions
`AgRecord`	Internal agenda record - do not use manually
`AntennaType`	Members:
`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`
`ArrayOfAgRecord`	`list` of `AgRecord` - do not use manually
`ArrayOfArrayOfAbsorptionLines`	A list of `ArrayOfAbsorptionLines`
`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`
`ArrayOfArrayOfPropagationMatrix`	A list of `ArrayOfPropagationMatrix`
`ArrayOfArrayOfRadiationVector`	A list of `ArrayOfRadiationVector`
`ArrayOfArrayOfScatteringMetaData`	A list of `ArrayOfScatteringMetaData`
`ArrayOfArrayOfSingleScatteringData`	A list of `ArrayOfSingleScatteringData`
`ArrayOfArrayOfSpeciesTag`	A list of `ArrayOfSpeciesTag`
`ArrayOfArrayOfStokesVector`	A list of `ArrayOfStokesVector`
`ArrayOfArrayOfString`	A list of `ArrayOfString`
`ArrayOfArrayOfTensor3`	A list of `ArrayOfTensor3`
`ArrayOfArrayOfTensor6`	A list of `ArrayOfTensor6`
`ArrayOfArrayOfTime`	A list of `ArrayOfTime`
`ArrayOfArrayOfTransmissionMatrix`	A list of `ArrayOfTransmissionMatrix`
`ArrayOfArrayOfVector`	A list of `ArrayOfVector`
`ArrayOfCIARecord`	A list of `CIARecord`
`ArrayOfErrorCorrectedSuddenData`	List of `ErrorCorrectedSuddenData`
`ArrayOfGriddedField1`	A list of `GriddedField1`
`ArrayOfGriddedField2`	A list of `GriddedField2`
`ArrayOfGriddedField3`	A list of `GriddedField3`
`ArrayOfGriddedField4`	A list of `GriddedField4`
`ArrayOfGridPos`	List of `GridPos`
`ArrayOfIndex`	A list of `Index`
`ArrayOfIsotopeRecord`	A list of `IsotopeRecord`
`ArrayOfJacobianTarget`	A list of `JacobianTarget`
`ArrayOfLagrangeInterpolation`	List of `LagrangeInterpolation`
`ArrayOfMatrix`	A list of `Matrix`
`ArrayOfMdRecord`	`list` of `MdRecord` - do not use manually
`ArrayOfMRecord`	`list` of `MRecord` - do not use manually
`ArrayOfNumeric`	A list of `Numeric`
`ArrayOfPpath`	A list of `Ppath`
`ArrayOfPropagationMatrix`	A list of `PropagationMatrix`
`ArrayOfQuantumIdentifier`	A list of `QuantumIdentifier`
`ArrayOfRadiationVector`	A list of `RadiationVector`
`ArrayOfRetrievalQuantity`	A list of retrieval quantitities
`ArrayOfScatteringMetaData`	A list of `ScatteringMetaData`
`ArrayOfSingleScatteringData`	A list of `SingleScatteringData`
`ArrayOfSparse`	A list of `Sparse`
`ArrayOfSpecies`	List of `Species`
`ArrayOfSpeciesErrorCorrectedSuddenData`	List of `SpeciesErrorCorrectedSuddenData`
`ArrayOfSpeciesTag`	A list of species tags
`ArrayOfStokesVector`	A list of `StokesVector`
`ArrayOfString`	A list of `String`
`ArrayOfSun`	A list of sun
`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`
`ArrayOfTransmissionMatrix`	A list of `TransmissionMatrix`
`ArrayOfVector`	A list of `Vector`
`ArrayOfWsvRecord`	A list of `WsvRecord`
`ArrayOfXsecRecord`	A list of cross-section records
`Block`	A single block matrix
`BlockMatrixType`	Members:
`CallbackFunction`	Used to inject custom code into `Agenda`
`CIARecord`	Contains information to compute collision induced absorption for a pair of species
`clock_t`	The C++ standard clock type
`ComplexVector`	Holds complex vector data.
`CovarianceMatrix`	A covariance matrix
`EnergyLevelMap`	Maps data based on energy levels
`EnergyLevelMapType`	Type of energy level
`ErrorCorrectedSuddenData`	Data for the error corrected sudden method of line mixing
`GasAbsLookup`	An absorption lookup table
`GriddedField1`	A 1 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
`GridPos`	A position in a grid
`HitranRelaxationMatrixData`	Wraps data required to use Hitran line mixing
`Index`	A 64 bit signed integer type
`JacobianTarget`	A single target of a partial derivative computation
`LagrangeInterpolation`	Interpolation object
`LineShapeCalculator`	Class to compute the line shape
`LineShapeModel`	Multi-species line shape model
`LineShapeModelParameters`	A temperature model calculator
`LineShapeOutput`	Derived line shape parameters
`LineShapeSingleSpeciesModel`	Single species line shape model
`MapOfErrorCorrectedSuddenData`	A map of data required for computing the error-corrected-sudden relaxation matrix
`Matrix`	A 2 dimensional array of `Numeric`
`MCAntenna`	An antenna object used by `MCGeneral()`
`MdRecord`	Method record for the workspace - do not use manually
`MRecord`	Method record for `Agenda` - do not use manually
`Numeric`	IEEE 754 binary64 floating point number
`Ppath`	Describes a propagation path
`PredefinedModelData`	Contains any data required for a predefined model
`PropagationMatrix`	The propagation matrix data is help by this type
`PType`	Members:
`QuantumIdentifier`	An ID for an absorption species state
`QuantumNumberLocalState`	A local state of quantum numbers
`QuantumNumberValue`	A single quantum number with a value
`QuantumNumberValueList`	A list of unique `QuantumNumberValue`
`RadiationVector`	Contains the radiation vector as a function of frequency
`Range`	A range, used to select parts of a matpack type
`Rational`	Holds a rational number as two `Index` n / d
`RetrievalQuantity`	A retrieval quantity
`ScatteringMetaData`	Holds meta data about the scattering
`SingleScatteringData`	Holds single scattering data
`Sparse`	A sparse version of `Matrix`
`Species`
`SpeciesErrorCorrectedSuddenData`	Holds data required for a single species error corrected sudden method application
`SpeciesIsotopeRecord`	An isotopologue record entry
`SpeciesIsotopologueRatios`	Contains a list of isotopologue ratios for all defined species
`SpeciesTag`	The tag of a single absorption species
`SpectralRadianceProfileOperator`	An operator that turns a frequency and zenith angle into a spectral radiance profile
`StokesVector`	A stokes vector
`String`	Basic string type
`Sun`	A single sun.
`TelsemAtlas`	A telsem atlas
`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
`Timer`	Represents a clock
`TokVal`	Custom class holding any value in token form inside ARTS - do not use manually
`TransmissionMatrix`	Contains the transmission matrix as a function of frequency
`Vector`	A 1 dimensional array of `Numeric`
`Verbosity`	Controls the screen, agenda, and file verbosity level (i.e. the level of information printed).
`WorkspaceVariable`	A wrapper around all workspace groups
`WsvRecord`	A workspace variable record
`XsecRecord`	A cross-section record.
`ZeemanModel`	A Zeeman model
`ZeemanPolarization`	Options for ZeemanPolarization

Functions

igrf(z_field, lat_grid, lon_grid, t, ell)

Compute the magnetic field according to IGRF

pyarts.arts.constants

Contain copies of constants of Arts internals

Functions

`c`	Convert a string or number to a floating-point number, if possible.
`h`	Convert a string or number to a floating-point number, if possible.
`h_bar`	Convert a string or number to a floating-point number, if possible.
`k`	Convert a string or number to a floating-point number, if possible.
`pi`	Convert a string or number to a floating-point number, if possible.

pyarts.arts.convert

Contains several unit conversion functions used in Arts

These all should work with any array-like type

Functions

`freq2kaycm`(f)	Converts from Frequency [Hz] to Kayser [cm-1]
`freq2wavelen`(f)	Converts from Frequency [Hz] to Wavelenth [m]
`hz_per_msquared2kaycm_per_cmsquared`(s)	Converts from Spectral line intensity [Hz/m2] to CGS spectral line intensity [cm-1/cm-2]
`hz_per_pa2kaycm_per_atm`(lsm)	Converts from Line shape parameter [Hz/Pa] to CGS line shape parameter [cm-1/atm]
`joule2kaycm`(j)	Converts from Energy [J] to CGS Energy [cm-1]
`kaycm2freq`(v)	Converts from Kayser [cm-1] to Frequency [Hz]
`kaycm2joule`(v)	Converts from CGS Energy [cm-1] to Energy [J]
`kaycm_per_atm2hz_per_pa`(lsm_cgs)	Converts from CGS line shape parameter [cm-1/atm] to Line shape parameter [Hz/Pa]
`kaycm_per_cmsquared2hz_per_msquared`(s_cgs)	Converts from CGS spectral line intensity [cm-1/cm-2] to Spectral line intensity [Hz/m2]
`pa2torr`(pa)	Converts from Pressure [Pa] to Torr [Torr]
`torr2pa`(torr)	Converts from Torr [Torr] to Pressure [Pa]
`wavelen2freq`(wl)	Converts from Wavelenth [m] to Frequency [Hz]

pyarts.arts.docserver

Run the ARTS documentation server

Functions

run([port, baseurl, daemon])

Run the ARTS documentation server

pyarts.arts.globals

Classes

`ArrayOfGroupRecord`	`list` of `GroupRecord`
`GroupRecord`	Global workspace data golder - do not use manually
`parameters`	Access to static settings data

Functions

`get_agenda_data`()	Get a copy of the global data variable
`get_AgendaMap`()	Get a copy of the global data variable
`get_isotopologues`()	Get a list of the global isotopologues
`get_md_data`()	Get a copy of the global data variable
`get_md_data_raw`()	Get a copy of the global data variable
`get_MdMap`()	Get a copy of the global data variable
`get_MdRawMap`()	Get a copy of the global data variable
`get_wsv_data`()	Get a copy of the global data variable
`get_wsv_groups`()	Get a copy of the global data variable
`get_WsvGroupMap`()	Get a copy of the global data variable
`get_WsvMap`()	Get a copy of the global data variable
`omp_get_max_threads`()	Get maximum number of OpenMP threads
`omp_set_num_threads`([threads])	Sets the maximum number of OpenMP threads

pyarts.arts.hitran

Helpers to interface with HITRAN

Functions

`quantumidentity`(mol, iso)	Get the Arts quantum identifier of the HITRAN molecule
`ratio`(mol, iso)	Get the isotopologue ratio in HITRAN of HITRAN molecule

pyarts.arts.math

Contains select mathematics from Arts internal functions

Functions

`dwigner3j`(M, J1, J2, J)	Computes the Wigner 3J symbol using floating point approximation
`dwigner6j`(A, B, C, D, F)	Computes the Wigner 6J symbol using floating point approximation
`make_wigner_ready`([fastest, largest, ...])	Initialize a Wigner computation block for `wigner3j()` or `wigner6j()`
`wigner3j`(j1, j2, j3, m1, m2, m3)	Computes the Wigner 3J symbol
`wigner6j`(j1, j2, j3, l1, l2, l3)	Computes the Wigner 6J symbol

pyarts.arts.options

Various named options of Arts

Classes

`AbsorptionCutoffType`	Options for AbsorptionCutoffType
`AbsorptionMirroringType`	Options for AbsorptionMirroringType
`AbsorptionNormalizationType`	Options for AbsorptionNormalizationType
`AbsorptionPopulationType`	Options for AbsorptionPopulationType
`dobatch_calc_agendaDefaultOptions`	Options for dobatch_calc_agendaDefaultOptions
`doit_conv_test_agendaDefaultOptions`	Options for doit_conv_test_agendaDefaultOptions
`doit_mono_agendaDefaultOptions`	Options for doit_mono_agendaDefaultOptions
`doit_rte_agendaDefaultOptions`	Options for doit_rte_agendaDefaultOptions
`doit_scat_field_agendaDefaultOptions`	Options for doit_scat_field_agendaDefaultOptions
`forloop_agendaDefaultOptions`	Options for forloop_agendaDefaultOptions
`g0_agendaDefaultOptions`	Options for g0_agendaDefaultOptions
`gas_scattering_agendaDefaultOptions`	Options for gas_scattering_agendaDefaultOptions
`inversion_iterate_agendaDefaultOptions`	Options for inversion_iterate_agendaDefaultOptions
`iy_cloudbox_agendaDefaultOptions`	Options for iy_cloudbox_agendaDefaultOptions
`iy_independent_beam_approx_agendaDefaultOptions`	Options for iy_independent_beam_approx_agendaDefaultOptions
`iy_loop_freqs_agendaDefaultOptions`	Options for iy_loop_freqs_agendaDefaultOptions
`iy_main_agendaDefaultOptions`	Options for iy_main_agendaDefaultOptions
`iy_radar_agendaDefaultOptions`	Options for iy_radar_agendaDefaultOptions
`iy_space_agendaDefaultOptions`	Options for iy_space_agendaDefaultOptions
`iy_surface_agendaDefaultOptions`	Options for iy_surface_agendaDefaultOptions
`jacobian_agendaDefaultOptions`	Options for jacobian_agendaDefaultOptions
`JacobianAtm`	Options for JacobianAtm
`JacobianLine`	Options for JacobianLine
`JacobianSensor`	Options for JacobianSensor
`JacobianSpecial`	Options for JacobianSpecial
`JacobianType`	Options for JacobianType
`LineShapeTemperatureModel`	Options for LineShapeTemperatureModel
`LineShapeType`	Options for LineShapeType
`LineShapeVariable`	Options for LineShapeVariable
`main_agendaDefaultOptions`	Options for main_agendaDefaultOptions
`met_profile_calc_agendaDefaultOptions`	Options for met_profile_calc_agendaDefaultOptions
`pha_mat_spt_agendaDefaultOptions`	Options for pha_mat_spt_agendaDefaultOptions
`planetDefaultOptions`	Options for planetDefaultOptions
`ppath_agendaDefaultOptions`	Options for ppath_agendaDefaultOptions
`ppath_step_agendaDefaultOptions`	Options for ppath_step_agendaDefaultOptions
`PredefinedModelDataKey`	Options for PredefinedModelDataKey
`propmat_clearsky_agendaDefaultOptions`	Options for propmat_clearsky_agendaDefaultOptions
`QuantumNumberType`	Options for QuantumNumberType
`refr_index_air_agendaDefaultOptions`	Options for refr_index_air_agendaDefaultOptions
`sensor_response_agendaDefaultOptions`	Options for sensor_response_agendaDefaultOptions
`SpeciesTagType`	Options for SpeciesTagType
`spt_calc_agendaDefaultOptions`	Options for spt_calc_agendaDefaultOptions
`surface_rtprop_agendaDefaultOptions`	Options for surface_rtprop_agendaDefaultOptions
`test_agendaDefaultOptions`	Options for test_agendaDefaultOptions
`water_p_eq_agendaDefaultOptions`	Options for water_p_eq_agendaDefaultOptions
`ybatch_calc_agendaDefaultOptions`	Options for ybatch_calc_agendaDefaultOptions

pyarts.arts.physics

Contains simple physics functions in arts

Functions

number_density(*args, **kwargs)

Overloaded function.

pyarts.arts.predef

Contains predefined absorption models

Classes

MTCKD400WaterData

Water data representation for the MT CKD 4.0 model

Functions

`get_co2_ckdmt252`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 2.52
`get_foreign_h2o_ckdmt320`(f_grid, ...)	Computes foreign absorption using MT CKD version 3.20
`get_foreign_h2o_ckdmt350`(f_grid, ...)	Computes foreign absorption using MT CKD version 3.50
`get_foreign_h2o_ckdmt400`(f_grid, ...)	Computes foreign absorption using MT CKD Hitran version
`get_h2o_foreign_standard`(f_grid, ...)	Computes foreign water absorption using Rosenkranz standard
`get_h2o_mpm89`(f_grid, rtp_pressure, ...)	Computes water absorption using MPM89
`get_h2o_pwr2021`(f_grid, rtp_pressure, ...)	Computes water absorption using PWR2021
`get_h2o_pwr2022`(f_grid, rtp_pressure, ...)	Computes water absorption using PWR2022
`get_h2o_pwr98`(f_grid, rtp_pressure, ...)	Computes water absorption using PWR98
`get_h2o_self_standard`(f_grid, rtp_pressure, ...)	Computes self water absorption using Rosenkranz standard
`get_n2_fun_ckdmt252`(f_grid, rtp_pressure, ...)	Computes N2 fun absorption using MT CKD version 2.52
`get_n2_mpm93`(f_grid, rtp_pressure, ...[, x_h2o])	Computes nitrogen absorption using MPM93
`get_n2_pwr2021`(f_grid, rtp_pressure, ...[, ...])	Computes nitrogen absorption using PWR2021
`get_n2_rot_ckdmt252`(f_grid, rtp_pressure, ...)	Computes N2 rot absorption using MT CKD version 2.52
`get_n2_standard`(f_grid, rtp_pressure, ...)	Computes nitrogen absorption using Rosenkranz standard
`get_o2_cia_ckdmt100`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 3.50
`get_o2_mpm89`(f_grid, rtp_pressure, ...[, x_h2o])	Computes oxygen absorption using MPM89
`get_o2_pwr2021`(f_grid, rtp_pressure, ...[, ...])	Computes oxygen absorption using PWR2021
`get_o2_pwr2022`(f_grid, rtp_pressure, ...[, ...])	Computes oxygen absorption using PWR2022
`get_o2_pwr98`(f_grid, rtp_pressure, ...[, x_h2o])	Computes oxygen absorption using PWR98
`get_o2_standard`(f_grid, rtp_pressure, ...)	Computes oxygen absorption using Rosenkranz standard
`get_o2_tre05`(f_grid, rtp_pressure, ...[, x_h2o])	Computes oxygen absorption using TRE05
`get_o2_v0v0_ckdmt100`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 3.50
`get_o2_v1v0_ckdmt100`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 3.50
`get_o2_vis_ckdmt252`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 2.52
`get_self_h2o_ckdmt320`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 3.20
`get_self_h2o_ckdmt350`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD version 3.50
`get_self_h2o_ckdmt400`(f_grid, rtp_pressure, ...)	Computes self absorption using MT CKD Hitran version
`get_water_droplet_ell07`(f_grid, ...)	Computes water absorption using PWR98