Skip to content

Commit

Permalink
Add 'Run DART with your model' documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsonbk committed Mar 29, 2021
1 parent 2393c1b commit 5cb7fb3
Show file tree
Hide file tree
Showing 5 changed files with 256 additions and 5 deletions.
21 changes: 20 additions & 1 deletion guide/adding-your-observations-to-dart.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
Adding your observations to DART
================================
================================

First, you should understand that DART already supports a tremendous variety of
observations. To fully support an observation means that the observation can be
converted from its native format to the DART observation sequence format and
that the observation forward operator is already implemented. Keep in mind that
forward operators are not specific to any one model.

The observation converters are in the *observations/obs_converter* directory and
you should look there for the documentation describing which converters are
available.

The forward operators are functionally or logically grouped into Fortran modules
in the *observations/forward_operator* directory. DART employs a ‘contractual’
style of programming in that the forward operator requests information from the
model, and if the model cannot provide it, the forward operator may request
different information in an attempt to collect the information needed to apply
the operator. If the model cannot provide any of the required information, the
forward operator fails, the DART QC for that observation is set to the
appropriate value, and the program continues.
10 changes: 9 additions & 1 deletion guide/how-to-test-your-model-mod-routines.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
How to test your model_mod routines
===================================
===================================

The program ``model_mod_check.f90`` can be used to test the routines
individually before running them with *filter*. Add a ``mkmf_model_mod_check``
and ``path_names_model_mod_check`` to your ``DART/models/your_model/work``
subdirectory. You might find it helpful to consult another model matching your
model type (simple or complex). See the documentation for ``model_mod_check`` in
``DART/assimilation_code/programs/model_mod_check`` for more information on the
tests available.

0 comments on commit 5cb7fb3

Please sign in to comment.