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: (optional):
contains the observation vector from a previous simulation
accepted type: str
dump_obs: (optional): False
dump the observation vector in a netcdf file
accepted type: bool
obsvect_only: (optional): False
Process only observations that are part of the observation vector
accepted type: bool
dump_type: (optional): nc
Type of file to dump to
accepted values:
nc: Dump into a NetCDF
csv: Dump into a csv file
Requirements¶
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
---|---|---|---|---|---|
model |
True |
True |
None |
None |
|
datavect |
True |
True |
standard |
std |
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 obsvect_only: XXXXX # bool
11 dump_type: XXXXX # nc|csv