update WM links

ufs-community · Oct 24, 2023 · 75cd41e · 75cd41e
1 parent 9ecc8c2
commit 75cd41e
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 15 deletions.
diff --git a/docs/UsersGuide/source/BackgroundInfo/Components.rst b/docs/UsersGuide/source/BackgroundInfo/Components.rst
@@ -35,8 +35,6 @@ Forecast Model
 
 The prognostic atmospheric model in the UFS SRW Application is the Finite-Volume Cubed-Sphere (:term:`FV3`) dynamical core configured with a Limited Area Model (:term:`LAM`) capability (:cite:t:`BlackEtAl2021`). The :term:`dynamical core` is the computational part of a model that solves the equations of fluid motion. A User's Guide for the UFS :term:`Weather Model` can be accessed :doc:`here <ufs-wm:index>`.
 
-.. COMMENT: Update WM doc link in conf.py!
-
 Supported model resolutions in this release include 3-, 13-, and 25-km predefined contiguous U.S. (:term:`CONUS`) domains, each with 127 vertical levels. Preliminary tools for users to define their own domain are also available in the release with full, formal support of these tools to be provided in future releases. The Extended Schmidt Gnomonic (ESG) grid is used with the FV3-LAM, which features relatively uniform grid cells across the entirety of the domain. Additional information about the FV3 dynamical core can be found in the `scientific documentation <https://repository.library.noaa.gov/view/noaa/30725>`__, the `technical documentation <https://noaa-emc.github.io/FV3_Dycore_ufs-v2.0.0/html/index.html>`__, and on the `NOAA Geophysical Fluid Dynamics Laboratory website <https://www.gfdl.noaa.gov/fv3/>`__.
 
 Model Physics

diff --git a/docs/UsersGuide/source/BackgroundInfo/Introduction.rst b/docs/UsersGuide/source/BackgroundInfo/Introduction.rst
@@ -115,11 +115,11 @@ A list of available component documentation is shown in :numref:`Table %s <list_
    * - HPC-Stack Documentation
      - https://hpc-stack-epic.readthedocs.io/en/release-srw-public-v2.2.0/
    * - UFS_UTILS Technical Documentation
-     - https://noaa-emcufs-utils.readthedocs.io/en/ufs_utils_1_10_0/
+     - https://noaa-emcufs-utils.readthedocs.io/en/ufs_utils_1_11_0/
    * - UFS_UTILS Scientific Documentation
-     - https://ufs-community.github.io/UFS_UTILS/ver-1.10.0/index.html
+     - https://ufs-community.github.io/UFS_UTILS/ver-1.11.0/index.html
    * - UFS Weather Model User's Guide
-     - https://ufs-weather-model.readthedocs.io/en/latest
+     - https://ufs-weather-model.readthedocs.io/en/ufs-srw-v2.2.0-doc/
    * - FV3 Technical Documentation
      - https://noaa-emc.github.io/FV3_Dycore_ufs-v2.0.0/html/index.html
    * - FV3 Scientific Documentation
@@ -141,7 +141,7 @@ A list of available component documentation is shown in :numref:`Table %s <list_
    * - METplus User's Guide
      - https://metplus.readthedocs.io/en/main_v4.1/Users_Guide/index.html
 
-.. COMMENT: Update links for stochastic_physics, WM, CCPP Tech docs, UFS_UTILS
+.. COMMENT: Update links for stochastic_physics, CCPP Tech docs, UFS_UTILS
 
 
 User Support and Contributions to Development

diff --git a/docs/UsersGuide/source/BackgroundInfo/TechnicalOverview.rst b/docs/UsersGuide/source/BackgroundInfo/TechnicalOverview.rst
@@ -128,9 +128,7 @@ The :term:`umbrella repository` for the SRW Application is named ``ufs-srweather
    * - Repository for the Unified Workflow (UW) Toolkit
      - https://github.com/ufs-community/workflow-tools
 
-The UFS Weather Model contains a number of sub-repositories, which are documented `here <https://ufs-weather-model.readthedocs.io/en/latest/CodeOverview.html>`__.
-
-.. COMMENT: Update link to release docs!
+The UFS Weather Model contains a number of sub-repositories, which are documented :doc:`here <ufs-wm:CodeOverview>`.
 
 .. note::
    The prerequisite libraries (including NCEP Libraries and external libraries) are not included in the UFS SRW Application repository. The `spack-stack <https://github.com/JCSDA/spack-stack>`__ repository assembles these prerequisite libraries. Spack-stack has already been built on `preconfigured (Level 1) platforms <https://github.com/ufs-community/ufs-srweather-app/wiki/Supported-Platforms-and-Compilers>`__. However, it must be built on other systems. See the :doc:`spack-stack Documentation <spack-stack:index>` for details on installing spack-stack. 
@@ -230,7 +228,7 @@ When the user generates an experiment using the ``generate_FV3LAM_wflow.py`` scr
 
 .. _ExptDirStructure:
 
-.. table::  Files and subdirectory initially created in the experiment directory 
+.. table:: Files and subdirectory initially created in the experiment directory 
    :widths: 33 67 
 
    +---------------------------+--------------------------------------------------------------------------------------------------------------+
@@ -241,7 +239,7 @@ When the user generates an experiment using the ``generate_FV3LAM_wflow.py`` scr
    | data_table                | :term:`Cycle-independent` input file (empty)                                                                 |
    +---------------------------+--------------------------------------------------------------------------------------------------------------+
    | field_table               | :term:`Tracers <tracer>` in the `forecast model                                                              |
-   |                           | <https://ufs-weather-model.readthedocs.io/en/latest/InputsOutputs.html#field-table-file>`__                  |
+   |                           | <https://ufs-weather-model.readthedocs.io/en/ufs-srw-v2.2.0-doc/InputsOutputs.html#field-table-file>`__      |
    +---------------------------+--------------------------------------------------------------------------------------------------------------+
    | FV3LAM_wflow.xml          | Rocoto XML file to run the workflow                                                                          |
    +---------------------------+--------------------------------------------------------------------------------------------------------------+
@@ -270,8 +268,6 @@ When the user generates an experiment using the ``generate_FV3LAM_wflow.py`` scr
    |  YYYYMMDDHH               | Cycle directory (empty)                                                                                      |
    +---------------------------+--------------------------------------------------------------------------------------------------------------+
 
-.. COMMENT: Update the UFS-WM links above and in conf.py!
-
 In addition, running the SRW App in *community* mode creates the ``fix_am`` and ``fix_lam`` directories (see :numref:`Table %s <FixDirectories>`) in ``$EXPTDIR``. The ``fix_lam`` directory is initially empty but will contain some *fix* (time-independent) files after the grid, orography, and/or surface climatology generation tasks run. 
 
 .. _FixDirectories:

diff --git a/docs/UsersGuide/source/Reference/Glossary.rst b/docs/UsersGuide/source/Reference/Glossary.rst
@@ -236,7 +236,7 @@ Glossary
       `Spack <https://spack.readthedocs.io/en/latest/>`__ is a package management tool designed to support multiple versions and configurations of software on a wide variety of platforms and environments. It was designed for large supercomputing centers, where many users and application teams share common installations of software on clusters with exotic architectures. 
 
    spack-stack
-      The `spack-stack <https://github.com/JCSDA/spack-stack>`__ is a collaborative effort between the NOAA Environmental Modeling Center (EMC), the UCAR Joint Center for Satellite Data Assimilation (JCSDA), and the Earth Prediction Innovation Center (EPIC). *spack-stack* is a repository that provides a :term:`Spack`-based method for building the software stack required for numerical weather prediction (NWP) tools such as the `Unified Forecast System (UFS) <https://ufscommunity.org/>`__ and the `Joint Effort for Data assimilation Integration (JEDI) <https://jointcenterforsatellitedataassimilation-jedi-docs.readthedocs-hosted.com/en/latest/>`__ framework. *spack-stack* uses the Spack package manager along with custom Spack configuration files and Python scripts to simplify installation of the libraries required to run various applications. The *spack-stack* can be installed on a range of platforms and comes pre-configured for many systems. Users can install the necessary packages for a particular application and later add the missing packages for another application without having to rebuild the entire stack.
+      The `spack-stack <https://github.com/JCSDA/spack-stack>`__ is a collaborative effort between the NOAA Environmental Modeling Center (EMC), the UCAR Joint Center for Satellite Data Assimilation (JCSDA), and the Earth Prediction Innovation Center (EPIC). *spack-stack* is a repository that provides a :term:`Spack`-based method for building the software stack required for numerical weather prediction (NWP) tools such as the `Unified Forecast System (UFS) <https://ufscommunity.org/>`__ and the `Joint Effort for Data assimilation Integration (JEDI) <https://jointcenterforsatellitedataassimilation-jedi-docs.readthedocs-hosted.com/en/latest/>`__ framework. *spack-stack* uses the Spack package manager along with custom Spack configuration files and Python scripts to simplify installation of the libraries required to run various applications. The *spack-stack* can be installed on a range of platforms and comes pre-configured for many systems. Users can install the necessary packages for a particular application and later add the missing packages for another application without having to rebuild the entire stack. To get started, check out the documentation `here <https://spack-stack.readthedocs.io/en/1.4.1/>`__. 
 
    tracer
       According to the American Meteorological Society (AMS) `definition <https://glossary.ametsoc.org/wiki/Tracer>`__, a tracer is "Any substance in the atmosphere that can be used to track the history [i.e., movement] of an air mass." Tracers are carried around by the motion of the atmosphere (i.e., by :term:`advection`). These substances are usually gases (e.g., water vapor, CO2), but they can also be non-gaseous (e.g., rain drops in microphysics parameterizations). In weather models, temperature (or potential temperature), absolute humidity, and radioactivity are also usually treated as tracers. According to AMS, "The main requirement for a tracer is that its lifetime be substantially longer than the transport process under study."

diff --git a/docs/UsersGuide/source/conf.py b/docs/UsersGuide/source/conf.py
@@ -222,7 +222,7 @@ def setup(app):
    'spack-stack': ('https://spack-stack.readthedocs.io/en/1.4.1/', None),
    'met': ('https://met.readthedocs.io/en/main_v10.1/', None),
    'srw_v2.1.0': ('https://ufs-srweather-app.readthedocs.io/en/release-public-v2.1.0/', None),
-   'ufs-wm': ('https://ufs-weather-model.readthedocs.io/en/latest/', None),
+   'ufs-wm': ('https://ufs-weather-model.readthedocs.io/en/ufs-srw-v2.2.0-doc/', None),
 }
 
 # COMMENT: Update hpc-stack ref to release docs! https://hpc-stack-epic.readthedocs.io/en/release-srw-public-v2.2.0/