modes are implemented in pyCIF so far:
- 4DVAR variational inversions (
- Analytical inversions (
- Ensemble Square-Root Filter (
- Footprints or backward mode (
- Forward run (
- Test of the adjoint (
mode class executes computation modes in pyCIF.
This is the highest level class in pyCIF.
At the execution of pyCIF, the specified
mode is executed and
all the rest of the configuration is derived from it.
As the highest level class in pyCIF, the
mode class is never called by any other pyCIF class.
Thus, it only needs the following function to be made available in the module:
execute executes the computation mode.
the mode itself
The function does not need to return objects explicitly.
However, it is recommended to make it return an object characterizing the output.
For instance, for the test of the adjoint, the function
execute returns the error of the test;
for the forward mode, it returns the observation vectors with comparison between original observations and simulations.