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:

  1. a species

  2. an isotopologue of a species

  3. an absorption band of an isotopologue

  4. an absorption line of an isotopologue

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

Attribute

isot

Isotopologue

Attribute

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

__getstate__()

__getstate__(self) -> tuple[str]

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

__setstate__()

__setstate__(self, arg: tuple[str], /) -> None

Operator

__str__()

__str__(self) -> str

Constructors

__init__(self, arg: str, /) None
__init__(self) None
__init__(self, arg: pyarts3.arts.QuantumIdentifier) None

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

On Error:

Throws RuntimeError for any failure to read

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) – 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) pyarts3.arts.QuantumIdentifier

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

isot: SpeciesIsotope

Isotopologue

state: QuantumState

State

Operators

__eq__(self, arg: pyarts3.arts.QuantumIdentifier, /) bool
__format__(self, arg: str, /) str
__ge__(self, arg: pyarts3.arts.QuantumIdentifier, /) bool
__getstate__(self) tuple[str]
__gt__(self, arg: pyarts3.arts.QuantumIdentifier, /) bool
__hash__(self) int
__init__(self, arg: str, /) None
__init__(self) None
__init__(self, arg: pyarts3.arts.QuantumIdentifier) None
__le__(self, arg: pyarts3.arts.QuantumIdentifier, /) bool
__lt__(self, arg: pyarts3.arts.QuantumIdentifier, /) bool
__ne__(self, arg: pyarts3.arts.QuantumIdentifier, /) bool
__repr__(self) str
__setstate__(self, arg: tuple[str], /) None
__str__(self) str