SpeciesIsotopologueInfo

class pyarts3.arts.SpeciesIsotopologueInfo(*args, **kwargs)

Information about an isotopologue

Overview

Method

readxml()

Read variable from file.

Method

savexml()

Saves variable to file.

Static Method

fromxml()

Create variable from file.

str

code

The key of the isotopologue (e.g., in H2O-161, this is ‘161’)

float

default_ratio

The built-in isotopologue ratio

int

degeneracy

The degeneracy of the isotopologue models

float

mass

The mass of the species in atomic units

str

species

The Species key of the isotopologue (e.g., in H2O-161, this is ‘H2O’)

Operator

__eq__()

__eq__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) -> bool

Operator

__format__()

__format__(self, arg: str, /) -> str

Operator

__ge__()

__ge__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) -> bool

Operator

__gt__()

__gt__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) -> bool

Operator

__hash__()

__hash__(self) -> int

Operator

__init__()

__init__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo) -> None

Operator

__le__()

__le__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) -> bool

Operator

__lt__()

__lt__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) -> bool

Operator

__ne__()

__ne__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) -> bool

Operator

__repr__()

__repr__(self) -> str

Operator

__str__()

__str__(self) -> str

Constructors

__init__(self) None
__init__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo) None

Methods

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

fromxml(file: str) pyarts3.arts.SpeciesIsotopologueInfo

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Returns:

artstype – The variable created from the file.

Return type:

T

Attributes

code: str

The key of the isotopologue (e.g., in H2O-161, this is ‘161’)

default_ratio: float

The built-in isotopologue ratio

degeneracy: int

The degeneracy of the isotopologue models

mass: float

The mass of the species in atomic units

species: str

The Species key of the isotopologue (e.g., in H2O-161, this is ‘H2O’)

Operators

__eq__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__eq__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__format__(self, arg: str, /) str
__ge__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__ge__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__gt__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__gt__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__hash__(self) int
__init__(self) None
__init__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo) None
__le__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__le__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__lt__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__lt__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__ne__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__ne__(self, arg: pyarts3.arts.SpeciesIsotopologueInfo, /) bool
__repr__(self) str
__str__(self) str