WriteXMLIndexed

Workspace.WriteXMLIndexed(self, output_file_format: pyarts3.arts.String | None = None, file_index: pyarts3.arts.Index | None = None, input: object | None = None, filename: pyarts3.arts.String | None = None, digits: pyarts3.arts.Index | None = None) → None

As WriteXML(), but creates indexed file names.

The variable is written to a file with name:

<filename>.<file_index>.xml.

where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension.

See FileType for valid output_file_format.

Note

ARTS groups, including those that are not workspace groups, generally have a method called savexml that you can access directly from python. It is often more convenient and better to use this method directly instead of using this workspace method. It exists mainly for completeness and for use in agendas.

Author: Patrick Eriksson, Oliver Lemke

Parameters:

  • output_file_format (String, optional) – The format of the output. Defaults to "ascii" [IN]

  • file_index (Index) – Index number for files. [IN]

  • input (Any) – Workspace variable to be saved. [IN]

  • filename (String) – File name. See above. [IN]

  • digits (Index, optional) – Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). Defaults to 0 [IN]