AtmPoint
- class pyarts.arts.AtmPoint(*args, **kwargs)
An atmospheric point
Workspace variables of type AtmPoint
Overview
Method
Returns a flat list of values.
Method
Get the isotopologue ratio
Method
Available keys
Method
Get the NLTE value
Method
Returns an atmospheric point without isotopologue ratios.
Method
Get the number density [1 / m 3] of a species or of a species isotopologue.
Method
Read variable from file
Method
Saves variable to file
Method
Set the isotopologue ratio
Method
Set the NLTE value
Method
Set the VMR of the species
Method
Get the VMR of the species
Method
Convert an atmospheric point to a dictionary.
Method
Update the atmospheric point with dictionary values.
Static Method
Create an atmospheric point from a dictionary.
Static Method
Create variable from file
Attribute
Magnetic field [T]
Attribute
Pressure [Pa]
Attribute
Temperature [K]
Attribute
Wind field [m/s]
Operator
Return self==value.
Operator
Return self>=value.
Operator
__getitem__(self, arg: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, /) -> float
Operator
__getstate__(self) -> tuple[list[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty], pyarts.arts.ArrayOfNumeric]
Operator
Return self>value.
Operator
Return hash(self).
Operator
Return self<=value.
Operator
Return self<value.
Operator
Return self!=value.
Operator
__setitem__(self, arg0: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, arg1: float, /) -> None
Operator
__setstate__(self, arg: tuple[collections.abc.Sequence[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty], pyarts.arts.ArrayOfNumeric], /) -> None
Constructors
- __init__(self) None
- __init__(self, arg: pyarts.arts.AtmPoint) None
Methods
- flat_values(self) pyarts.arts.Vector
Returns a flat list of values.
- isotopologue_ratio(self, isot: pyarts.arts.SpeciesIsotope) float
Get the isotopologue ratio
- keys(self, keep_basic: bool = True, keep_specs: bool = True, keep_isots: bool = False, keep_nlte: bool = False, keep_ssprops: bool = True) list[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty]
Available keys
- nlte_value(self, qid: pyarts.arts.QuantumIdentifier) float
Get the NLTE value
- no_isotopologues(self) pyarts.arts.AtmPoint
Returns an atmospheric point without isotopologue ratios.
- number_density(self, spec: pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope) float
Get the number density [1 / m 3] of a species or of a species isotopologue.
The number density is computed as:
\[n_d = \frac{xp}{kT}\]where \(x\) is the VMR of the species if
spec
is aSpeciesEnum
(in code:self[spec]
) or the VMR of the species isotopolgue ifspec
is aSpeciesIsotope
(in code:self[spec] * self[spec.spec]
). \(p\) and \(T\) are the pressure [Pa] and temperature [K] of the atmospheric point, respectively. \(k\) is the Boltzmann constant.- Parameters:
spec (SpeciesEnum | SpeciesIsotope) – The species or isotopologue that is considered.
- readxml(self, file: str) None
Read variable from file
- Parameters:
file (str) – A file that can be read
- On Error:
Throws RuntimeError for any failure to read
- savexml(self, file: str, type: str = 'ascii', clobber: bool = True) None
Saves variable to file
- Parameters:
- On Error:
Throws RuntimeError for any failure to save
- set_isotopologue_ratio(self, isot: pyarts.arts.SpeciesIsotope, x: float) None
Set the isotopologue ratio
- set_nlte_value(self, qid: pyarts.arts.QuantumIdentifier, x: float) None
Set the NLTE value
- set_species_vmr(self, spec: pyarts.arts.SpeciesEnum, x: float) None
Set the VMR of the species
- species_vmr(self, spec: pyarts.arts.SpeciesEnum) float
Get the VMR of the species
- to_dict(self, core: bool = True, specs: bool = True, isots: bool = True, nlte: bool = True, ssprops: bool = True) dict[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, float]
Convert an atmospheric point to a dictionary.
Tip
The function
stringify_keys()
may be used to convert the dictionary keys to strings. This allows for easier manipulation of the data of the dictionary.- Parameters:
core (bool, optional) – If True, the core atmospheric data will be included (i.e., temperature, pressure, etc). Default is True.
specs (bool, optional) – If True, the species VMR data will be included. Default is True.
isots (bool, optional) – If True, the isotopologue ratio data will be included. Default is True.
nlte (bool, optional) – If True, the NLTE data will be included. Default is True.
ssprops (bool, optional) – If True, the scattering species properties data will be included. Default is True.
- update(self, data: collections.abc.Mapping[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, float]) None
Update the atmospheric point with dictionary values.
Tip
Each key-type of the dictionary is constructible from a
str
. So using a dictionary with string keys is possible.- Parameters:
data (dict) – A dictionary of atmospheric keys and corresponding data.
Static Methods
- from_dict(data: collections.abc.Mapping[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, float], iso: pyarts.arts.IsoRatioOption = 'Builtin') pyarts.arts.AtmPoint
Create an atmospheric point from a dictionary.
Tip
Each key-type of the dictionary is constructible from a
str
. So using a dictionary with string keys is possible.- Parameters:
data (dict) – A dictionary of atmospheric keys and corresponding data.
iso (IsoRatioOption, optional) – The isotopologue ratio option to use. Default is “Builtin”. Use “None” to create point without isotopologue ratios.
- fromxml(file: str) pyarts.arts.AtmPoint
Create variable from file
- Parameters:
file (str) – A file that can be read
- On Error:
Throws RuntimeError for any failure to read
Attributes
- mag
Magnetic field [T]
- pressure
Pressure [Pa]
- temperature
Temperature [K]
- wind
Wind field [m/s]
Operators
- __eq__(value, /)
Return self==value.
- __ge__(value, /)
Return self>=value.
- __getitem__(self, arg: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, /) float
- __getstate__(self) tuple[list[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty], pyarts.arts.ArrayOfNumeric]
- __gt__(value, /)
Return self>value.
- __hash__()
Return hash(self).
- __le__(value, /)
Return self<=value.
- __lt__(value, /)
Return self<value.
- __ne__(value, /)
Return self!=value.
- __setitem__(self, arg0: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, arg1: float, /) None