standard/std standard/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#
- dir_obsvect : str, optional, default “”
contains the observation vector from a previous simulation
- dump_obs : bool, optional, default False
dump the observation vector in a netcdf file
- dump_index : bool, optional, default False
dump the observation vector index as ‘orig_index’
- obsvect_only : bool, optional, default False
Process only observations that are part of the observation vector
- dump_type : “nc” or “csv”, optional, default “nc”
Type of file to dump to
“nc”: Dump into a NetCDF
“csv”: Dump into a csv file
- transform_pipe : optional
List of transformations to build the main observation operator pipeline
- Argument structure:
- any_key : optional
Name of a given transformation to be included. The name has no impact on the way the observation operator is computed, although it is recommended to use explicit names to help debugging.
- Argument structure:
- **args : optional
Arguments to set-up the given transform
Requirements#
The current plugin requires the present plugins to run properly:
YAML template#
Please find below a template for a YAML configuration:
1obsvect:
2 plugin:
3 name: standard
4 version: std
5 type: obsvect
6
7 # Optional arguments
8 dir_obsvect: XXXXX # str
9 dump_obs: XXXXX # bool
10 dump_index: XXXXX # bool
11 obsvect_only: XXXXX # bool
12 dump_type: XXXXX # nc|csv
13 transform_pipe:
14 any_key:
15 **args: XXXXX # any