Forward run (forward
/ std
)¶
Description¶
This mode simply runs the observation operator in forward mode (including the transport model and all auxiliary operations). Depending on how the model and the system is set up, it will compute observation equivalent and/or save all the 4d concentration fields.
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¶
run_mode: (optional): fwd
Running mode for the forward simulation
accepted values:
fwd: run a full forward mode
tl: run the tangent-linear operator
use_xb: (optional): True
Running mode for the forward simulation
accepted type: <class ‘bool’>
perturb_obsvect: (optional): False
If True, perturbs the output observation vector to generate truth in OSSEs. The formula used for the perturbations is \(\delta y \sim \mathcal{N}(0, \sigma_\epsilon)\), with \(\sigma_\epsilon = \sigma_\mathbf{y} \;.\; \delta\); \(\delta\) is the value specified in ${obserror}. Perturbed simulations are saved in the
obs
column of the outputmonitor.nc
file; \(\sigma_\mathbf{y} \;.\; \delta\)accepted type: <class ‘bool’>
obserror: (optional): 0.0
The scale used to generate perturbation on the errors.
accepted type: <class ‘float’>
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 |
True |
True |
standard |
std |
|
obsoperator |
True |
False |
standard |
std |
Yaml template¶
Please find below a template for a Yaml configuration:
1mode:
2 plugin:
3 name: forward
4 version: std
5 type: mode
6
7
8 # Optional arguments
9 run_mode: XXXXX
10 use_xb: XXXXX
11 perturb_obsvect: XXXXX
12 obserror: XXXXX
13 reload_results: XXXXX