AtmKey

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

Group name: “AtmKey”

A key to identify an atmospheric property.

Valid options:

"t" or "temperature": Temperature [K]
"p" or "pressure": Pressure [Pa]
"wind_u" or "WindU": Wind field U-component [m/s]
"wind_v" or "WindV": Wind field V-component [m/s]
"wind_w" or "WindW": Wind field W-component [m/s]
"mag_u" or "MagU": Magnetic field U-component [T]
"mag_v" or "MagV": Magnetic field V-component [T]
"mag_w" or "MagW": Magnetic field W-component [T]

Overview

Method	`readxml()`	Read variable from file
Method	`savexml()`	Saves variable to file
Static Method	`fromxml()`	Create variable from file
Static Method	`get_options()`	Get a list of all options
Static Method	`get_options_as_strings()`	Get a list of all options as strings
Static Data	`pyarts.arts.AtmKey.MagU`	“mag_u” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.MagV`	“mag_v” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.MagW`	“mag_w” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.WindU`	“wind_u” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.WindV`	“wind_v” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.WindW`	“wind_w” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.mag_u`	“mag_u” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.mag_v`	“mag_v” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.mag_w`	“mag_w” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.p`	“p” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.pressure`	“p” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.t`	“t” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.temperature`	“t” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.wind_u`	“wind_u” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.wind_v`	“wind_v” - `AtmKey`
Static Data	`pyarts.arts.AtmKey.wind_w`	“wind_w” - `AtmKey`
Operator	`__eq__()`	self == other
Operator	`__ge__()`	self >= other
Operator	`__getstate__()`	__getstate__(self) -> tuple[str]
Operator	`__gt__()`	self > other
Operator	`__hash__()`	Allows hashing
Operator	`__le__()`	self <= other
Operator	`__lt__()`	self < other
Operator	`__ne__()`	self != other
Operator	`__setstate__()`	__setstate__(self, arg: tuple[str], /) -> None

Constructors

__init__(self) → None
__init__(self, arg: pyarts.arts.AtmKey) → None
__init__(self, arg: str, /) → None

Methods

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

Static Methods

fromxml(file: str) → pyarts.arts.AtmKey

Create variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

get_options() → list[pyarts.arts.AtmKey]: Get a list of all options

get_options_as_strings() → list[str]: Get a list of all options as strings

Operators

__eq__(self, arg: pyarts.arts.AtmKey, /) → bool: self == other

__ge__(self, arg: pyarts.arts.AtmKey, /) → bool: self >= other

__getstate__(self) → tuple[str]

__gt__(self, arg: pyarts.arts.AtmKey, /) → bool: self > other

__hash__(self) → int: Allows hashing

__le__(self, arg: pyarts.arts.AtmKey, /) → bool: self <= other

__lt__(self, arg: pyarts.arts.AtmKey, /) → bool: self < other

__ne__(self, arg: pyarts.arts.AtmKey, /) → bool: self != other

__setstate__(self, arg: tuple[str], /) → None