SurfacePropertyTag

class pyarts3.arts.SurfacePropertyTag(*args, **kwargs)

A surface property.

These tags are part of the keys that can be used to access a SurfaceField or SurfacePoint. They are completely free-form and currently not used by ARTS internally. Instead, they offer a customization point for users to define their own surface properties and ensures we can access them in a consistent way.

Please see individual surface models/methods for keys that are relevant to run them. They will generally throw an error if you lack the data.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`String`	`name`	Name of property
Operator	`__eq__()`	`__eq__(self, arg: pyarts3.arts.SurfacePropertyTag, /) -> bool`
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	`__ge__(self, arg: pyarts3.arts.SurfacePropertyTag, /) -> bool`
Operator	`__gt__()`	`__gt__(self, arg: pyarts3.arts.SurfacePropertyTag, /) -> bool`
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	`__init__(self, arg: str, /) -> None`
Operator	`__le__()`	`__le__(self, arg: pyarts3.arts.SurfacePropertyTag, /) -> bool`
Operator	`__lt__()`	`__lt__(self, arg: pyarts3.arts.SurfacePropertyTag, /) -> bool`
Operator	`__ne__()`	`__ne__(self, arg: pyarts3.arts.SurfacePropertyTag, /) -> bool`
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

__init__(self) → None
__init__(self, arg: SurfacePropertyTag) → 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) → SurfacePropertyTag

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:: SurfacePropertyTag

Attributes

name: String: Name of property

Operators

__eq__(self, arg: SurfacePropertyTag, /) → bool

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

__ge__(self, arg: SurfacePropertyTag, /) → bool

__gt__(self, arg: SurfacePropertyTag, /) → bool

__hash__(): Return hash(self).

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

__le__(self, arg: SurfacePropertyTag, /) → bool

__lt__(self, arg: SurfacePropertyTag, /) → bool

__ne__(self, arg: SurfacePropertyTag, /) → bool

__repr__(self) → str

__str__(self) → str