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: <class ‘str’>

dump_obs: (optional): False

dump the control vector in a netcdf file

accepted type: <class ‘bool’>

obsvect_only: (optional): False

Process only observations that are part of the observation vector

accepted type: <class ‘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

Model

True

True

None

None

datavect

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
 8  # Optional arguments
 9  dir_obsvect: XXXXX
10  dump_obs: XXXXX
11  obsvect_only: XXXXX
12  dump_type: XXXXX