Read model output to data loadfromoutputs/std#
Description#
loadfromoutputs transform: read model outputs into CIF internal format.
Calls the model’s outputs2native (forward) or outputs2native_adj
(adjoint) method to convert the model’s native output files into the
xarray/DataFrame arrays used by downstream CIF transforms.
This transform is a thin adapter: it does not perform any computation
itself. The outputs2native and outputs2native_adj function
references are fetched at mapper initialisation time from the precursor
transform (run_model) so that the correct model-specific I/O code is
called.
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: loadfromoutputs
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