Agenda

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

Describes a set of function calls and variable definitions

Workspace variables of type Agenda

Overview

Method

add()

Adds a method to the Agenda

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

Attribute

methods

The methods of the agenda

Attribute

name

The name of the agenda

Operator

__eq__()

Return self==value.

Operator

__ge__()

Return self>=value.

Operator

__getstate__()

Helper for pickle.

Operator

__gt__()

Return self>value.

Operator

__hash__()

Return hash(self).

Operator

__le__()

Return self<=value.

Operator

__lt__()

Return self<value.

Operator

__ne__()

Return self!=value.

Constructors

__init__(self) None
__init__(self, arg: pyarts.arts.Agenda) None
__init__(self, name: str) None

Overloaded function.

  1. __init__(self) -> None

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

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

Create with name

Methods

add(self, method: pyarts.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.

execute(self, ws: pyarts.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) None

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) None

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) – Type of file to save. See FileType for options.

  • clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) pyarts.arts.Agenda

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

methods

The methods of the agenda

name

The name of the agenda

Operators

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__getstate__()

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.