Dump to transform inputs dump2inputs/std

Dump to transform inputs dump2inputs/std#

Description#

dump2inputs transform: convert CIF arrays to model-native input format.

Calls the model’s native2inputs (forward) or native2inputs_adj (adjoint) method to write the CIF-internal arrays to the file format expected by the model executable.

This transform acts as the bridge between the abstract xarray/DataFrame representation used inside CIF and the concrete NetCDF/binary files that the model reads. The native2inputs function reference is fetched at mapper initialisation time from the successor transform (run_model).

Note

The forward.py file contains an unused import of satwetch4.io.native2inputs that should be removed.

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:

Optional arguments#

parameter : str, optional

Parameter name on which the transform works on

component : str, optional

Component name on which the transform works on

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

YAML template#

Please find below a template for a YAML configuration:

 1transform:
 2  plugin:
 3    name: dump2inputs
 4    version: std
 5    type: transform
 6
 7  # Optional arguments
 8  parameter: XXXXX  # str
 9  component: XXXXX  # str
10  orig_parameter_plg: XXXXX  # Plugin
11  orig_component_plg: XXXXX  # Plugin
12  successor: XXXXX  # str
13  precursor: XXXXX  # str

See also

API reference (functions & code)