[develop]: Update container docs w/multi-node Rocoto option (#339)

* updated container instructions * GSI/RRFS formatting fix * another GSI/RRFS formatting fix * add info on binding file dirs * minor edits * update Container Run section * fix headings * fix typo * minor updates * change to release branch version * update binding, sandbox * add NOAACloud/miniconda3 instructions * add table of .img locations * update pre-installed container locations * update .img locations & other minor changes * add troubleshooting section, minor updates * formatting, remove comments * add JET info * format JET info * wording/minor edits * update container name to develop * switch to python workflow/yaml * fix typos, ICS/LBCS file info * minor fix * add :orphan: tag to rst tables * edit sandbox name * wording * typos * add example stage-srw command * remove regional_workflow reference, minor updates * add orion/cron note * fix orion/cron note * fix orion/cron note Co-authored-by: gspetro <gillian.s.petro@gmail.com>
ufs-community · Sep 22, 2022 · 0704343 · 0704343
1 parent cecc90e
commit 0704343
Show file tree

Hide file tree

Showing 9 changed files with 402 additions and 269 deletions.
diff --git a/docs/UsersGuide/source/BuildRunSRW.rst b/docs/UsersGuide/source/BuildRunSRW.rst
diff --git a/docs/UsersGuide/source/ConfigWorkflow.rst b/docs/UsersGuide/source/ConfigWorkflow.rst
@@ -9,6 +9,8 @@ There is an extensive list of experiment parameters that a user can set when con
 
 The following is a list of the parameters in the ``config_defaults.sh`` file. For each parameter, the default value and a brief description is given. 
 
+.. _PlatEnv:
+
 Platform Environment
 ====================
 ``RUN_ENVIR``: (Default: "nco")

diff --git a/docs/UsersGuide/source/ContainerQuickstart.rst b/docs/UsersGuide/source/ContainerQuickstart.rst
diff --git a/docs/UsersGuide/source/Glossary.rst b/docs/UsersGuide/source/Glossary.rst
@@ -99,7 +99,7 @@ Glossary
 
    HPC
    HPCs
-      High-Performance Computing.
+      High-Performance Computing (HPC) System(s).
 
    HPC-Stack
       The `HPC-Stack <https://github.com/NOAA-EMC/hpc-stack>`__ is a repository that provides a unified, shell script-based build system 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.

diff --git a/docs/UsersGuide/source/Quickstart.rst b/docs/UsersGuide/source/Quickstart.rst
@@ -99,7 +99,7 @@ For a detailed explanation of how to build and run the SRW App on any supported
 
          ./generate_FV3LAM_wflow.sh
 
-   #. Run the regional workflow. There are several methods available for this step, which are discussed in :numref:`Section %s <RocotoRun>` and :numref:`Section %s <RunUsingStandaloneScripts>`. One possible method is summarized below. It requires the Rocoto Workflow Manager. 
+   #. Run the regional workflow. There are several methods available for this step, which are discussed in :numref:`Section %s <Run>`. One possible method is summarized below. It requires the Rocoto Workflow Manager. 
 
       .. code-block:: console
 

diff --git a/docs/UsersGuide/source/SRW_NATLEV_table.rst b/docs/UsersGuide/source/SRW_NATLEV_table.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ************************************************************
 Fields Requested in the UPP Parameter Table for SRW NATLEV
 ************************************************************

diff --git a/docs/UsersGuide/source/SRW_PRSLEV_table.rst b/docs/UsersGuide/source/SRW_PRSLEV_table.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 **********************************************************
 Fields Requested in the UPP Parameter Table for SRW PRSLEV
 **********************************************************

diff --git a/docs/UsersGuide/source/Tests.rst b/docs/UsersGuide/source/Tests.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ************************************************************
 Supported WE2E Tests
 ************************************************************

diff --git a/docs/UsersGuide/source/fix_file_list.rst b/docs/UsersGuide/source/fix_file_list.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _StaticFilesList: