Agenda

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

Describes a set of function calls and variable definitions

Agendas are effectively constrained callback methods. They define a set of inputs and outputs. These variables are always local to a method that uses the agenda. In addition to these local variables, the agenda has full access to copy or share any workspace variables. However, by tracking how named workspace variables are used in an agenda, ARTS ensures that the agenda does not change the global workspace while minimizing the number of variables that need to be copied or shared.

Workspace variables of type Agenda

disort_settings_agenda disort_settings_downwelling_wrapper_agenda inversion_iterate_agenda measurement_inversion_agenda propagation_matrix_agenda propagation_matrix_scattering_agenda propagation_matrix_scattering_spectral_agenda

ray_path_observer_agenda spectral_radiance_closed_surface_agenda spectral_radiance_observer_agenda spectral_radiance_space_agenda spectral_radiance_surface_agenda surface_reflectance_agenda

Overview

Method	add()	Adds a method to the Agenda
Method	document()	Returns a list of methods and state
Method	execute()	Executes the agenda on the provided workspace
Method	finalize()	Finalize the agenda, making it possible to use it in the workspace
Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
list[Method]	methods	The methods of the agenda.
str	name	The name of the agenda.
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getstate__()	Helper for pickle.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	Overloaded function.
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

__init__(self, name: str) → None

Overloaded function.

1. __init__(self) -> None

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

3. __init__(self, name: str) -> None

Create with name

Methods

add(self, method: pyarts3.arts.Method) → None

Adds a method to the Agenda

All workspace variables are defaulted, and all GIN with defaults create anonymous workspace variables. All input that are not workspace variables are added to the workspace

The input order takes priority over the named argument order, so Copy(a, out=b) will not even see the b variable.

document(self, prep: str = '- ') → str

Returns a list of methods and state

execute(self, ws: pyarts3.arts.CxxWorkspace) → None

Executes the agenda on the provided workspace

finalize(self, fix: bool = False) → None

Finalize the agenda, making it possible to use it in the workspace

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.Agenda

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

methods: list[Method]

The methods of the agenda.

name: str

The name of the agenda.

Operators

__eq__(value, /)

Return self==value.

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

__ge__(value, /)

Return self>=value.

__getstate__()

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

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

__init__(self, name: str) → None

Overloaded function.

1. __init__(self) -> None

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

3. __init__(self, name: str) -> None

Create with name

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__str__(self) → str