misc edits for build/run/test chs

ufs-community · Oct 20, 2023 · 11bab84 · 11bab84
1 parent b4cf2df
commit 11bab84
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/docs/UsersGuide/source/BuildingRunningTesting/ContainerQuickstart.rst b/docs/UsersGuide/source/BuildingRunningTesting/ContainerQuickstart.rst
@@ -339,7 +339,7 @@ From here, users can follow the steps below to configure the out-of-the-box SRW
       .. code-block:: console
 
          USE_USER_STAGED_EXTRN_FILES: true
-         EXTRN_MDL_SOURCE_BASEDIR_ICS: /scratch1/NCEPDEV/nems/role.epic/UFS_SRW_data/develop/input_model_data/FV3GFS/grib2/${yyyymmddhh}
+         EXTRN_MDL_SOURCE_BASEDIR_ICS: /scratch1/NCEPDEV/nems/role.epic/UFS_SRW_data/v2p2/input_model_data/FV3GFS/grib2/${yyyymmddhh}
 
       On other systems, users will need to change the path for ``EXTRN_MDL_SOURCE_BASEDIR_ICS`` and ``EXTRN_MDL_FILES_LBCS`` (below) to reflect the location of the system's data. The location of the machine's global data can be viewed :ref:`here <Data>` for Level 1 systems. Alternatively, the user can add the path to their local data if they downloaded it as described in :numref:`Section %s <InitialConditions>`. 
 
@@ -348,7 +348,7 @@ From here, users can follow the steps below to configure the out-of-the-box SRW
       .. code-block:: console
 
          USE_USER_STAGED_EXTRN_FILES: true
-         EXTRN_MDL_SOURCE_BASEDIR_LBCS: /scratch1/NCEPDEV/nems/role.epic/UFS_SRW_data/develop/input_model_data/FV3GFS/grib2/${yyyymmddhh}
+         EXTRN_MDL_SOURCE_BASEDIR_LBCS: /scratch1/NCEPDEV/nems/role.epic/UFS_SRW_data/v2p2/input_model_data/FV3GFS/grib2/${yyyymmddhh}
 
 
 .. _GenerateWorkflowC: 

diff --git a/docs/UsersGuide/source/BuildingRunningTesting/Quickstart.rst b/docs/UsersGuide/source/BuildingRunningTesting/Quickstart.rst
@@ -27,7 +27,7 @@ For a detailed explanation of how to build and run the SRW App on any supported
 
       .. code-block:: console
 
-         git clone -b develop https://github.com/ufs-community/ufs-srweather-app.git
+         git clone -b release/public-v2.2.0 https://github.com/ufs-community/ufs-srweather-app.git
 
    #. Check out the external repositories:
 
@@ -52,6 +52,7 @@ For a detailed explanation of how to build and run the SRW App on any supported
 
       .. code-block:: console
          
+         source /path/to/etc/lmod-setup.sh <platform>
          module use /path/to/ufs-srweather-app/modulefiles
          module load wflow_<platform>
 

diff --git a/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst b/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst
@@ -410,6 +410,8 @@ To determine whether the ``config.yaml`` file adjustments are valid, users can r
 
    ./config_utils.py -c config.yaml -v config_defaults.yaml -k "(?\!rocoto\b)"
 
+.. COMMENT: Remove this section!!!
+
 A correct ``config.yaml`` file will output a ``SUCCESS`` message. A ``config.yaml`` file with problems will output a ``FAILURE`` message describing the problem. For example:
 
 .. code-block:: console

diff --git a/docs/UsersGuide/source/BuildingRunningTesting/VXCases.rst b/docs/UsersGuide/source/BuildingRunningTesting/VXCases.rst
@@ -154,7 +154,7 @@ Then, edit the configuration file (``config.yaml``) to include the variables and
          
    To modify the file, hit the ``i`` key and then make any changes required. To close and save, hit the ``esc`` key and type ``:wq``. Users may opt to use their preferred code editor instead. 
 
-For additional configuration guidance, refer to the |release| release documentation on :ref:`configuring the SRW App <srw_|release|:UserSpecificConfig>`.
+For additional configuration guidance, refer to the |release| release documentation on :ref:`configuring the SRW App <srw_v2.1.0:UserSpecificConfig>`.
 
 Generate the Experiment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -273,6 +273,8 @@ The Point-Stat files contain continuous variables like temperature, pressure, an
 
 The Point-Stat files contain a potentially overwhelming amount of information. Therefore, it is recommended that users focus on the CNT MET test, which contains the `RMSE <https://met.readthedocs.io/en/latest/Users_Guide/appendixC.html#root-mean-squared-error-rmse>`__ and `MBIAS <https://met.readthedocs.io/en/latest/Users_Guide/appendixC.html?highlight=csi#multiplicative-bias>`__ statistics. The MET tests are defined in column 24 'LINE_TYPE' of the ``.stat`` file. Look for 'CNT' in this column. Then find column 66-68 for MBIAS and 78-80 for RMSE statistics. A full description of this file can be found `here <https://met.readthedocs.io/en/latest/Users_Guide/point-stat.html#point-stat-output>`__.
 
+.. COMMENT: Update links!
+
 To narrow down the variable field even further, users can focus on these weather variables: 
 
    * 250 mb - wind speed, temperature