Skip to content

Commit

Permalink
minor edits
Browse files Browse the repository at this point in the history
  • Loading branch information
gspetro-NOAA committed Nov 2, 2023
1 parent 69b6117 commit 92f0780
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
4 changes: 1 addition & 3 deletions docs/UsersGuide/source/BackgroundInfo/Components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,7 @@ For more information on NEXUS, visit the GitHub repository at https://github.com
Unified Workflow Tools
========================

The Unified Workflow (UW) is a set of tools intended to unify the workflow for various UFS applications under one framework. The UW toolkit currently includes templater and configuration (config) tools, which have been incorporated into the SRW App workflow and will soon be incorporated into other UFS repositories. Additional tools are under development. More details about the UW can be found in the `workflow-tools <https://github.com/ufs-community/workflow-tools>`__ GitHub repository and in the `UW Documentation <https://unified-workflow.readthedocs.io/en/latest/>`__.

.. COMMENT: Add UW docs to conf.py?
The Unified Workflow (UW) is a set of tools intended to unify the workflow for various UFS applications under one framework. The UW toolkit currently includes templater and configuration (config) tools, which have been incorporated into the SRW App workflow and will soon be incorporated into other UFS repositories. Additional tools are under development. More details about the UW can be found in the `workflow-tools <https://github.com/ufs-community/workflow-tools>`__ GitHub repository and in the :doc:`UW Documentation <uw:index>`.

Build System and Workflow
=========================
Expand Down
2 changes: 1 addition & 1 deletion docs/UsersGuide/source/BuildingRunningTesting/VXCases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ METplus Verification Sample Cases
Introduction
===============

The goal of these sample cases is to provide the UFS community with datasets that they can modify and run to see if their changes can improve the forecast and/or reduce the model biases. Each case covers an interesting weather event. The case that was added ahead of the v2.1.0 release was a severe weather event over Indianapolis on June 15-16, 2019. Content was updated for the |latestr| release. In the future, additional sample cases will be provided.
The goal of these sample cases is to provide the UFS community with datasets that they can modify and run to see if their changes can improve the forecast and/or reduce the model biases. Each case covers an interesting weather event. The case that was added ahead of the v2.1.0 release was a severe weather event over Indianapolis on June 15-16, 2019. Content was updated for the v2.2.0 release. In the future, additional sample cases will be provided.

Each sample case contains model output from a control run; this output includes ``postprd`` (post-processed) and ``metprd`` (MET verification-processed) directories. Under the ``postprd`` directory, users will find the :term:`UPP` output of the model run along with plots for several forecast variables (when plotting tasks are run). These can be used for a visual/qualitative comparison of forecasts. The ``metprd`` directory contains METplus verification statistics files, which can be used for a quantitative comparison of forecast outputs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The data format for these files can be :term:`GRIB2` or :term:`NEMSIO`. More inf

Pre-processing (UFS_UTILS)
---------------------------
When a user generates the SRW App workflow as described in :numref:`Section %s <GenerateWorkflow>`, the workflow generation script links the input data for the pre-processing utilities to the experiment directory. The pre-processing utilities use many different datasets to create grids and to generate model input datasets from the external model files. A detailed description of the input files for the pre-processing utilities can be found in the UFS_UTILS :doc:`Technical Documentation <ufs-utils:index>` and `Scientific Documentation <https://ufs-community.github.io/UFS_UTILS/ver-1.11.0/index.html>`__.
When a user generates the SRW App workflow as described in :numref:`Section %s <GenerateWorkflow>`, the workflow generation script links the input data for the pre-processing utilities to the experiment directory. The pre-processing utilities use many different datasets to create grids and to generate model input datasets from the external model files. A detailed description of the input files for the pre-processing utilities can be found in the UFS_UTILS :doc:`Technical Documentation <ufs-utils:index>` and `Scientific Documentation <https://ufs-community.github.io/UFS_UTILS/index.html>`__.

UFS Weather Model
-----------------
Expand Down Expand Up @@ -148,7 +148,9 @@ where ``HHH`` corresponds to the 3-digit forecast hour (e.g., ``dynf006.nc`` for

Unified Post Processor (UPP)
----------------------------
Documentation for the UPP output files can be found in the `UPP User's Guide <https://upp.readthedocs.io/en/latest/InputsOutputs.html>`__.
Documentation for the UPP output files can be found in the `UPP User's Guide <https://upp.readthedocs.io/en/latest/InputsOutputs.html#output-files>`__.

.. COMMENT: Add crosslink in UPP docs; add ref here.
For the SRW Application, the Weather Model netCDF output files are written to ``$EXPTDIR/YYYYMMDDHH/postprd`` and have the naming convention (file->linked to):

Expand Down
1 change: 1 addition & 0 deletions docs/UsersGuide/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ def setup(app):
'ccpp-techdoc': ('https://ccpp-techdoc.readthedocs.io/en/ufs_srw_app_v2.2.0/', None),
'stochphys': ('https://stochastic-physics.readthedocs.io/en/latest/', None),
'srw_v2.2.0': ('https://ufs-srweather-app.readthedocs.io/en/release-public-v2.2.0/', None),
'uw': ('https://unified-workflow.readthedocs.io/en/latest/', None),
}

# -- Options for todo extension ----------------------------------------------
Expand Down

0 comments on commit 92f0780

Please sign in to comment.