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

use_xb: (optional): True

Running mode for the forward simulation

accepted type: <class ‘bool’>

reload_results: (optional): False

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

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

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
 8  # Optional arguments
 9  use_xb: XXXXX
10  reload_results: XXXXX