moist2dry / std¶
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: (optional)
Parameter name on which the transform works on
accepted type: str
component: (optional)
Component name on which the transform works on
accepted type: str
orig_parameter_plg: (optional)
Plugin object on which the transform works on
accepted type: Plugin
orig_component_plg: (optional)
Corresponding component object on which the transform works on
accepted type: Plugin
successor: (optional)
Name of the successor transform
accepted type: str
precursor: (optional)
Name of the precursor transform
accepted type: str
scale: (optional): 1.0
Scale factor used to convert the original data onto the output unit.
accepted type: float
Yaml template¶
Please find below a template for a Yaml configuration:
1transform:
2 plugin:
3 name: moist2dry
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
14 scale: XXXXX # float
