SpeciesTag

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

A tagged absorption species

These tags are used to help ARTS identify the species so that reading routines can find the correct data files.

Note

In previous versions of ARTS, this type had computational meaning. This is no longer the case and the type is now only used to help with file IO.

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.
SpeciesEnum	cia_2nd_species	CIA species
String	full_name	The full name
SpeciesEnum	spec	Species
int	spec_ind	Species index
SpeciesTagType	type	Type of tag
Operator	__eq__()	__eq__(self, arg: pyarts3.arts.SpeciesTag, /) -> bool
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	__ge__(self, arg: pyarts3.arts.SpeciesTag, /) -> bool
Operator	__getstate__()	__getstate__(self) -> tuple[int, pyarts3.arts.SpeciesTagType, pyarts3.arts.SpeciesEnum]
Operator	__gt__()	__gt__(self, arg: pyarts3.arts.SpeciesTag, /) -> bool
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: str, /) -> None
Operator	__le__()	__le__(self, arg: pyarts3.arts.SpeciesTag, /) -> bool
Operator	__lt__()	__lt__(self, arg: pyarts3.arts.SpeciesTag, /) -> bool
Operator	__ne__()	__ne__(self, arg: pyarts3.arts.SpeciesTag, /) -> bool
Operator	__repr__()	__repr__(self) -> str
Operator	__setstate__()	__setstate__(self, arg: tuple[int, pyarts3.arts.SpeciesTagType, pyarts3.arts.SpeciesEnum], /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

__init__(self, arg: pyarts3.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) → 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.SpeciesTag

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

cia_2nd_species: SpeciesEnum

CIA species

full_name: String

The full name

spec: SpeciesEnum

Species

spec_ind: int

Species index

type: SpeciesTagType

Type of tag

Operators

__eq__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__eq__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__format__(self, arg: str, /) → str

__ge__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__getstate__(self) → tuple[int, pyarts3.arts.SpeciesTagType, pyarts3.arts.SpeciesEnum]

__gt__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__hash__()

Return hash(self).

__init__(self) → None

__init__(self, arg: pyarts3.arts.SpeciesTag) → None

__init__(self, arg: str, /) → None

__le__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__lt__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__ne__(self, arg: pyarts3.arts.SpeciesTag, /) → bool

__repr__(self) → str

__setstate__(self, arg: tuple[int, pyarts3.arts.SpeciesTagType, pyarts3.arts.SpeciesEnum], /) → None

__str__(self) → str