AtmPoint

class pyarts.arts.AtmPoint(*args, **kwargs)

An atmospheric point

Workspace variables of type AtmPoint

atmospheric_point

Overview

Method	`flat_values()`	Returns a flat list of values.
Method	`isotopologue_ratio()`	Get the isotopologue ratio
Method	`keys()`	Available keys
Method	`nlte_value()`	Get the NLTE value
Method	`no_isotopologues()`	Returns an atmospheric point without isotopologue ratios.
Method	`number_density()`	Get the number density [1 / m ³] of a species or of a species isotopologue.
Method	`readxml()`	Read variable from file
Method	`savexml()`	Saves variable to file
Method	`set_isotopologue_ratio()`	Set the isotopologue ratio
Method	`set_nlte_value()`	Set the NLTE value
Method	`set_species_vmr()`	Set the VMR of the species
Method	`species_vmr()`	Get the VMR of the species
Method	`to_dict()`	Convert an atmospheric point to a dictionary.
Method	`update()`	Update the atmospheric point with dictionary values.
Static Method	`from_dict()`	Create an atmospheric point from a dictionary.
Static Method	`fromxml()`	Create variable from file
Attribute	`mag`	Magnetic field [T]
Attribute	`pressure`	Pressure [Pa]
Attribute	`temperature`	Temperature [K]
Attribute	`wind`	Wind field [m/s]
Operator	`__eq__()`	Return self==value.
Operator	`__ge__()`	Return self>=value.
Operator	`__getitem__()`	Overloaded function.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__setitem__()`	Set the value of a key

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) → 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 ³] 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 a SpeciesEnum (in code: self[spec]) or the VMR of the species isotopolgue if spec is a SpeciesIsotope (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:

file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files
type (str) – Type of file to save. See FileType for options.
clobber (bool) – Overwrite existing files or add new file with modified name?

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, key: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty) → float

__getitem__(self, key: pyarts.arts.ArrayOfSpeciesTag) → float

Overloaded function.

__getitem__(self, key: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty) -> float

Get the value of a key

__getitem__(self, key: pyarts.arts.ArrayOfSpeciesTag) -> float

Set the value of a key

__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, key: pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, val: float) → None
__setitem__(self, key: pyarts.arts.ArrayOfSpeciesTag, val: float) → None: Set the value of a key