Standard CIF control vector (standard / std)

Description

This plugin takes care of initializing the control vector and to compute all operations relative to the control vector.

The control vector is initialized according to the information specified in the data vector.

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

save_out_netcdf: (optional): False

Save NetCDF format in addition to pickle when saving the control vector

accepted type: <class ‘bool’>

force_adj_netcdf: (optional): False

Force saving sensitivities to the adjoint as netcdf

accepted type: <class ‘bool’>

reduced_chi: (optional): False

The Chi space can be reduced by clipping the eigen vectors. Beware that it is an approximation that may save some memory and accelerate converge of variational inversions, but miss some correlation structures

accepted type: <class ‘bool’>

save_full_B: (optional): False

Force dumping the full B matrix.

Warning

Beware of the size of your problem. The full B matrix may be to big to be explicitly defined and stored

accepted type: <class ‘bool’>

reload_xb: (optional): False

Load x from a pre-defined file

accepted type: <class ‘bool’>

perturb_xb: (optional): False

Perturb xb using B

accepted type: <class ‘bool’>

reload_file: (optional):

File from which to reload x

accepted type: <class ‘str’>

Requirements

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

domain

Domain

True

True

None

None

model

Model

True

True

None

None

datavect

DataVect

True

True

standard

std

Yaml template

Please find below a template for a Yaml configuration:

 1controlvect:
 2  plugin:
 3    name: standard
 4    version: std
 5    type: controlvect
 6
 7
 8  # Optional arguments
 9  save_out_netcdf: XXXXX
10  force_adj_netcdf: XXXXX
11  reduced_chi: XXXXX
12  save_full_B: XXXXX
13  reload_xb: XXXXX
14  perturb_xb: XXXXX
15  reload_file: XXXXX