SubsurfacePropertyTag

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

A custom property tag for subsurface fields data.

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

Please see individual subsurface 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 the subsurface property

Operator

__eq__()

__eq__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) -> bool

Operator

__format__()

__format__(self, arg: str, /) -> str

Operator

__ge__()

__ge__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) -> bool

Operator

__getstate__()

Helper for pickle.

Operator

__gt__()

__gt__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) -> bool

Operator

__hash__()

Return hash(self).

Operator

__init__()

__init__(self, arg: pyarts3.arts.SubsurfacePropertyTag) -> None

Operator

__le__()

__le__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) -> bool

Operator

__lt__()

__lt__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) -> bool

Operator

__ne__()

__ne__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) -> bool

Operator

__repr__()

__repr__(self) -> str

Operator

__str__()

__str__(self) -> str

Constructors

__init__(self, arg: str, /) None
__init__(self) None
__init__(self, arg: pyarts3.arts.SubsurfacePropertyTag) 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.SubsurfacePropertyTag

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

name: String

Name of the subsurface property

Operators

__eq__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) bool
__format__(self, arg: str, /) str
__ge__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) bool
__getstate__()

Helper for pickle.

__gt__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) bool
__hash__()

Return hash(self).

__init__(self, arg: str, /) None
__init__(self) None
__init__(self, arg: pyarts3.arts.SubsurfacePropertyTag) None
__le__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) bool
__lt__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) bool
__ne__(self, arg: pyarts3.arts.SubsurfacePropertyTag, /) bool
__repr__(self) str
__str__(self) str