Footprints or backward mode footprint/std

Footprints or backward mode footprint/std#

Description#

This mode runs the observation operator in backward mode from a given observation increment \(\delta\mathbf{y}^*\)

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#

increments : float, optional

Increment value used to fill the observation vector increment. By default the values from the ‘sim_tl’ column of the monitor files are used.

use_xb : bool, optional, default True

Running mode for the forward simulation

reload_results : bool, optional, default False

Reload results from previous simulations. If True does not recomputed already computed simulations

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

controlvect

ControlVect

True

True

standard

std

obsvect

ObsVect

True

True

standard

std

obsoperator

ObsOperator

True

False

standard

std

YAML template#

Please find below a template for a YAML configuration:

 1mode:
 2  plugin:
 3    name: footprint
 4    version: std
 5    type: mode
 6
 7  # Optional arguments
 8  increments: XXXXX  # float
 9  use_xb: XXXXX  # bool
10  reload_results: XXXXX  # bool
Contents