standard/std standard/std

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

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    # 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
Contents