QuantumIdentifier

class pyarts3.arts.QuantumIdentifier(*args, **kwargs)

An ID for an absorption species state

It contains upper and lower level information of a quantum state.

It can identify:

Workspace methods that require QuantumIdentifier

Overview

Method	`as_symbol()`	Get the molecular symbol as often seen in literature
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`SpeciesIsotope`	`isot`	Isotopologue
`QuantumState`	`state`	State
Operator	`__eq__()`	`__eq__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> bool`
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	`__ge__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> bool`
Operator	`__gt__()`	`__gt__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> bool`
Operator	`__hash__()`	`__hash__(self) -> int`
Operator	`__init__()`	`__init__(self, arg: pyarts3.arts.QuantumIdentifier) -> None`
Operator	`__le__()`	`__le__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> bool`
Operator	`__lt__()`	`__lt__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> bool`
Operator	`__ne__()`	`__ne__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> bool`
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

Methods

as_symbol(self) → str: Get the molecular symbol as often seen in literature :returns: symbol – The symbol representation :rtype: str

readxml(self, file: str) → str

Read variable from file.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

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, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.
clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

Create variable from file.

Attributes

Operators