Process data to the observation vector toobsvect/std

Process data to the observation vector toobsvect/std#

Description#

toobsvect transform: copy simulated values into the observation vector.

This is the last transform in every forward pipeline branch (end_pipe = True). It reads the point-sampled simulated field from the datastore and accumulates it into obsvect.ysim (forward) or reads obsvect.dy sensitivities back into the datastore (adjoint).

When split_freq is configured, the simulation window is divided into sub-windows and observations are processed one window at a time, which reduces peak memory for dense observation networks.

For ensemble runs, perturb_transform() extends obsvect to hold all member outputs side-by-side by tiling the vector arrays.

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#

parameter : str, optional

Parameter name on which the transform works on

component : str, optional

Component name on which the transform works on

orig_parameter_plg : Plugin, optional

Plugin object on which the transform works on

orig_component_plg : Plugin, optional

Corresponding component object on which the transform works on

successor : str, optional

Name of the successor transform

precursor : str, optional

Name of the precursor transform

split_freq : str, optional

Frequency at which to split the processing of observations. The expected frequency should follow Pandas syntax

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

obsvect

ObsVect

True

True

standard

std

controlvect

ControlVect

True

True

standard

std

YAML template#

Please find below a template for a YAML configuration:

 1transform:
 2  plugin:
 3    name: toobsvect
 4    version: std
 5    type: transform
 6
 7  # Optional arguments
 8  parameter: XXXXX  # str
 9  component: XXXXX  # str
10  orig_parameter_plg: XXXXX  # Plugin
11  orig_component_plg: XXXXX  # Plugin
12  successor: XXXXX  # str
13  precursor: XXXXX  # str
14  split_freq: XXXXX  # str

See also

API reference (functions & code)