Skip to content

Commit

Permalink
Update doc/UsersGuide/BuildingRunningTesting/RunSRW.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com>
  • Loading branch information
gsketefian and gspetro-NOAA authored Nov 18, 2024
1 parent 3ca5387 commit 72de59d
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions doc/UsersGuide/BuildingRunningTesting/RunSRW.rst
Original file line number Diff line number Diff line change
Expand Up @@ -817,24 +817,26 @@ summer period for which ``ASNOW`` is not relevant.

Staging Observation Files
``````````````````````````````````
The taskgroup in ``verify_pre.yaml`` defines a set of workflow tasks named ``get_obs_*`` --- where the ``*``
represents any one of the supported obs types :term:`CCPA`, :term:`NOHRSC`, :term:`MRMS`, and :term:`NDAS` ---
that will first check for the existence of the obs files required for VX at the locations on disk specified
The taskgroup in ``verify_pre.yaml`` defines a set of workflow tasks named ``get_obs_*``, where the ``*``
represents any one of the supported obs types: :term:`CCPA`, :term:`NOHRSC`, :term:`MRMS`, and :term:`NDAS`. These ``get_obs_*`` tasks
will first check on disk for the existence of the obs files required for VX using the locations specified
by the variables ``*_OBS_DIR`` and ``OBS_*_FN_TEMPLATES[1,3,...]`` in the ``verification:`` section of
``config.yaml``. The ``*_OBS_DIR`` are the base directories in which the obs files are or should be
``config.yaml``. The ``*_OBS_DIR`` are the base directories in which the obs files are or should be
staged, and the ``OBS_*_FN_TEMPLATES[1,3,...]`` are the file name templates (with METplus time strings
used for templating; see example below). The ``[1,3,...]`` in ``OBS_*_FN_TEMPLATES[1,3,...]`` refer
to the second, fourth, etc elements of ``OBS_*_FN_TEMPLATES`` and correspond to the various sets of files
that the obs type contains. (The first, third, etc elements, i.e. ``OBS_*_FN_TEMPLATES[0,2,...]``,
indicate the VX field groups for which the respective sets of obs files are used to verify and should
not be changed.) Note that ``OBS_*_FN_TEMPLATES[1,3,...]`` may include leading subdirectories and are
relative to the obs type's ``*_OBS_DIR``. Thus, the templates for the full paths to the obs files are
given by
used for templating; see example below). Thus, the templates for the full paths to the obs files are
given by:

.. code-block:: console
{*_OBS_DIR}/{OBS_*_FN_TEMPLATES[1,3,...]}
The contents of the ``OBS_*_FN_TEMPLATES`` list come in pairs, where the first element
of each pair (with even-numbered indices ``[0,2,...]``) refers to the field group,
while the second element (with odd-numbered indices ``[1,3,...]``) refers to the
corresponding sets of files that the obs type contains. Note that ``OBS_*_FN_TEMPLATES
[1,3,...]`` may include leading subdirectories and are
relative to the obs type's ``*_OBS_DIR``.

If the obs files exist at the locations specified by ``{*_OBS_DIR}/{OBS_*_FN_TEMPLATES[1,3,...]}``, then the ``get_obs_*`` tasks will
succeed, and the workflow will move on to subsequent tasks. If one or more obs files do not exist, the
``get_obs_*`` tasks will attempt to retrieve the required files from a data store such as NOAA HPSS and
Expand Down

0 comments on commit 72de59d

Please sign in to comment.