pycif.plugins.modes.forward — API reference

Configuration reference: forward plugin

pycif.plugins.modes.forward.execute.execute(self, **kwargs)

Run the observation operator in forward (or tangent-linear) mode.

Initialises the control vector from its background state when use_xb is set, validates that both x and at least one observation are defined, then calls the obs-operator. Optionally perturbs the resulting simulated observations with Gaussian noise (controlled by perturb_obsvect and obserror) and dumps the resulting observation vector.

Parameters:

• self (Plugin) – mode plugin carrying all configuration attributes (workdir, datei, datef, run_mode, use_xb, perturb_obsvect, obserror, reload_results).

• **kwargs – forwarded verbatim to the observation operator.

Returns:

the observation vector populated with simulated values.

Return type:

ObsVect