SpeciesTag

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

A tagged absorption species

These tags include the species and a lot of optional information about the isotopologue, the absorption scheme, and the frequency limits

Overview

Method

partfun()

Compute the partition function at a given temperature

Method

readxml()

Read variable from file

Method

savexml()

Saves variable to file

Static Method

fromxml()

Create variable from file

Attribute

cia_2nd_species

Species CIA species

Attribute

full_name

String The full name

Attribute

spec_ind

int Species index

Attribute

type

SpeciesTagType Type of tag

Operator

__eq__()

__eq__(self, arg: pyarts.arts.SpeciesTag, /) -> bool

Operator

__ge__()

Return self>=value.

Operator

__getstate__()

__getstate__(self) -> tuple[int, pyarts.arts.SpeciesTagType, pyarts.arts.SpeciesEnum]

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[int, pyarts.arts.SpeciesTagType, pyarts.arts.SpeciesEnum], /) -> None

Constructors

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

Methods

partfun(self, T: float) float

Compute the partition function at a given temperature

Parameters:

T (Numeric) – Temperature [K]

Returns:

Q – Partition function [-]

Return type:

Numeric

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

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

cia_2nd_species

Species CIA species

full_name

String The full name

spec_ind

int Species index

type

SpeciesTagType Type of tag

Operators

__eq__(self, arg: pyarts.arts.SpeciesTag, /) bool
__ge__(value, /)

Return self>=value.

__getstate__(self) tuple[int, pyarts.arts.SpeciesTagType, pyarts.arts.SpeciesEnum]
__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[int, pyarts.arts.SpeciesTagType, pyarts.arts.SpeciesEnum], /) None