PartitionFunctionsType

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

Type of partition function data.

This is only used by the partition functions setup during compilation. Each type represent a different way to store and compute the partition function of an isotopologue in the PartitionFunctionsData type.

The types, how they compute, and how they store date are as follows:

Interp

The data contains the temperature grid and the corresponding partition function values. The first column is the temperature grid. It must be in increasing order. The second column is the partition function values. The partition function is simply computed by linear interpolation between the grid points.

Constant

The data contains a single value, which is the constant partition function value for all temperatures.

Coeff

The data contains the coefficients of a polynomial expansion of the partition function as a function of temperature. The partition function is computed by evaluating the polynomial at the given temperature. The order of the polynomial is that the first coefficient is the constant term, the second coefficient is the linear term, etc.

StaticInterp

This is very similar to the interp-type, but the grid-values are assumed to be separated by a constant value. This constant value allows for a more efficient lookup and interpolation of the partition function values. The layout of the data is otherwise the same as the interp-type, with the first column being the temperature grid and the second column being the partition function values. The first column must be in increasing order, and the difference between consecutive values must be constant.

Valid options:

• "Interp": Interpolate the data

• "Constant": Use constant value

• "Coeff": Use as polynomial coefficients

• "StaticInterp": Interpolate the data, the temperature grid is known at compile time.

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
Static Method	get_options()	Get a list of all options
Static Method	get_options_as_strings()	Get a list of all options as strings
Static Data	pyarts3.arts.PartitionFunctionsType.Coeff	“Coeff” (PartitionFunctionsType)
Static Data	pyarts3.arts.PartitionFunctionsType.Constant	“Constant” (PartitionFunctionsType)
Static Data	pyarts3.arts.PartitionFunctionsType.Interp	“Interp” (PartitionFunctionsType)
Static Data	pyarts3.arts.PartitionFunctionsType.StaticInterp	“StaticInterp” (PartitionFunctionsType)
Operator	__eq__()	self == other
Operator	__format__()	Default object formatter.
Operator	__ge__()	self >= other
Operator	__gt__()	self > other
Operator	__hash__()	Allows hashing
Operator	__init__()	__init__(self, arg: str, /) -> None
Operator	__le__()	self <= other
Operator	__lt__()	self < other
Operator	__ne__()	self != other
Operator	__repr__()	__repr__(self) -> str
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

__init__(self, arg: str, /) → 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.PartitionFunctionsType

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

get_options() → list[pyarts3.arts.PartitionFunctionsType]

Get a list of all options

get_options_as_strings(i: int = 0) → list[str]

Get a list of all options as strings

Operators

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

self == other

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

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

self >= other

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

self > other

__hash__(self) → int

Allows hashing

__init__(self) → None

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

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

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

self <= other

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

self < other

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

self != other

__repr__(self) → str

__str__(self) → str