SpeciesIsotope

class pyarts.arts.SpeciesIsotope(*args, **kwargs)

Contains descriptions about an isotope.

Workspace methods that require SpeciesIsotope

Overview

Method

Q()

Partition function

Method

readxml()

Read variable from file

Method

savexml()

Saves variable to file

Static Method

fromxml()

Create variable from file

Attribute

gi

float The degeneracy of states of the molecule. It is -1 if not defined.

Attribute

isotname

str A custom name that is unique for this Species type

Attribute

mass

float The mass of the isotope in units of grams per mol. It is Nan if not defined

Attribute

name

String The full name

Attribute

predef

bool Check if this represents a predefined model

Attribute

spec

Species The species

Operator

__eq__()

Return self==value.

Operator

__ge__()

Return self>=value.

Operator

__getstate__()

__getstate__(self) -> tuple[pyarts.arts.SpeciesEnum, std::basic_string_view<char, std::char_traits<char> >, float, int]

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

__setstate__()

__setstate__(self, arg: tuple[pyarts.arts.SpeciesEnum, str, float, int], /) -> None

Constructors

__init__(self) None
__init__(self, arg: pyarts.arts.SpeciesIsotope) None
__init__(self, isot: int = 0) None
__init__(self, arg: str, /) None
__init__(self, arg: str, /) None

Overloaded function.

  1. __init__(self) -> None

  2. __init__(self, arg: pyarts.arts.SpeciesIsotope) -> None

  3. __init__(self, isot: int = 0) -> None

From position

  1. __init__(self, arg: str, /) -> None

From str

  1. __init__(self, arg: str, /) -> None

Methods

Q(self, T: float) float

Partition function

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.SpeciesIsotope

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

gi

float The degeneracy of states of the molecule. It is -1 if not defined.

isotname

str A custom name that is unique for this Species type

mass

float The mass of the isotope in units of grams per mol. It is Nan if not defined

name

String The full name

predef

bool Check if this represents a predefined model

spec

Species The species

Operators

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__getstate__(self) tuple[pyarts.arts.SpeciesEnum, std::basic_string_view<char, std::char_traits<char> >, float, int]
__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__setstate__(self, arg: tuple[pyarts.arts.SpeciesEnum, str, float, int], /) None