DAPPER is a set of templates for benchmarking the performance of data assimilation (DA) methods. The tests provide experimental support and guidance for new developments in DA.

The typical set-up is a synthetic (twin) experiment, where you

• specify a
  • dynamic model

    *

  • observational model

    *

• use these to generate a synthetic
  • "truth"
  • and observations thereof

    *

• assess how different DA methods perform in estimating the truth, given the above starred (

  *

  ) items.

<!-- Inspiration: https://github.com/Naereen/badges It seems hits.dwyl.com is overloaded at the moment -->

Highlights

DAPPER enables the numerical investigation of DA methods through a variety of typical test cases and statistics. It (a) reproduces numerical benchmarks results reported in the literature, and (b) facilitates comparative studies, thus promoting the (a) reliability and (b) relevance of the results. For example, this figure is generated by

examples/basic_3.py

DAPPER is (c) open source, written in Python, and (d) focuses on readability; this promotes the (c) reproduction and (d) dissemination of the underlying science, and makes it easy to adapt and extend. It also comes with a battery of diagnostics and statistics, and live plotting (on-line with the assimilation) facilities, including pause/inspect options, as illustrated below

In summary, it is well suited for teaching and fundamental DA research. Also see its drawbacks.

Installation

Works on Linux/Windows/Mac.

Prerequisite: Python>=3.8

If you're not an admin or expert:

• Install Anaconda.

• Open the Anaconda terminal and run the following commands:

  conda create --yes --name my-env python=3.8 conda activate my-env python -c 'import sys; print("Version:", sys.version.split()[0])'

Ensure the output at the end gives a version bigger than 3.8.
Keep using the same terminal for the commands below.

Install

Either: Install as library

Do you just want to run a script that requires DAPPER? Then

• If the script comes with a

  requirements.txt

  file, then do
  

  pip install -r path/to/requirements.txt

  .
• If not, hopefully you know the version of DAPPER needed. Run
  

  pip install DA-DAPPER==1.0.0

  to get version

  1.0.0

  (as an example).

Or: Install for development

Do you want the DAPPER code available play around with? Then

• Download and unzip (or

  git clone

  ) DAPPER.
• Move the resulting folder wherever you like,
  and

  cd

  into it (ensure you're in the folder with a

  setup.py

  file).

• pip install -e .[dev]

  
  You can omit

  [dev]

  if you don't need to do serious development.

Finally: Test the installation

You should now be able to do run your script with

python path/to/script.py

python examples/basic_1.py

If you've closed the terminal (or shut down your computer), you first need to open the (anaconda) terminal and run this:

conda activate my-env

Quickstart

Read, run, and understand the scripts

examples/basic_{1,2,3}.py

The documentation provides more information, and the API reference.

Alternatively, DA-tutorials provides a python-based introduction to DA.

DA methods

¹: Stochastic, DEnKF (i.e. half-update), ETKF (i.e. sym. sqrt.). Serial forms are also available.
Tuned with inflation and "random, orthogonal rotations".
²: Also supports the bundle version, and "EnKF-N"-type inflation.
³: Resampling: multinomial (including systematic/universal and residual).
The particle filter is tuned with "effective-N monitoring", "regularization/jittering" strength, and more.

For a list of ready-made experiments with suitable, tuned settings for a given method (e.g. the

iEnKS

cd dapper/mods
grep -r "iEnKS.*("

Test cases (models)

• *

  : Flexible; set as necessary

• +

  : Tangent Linear Model included?

The models are found as subdirectories within

dapper/mods

__init__.py

demo.py

authorYEAR.py

HMM

find

cd dapper/mods
find . -iname '[a-z]*[0-9]*.py'

Some of these files contain settings that have been used in several papers. As mentioned above, DAPPER reproduces literature results. There are also results in the literature that DAPPER does not reproduce. Typically, this means that the published results are incorrect.

Similar projects

DAPPER is aimed at research and teaching (see discussion up top). Example of limitations:

• It is not suited for very big models (>60k unknowns).
• Time-dependent error covariances and changes in lengths of state/obs (although the Dyn and Obs models may otherwise be time-dependent).
• Non-uniform time sequences not fully supported.

Also, DAPPER comes with no guarantees/support. Therefore, if you have an operational (real-world) application, such as WRF, you should look into one of the alternatives, sorted by approximate project size.

The

EnKF-Matlab

IEnKS

*: AWI/Liege/CNRS/NERSC/Reading/Delft

Contributors

Patrick N. Raanes, Colin Grudzien, Maxime Tondeur, Remy Dubois

If you use this software in a publication, please cite as follows.

@misc{raanes2018dapper,
  author = {Patrick N. Raanes and others},
  title  = {nansencenter/DAPPER: Version 0.8},
  month  = December,
  year   = 2018,
  doi    = {10.5281/zenodo.2029296},
  url    = {https://doi.org/10.5281/zenodo.2029296}
}

DAPPER is developed and maintained at NORCE (Norwegian Research Institute) and the Nansen Environmental and Remote Sensing Center

Publication list

• https://www.geosci-model-dev-discuss.net/gmd-2019-136/
• https://rmets.onlinelibrary.wiley.com/doi/abs/10.1002/qj.3386
• https://www.nonlin-processes-geophys-discuss.net/npg-2019-10
• Stein
• EmblAUS/Springer chapter