Dump to specific format dump2format/std

Description

This transform allows to dump the data at the end of the control vector transformations to a specific format. The data can be regridded and resampled before being dumped.

YAML arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Mandatory arguments

parameter : str, mandatory

Name of the parameter to dump to a specific format.

component : str, mandatory

Name of the component to dump to a specific format.

Optional arguments

orig_parameter_plg : Plugin, optional

Plugin object on which the transform works on

orig_component_plg : Plugin, optional

Corresponding component object on which the transform works on

successor : str, optional

Name of the successor transform

precursor : str, optional

Name of the precursor transform

dump_dir : str, optional

Dump directory for the files, the simulation period run subdirectory is used by default.

dump_file : str, optional, default “dump_%Y%m%d”

File format for the files

dump_format : optional

Definition of the plugin to use to dump the data, this plugin should have a write method implemented

Argument structure:

name : str, mandatory

Name of the plugin

version : str, mandatory

Version of the plugin

type : str, mandatory

Type of the plugin

dump_options : optional

Dumping options, i.e., options for the plugin chosen in dump_format

overwrite : bool, optional, default True

If the target file already exists and overwrite is False, the data will not be dumped.

use_defined_domain : bool, optional, default False

Get the dump domain from the YAML configuration as a plugin dependency, the domain plugin is picked from this plugin or from the root level if none is defined within this plugin

use_get_domain : optional

Get the dump domain with get_domain method of the plugin defined with dump_format and dump_options, the dump_options arguments are passed to the dump plugin’s get_domain method with the tracer keyword argument.

Argument structure:

file : str, mandatory

File name passed as the second positional argument (ref_file) of the dump plugin’s get_domain method

dir : str, optional, default “”

Directory passed as the first positional argument (ref_dir) of the dump plugin’s get_domain method

resample_dump : optional

Resample the data before dumping

Argument structure:

file_freq : str, mandatory

Dump files frenquency

var_freq : str, mandatory

Variable frequency inside each file

Requirements

The current plugin requires the present plugins to run properly:

Requirement name	Requirement type	Explicit definition	Any valid	Default name	Default version
domain	Domain	True	True	None	None

YAML template

Please find below a template for a YAML configuration:

transform:
  plugin:
    name: dump2format
    version: std
    type: transform

  # Mandatory arguments
  parameter: XXXXX  # str
  component: XXXXX  # str

  # Optional arguments
  orig_parameter_plg: XXXXX  # Plugin
  orig_component_plg: XXXXX  # Plugin
  successor: XXXXX  # str
  precursor: XXXXX  # str
  dump_dir: XXXXX  # str
  dump_file: XXXXX  # str
  dump_format:
    name: XXXXX  # str
    version: XXXXX  # str
    type: XXXXX  # str
  dump_options: XXXXX  # any
  overwrite: XXXXX  # bool
  use_defined_domain: XXXXX  # bool
  use_get_domain:
    dir: XXXXX  # str
    file: XXXXX  # str
  resample_dump:
    file_freq: XXXXX  # str
    var_freq: XXXXX  # str