HitranFileFormatType

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

A file format used to generate an entry in a Hitran-format file.

Note that ARTS do not support all Hitran formats, so if you need a specific format not listed here, please contribute.

If you download data but do not care for using the parameter in ARTS, use the “unknown” option.

The standard HAPI separator of comma (“,”) is presumed between fields.

Valid options:

• "par" or "par_line": The 160-character standard Hitran line format

• "statep" or "qnsp": The upper state

• "statepp" or "qnspp": The lower state

• "unknown" or "X": Skip this field

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.HitranFileFormatType.X	“unknown” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.par	“par” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.par_line	“par” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.qnsp	“statep” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.qnspp	“statepp” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.statep	“statep” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.statepp	“statepp” (HitranFileFormatType)
Static Data	pyarts3.arts.HitranFileFormatType.unknown	“unknown” (HitranFileFormatType)
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.HitranFileFormatType) → 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.HitranFileFormatType

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.HitranFileFormatType]

Get a list of all options

get_options_as_strings() → list[str]

Get a list of all options as strings

Operators

__eq__(self, arg: pyarts3.arts.HitranFileFormatType, /) → 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.HitranFileFormatType, /) → bool

self >= other

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

self > other

__hash__(self) → int

Allows hashing

__init__(self) → None

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

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

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

self <= other

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

self < other

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

self != other

__repr__(self) → str

__str__(self) → str