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

autorestart: (optional): False

if interrupted, computations restart from the last simulated period. WARNING: the CIF cannot detect whether this period has been correctly written or is corrupt: it is necessary to check manually in the relevant directories and remove the last simulated period if a file has not been correctly written.

accepted type: <class ‘bool’>

onlyinit: (optional): False

only generate the inputs for all periods, do not run the actual model

accepted type: <class ‘bool’>

autoflush: (optional): False

Remove big temporary files when the run is done

accepted type: <class ‘bool’>

save_debug: (optional): False

Force transforms to save debugging information. Intermediate datastores will be saved in the directory $workdir/obsoperator/$run_id/transform_debug/

Warning

This option saves every intermediate states of the transformation pipeline. It slows drastically the computation of the obsvervation operator and can take a lot of disk space. Should be used only for debugging or understanding what happens along the way.

accepted type: <class ‘bool’>

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

False

True

None

None

obsvect

ObsVect

True

True

standard

std

controlvect

ControlVect

True

True

standard

std

datavect

DataVect

True

True

standard

std

platform

Platform

True

True

None

None

Yaml template

Please find below a template for a Yaml configuration:

 1obsoperator:
 2  plugin:
 3    name: standard
 4    version: std
 5    type: obsoperator
 6
 7
 8  # Optional arguments
 9  autorestart: XXXXX
10  onlyinit: XXXXX
11  autoflush: XXXXX
12  save_debug: XXXXX