Skip to content

Commit

Permalink
add new chapters to introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
gspetro-NOAA committed Jul 24, 2024
1 parent fcdbc36 commit 9e2e891
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
7 changes: 5 additions & 2 deletions doc/source/BackgroundInfo/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ This User's Guide is organized into four sections: (1) *Background Information*;

Background Information
========================
* This chapter (Introduction) provides background information on the Unified Forecast System (:term:`UFS`) and the NoahMP model.
* :numref:`Chapter %s <TechOverview>` (Technical Overview) outlines prerequisites, user support levels, and directory structure.
* This chapter (Introduction) provides user support information and background information on the Unified Forecast System (:term:`UFS`) and the Noah-MP model.
* :numref:`Chapter %s <TechOverview>` (Technical Overview) outlines prerequisites, supported systems, and directory structure.

Building, Running, and Testing the Land DA System
===================================================
Expand All @@ -45,12 +45,15 @@ Building, Running, and Testing the Land DA System
Customizing the Workflow
=========================

* :numref:`Chapter %s: Available Workflow Configuration Parameters <ConfigWorkflow>` explains all of the user-configurable options currently available in the workflow configuration file (``land_analysis*.yaml``).
* :numref:`Chapter %s: Model <Model>` provides information on input data and configuration parameters in the Noah-MP LSM and its Vector-to-Tile Converter.
* :numref:`Chapter %s: DA Framework <DASystem>` provides information on the DA system, required data, and configuration parameters.

Reference
===========

* :numref:`Chapter %s: Rocoto <Rocoto>` provides background information on the Rocoto workflow manager as used in Land DA.

Check warning on line 55 in doc/source/BackgroundInfo/Introduction.rst

View workflow job for this annotation

GitHub Actions / build

undefined label: 'rocoto'
* :numref:`Chapter %s: FAQ <FAQ>` addresses frequently asked questions.
* :numref:`Chapter %s: Glossary <Glossary>` lists important terms.

User Support and Documentation
Expand Down
22 changes: 11 additions & 11 deletions doc/source/Reference/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ On platforms that utilize Rocoto workflow software (including Hera and Orion), i

.. code-block:: console
rocotostat -w land_analysis.xml -d land_analysis.db
CYCLE TASK JOBID STATE EXIT STATUS TRIES DURATION
=============================================================================
200001030000 prepexp 16779414 SUCCEEDED 0 1 11.0
200001030000 prepobs 16779415 SUCCEEDED 0 1 0.0
200001030000 prepbmat 16779416 SUCCEEDED 0 1 9.0
200001030000 runana 16779434 SUCCEEDED 0 1 68.0
200001030000 runfcst - DEAD 256 1 2186.0
$ rocotostat -w land_analysis.xml -d land_analysis.db
CYCLE TASK JOBID STATE EXIT STATUS TRIES DURATION
=======================================================================================
200001030000 prep_obs 61746034 SUCCEEDED 0 1 11.0
200001030000 pre_anal 61746035 SUCCEEDED 0 1 13.0
200001030000 analysis 61746081 SUCCEEDED 0 1 76.0
200001030000 post_anal 61746109 SUCCEEDED 0 1 4.0
200001030000 plot_stats 61746110 SUCCEEDED 0 1 70.0
200001030000 forecast 61746128 DEAD 256 1 -
This means that the dead task has not completed successfully, so the workflow has stopped. Once the issue has been identified and fixed (by referencing the log files), users can re-run the failed task using the ``rocotorewind`` command:
.. COMMENT: Where are the log files actually?
This means that the dead task has not completed successfully, so the workflow has stopped. Once the issue has been identified and fixed (by referencing the log files in ``$LANDDAROOT/ptmp/test/com/output/logs/run_<forcing>``), users can re-run the failed task using the ``rocotorewind`` command:

.. code-block:: console
rocotorewind -w land_analysis.xml -d land_analysis.db -v 10 -c 200001030000 -t runfcst
rocotorewind -w land_analysis.xml -d land_analysis.db -v 10 -c 200001030000 -t forecast
where ``-c`` specifies the cycle date (first column of ``rocotostat`` output) and ``-t`` represents the task name
(second column of ``rocotostat`` output). After using ``rocotorewind``, the next time ``rocotorun`` is used to
Expand Down

0 comments on commit 9e2e891

Please sign in to comment.