release/public-v2: Updated documentation for SRW release #265

- Fixed some broken links in AddNewVariable.rst
- Updated the example output for adding a new variable for the latest version of the code
- Minor spelling, wording, and formatting changes

docs/AddNewVariable.rst

@@ -223,9 +223,9 @@ with examples in the sections below.
 
 7. Add the new variable to /EMC_post/parm/params_grib2_tbl_new.
    For all current UPP output fields, this table lists, in order, the:
-    - Discipline (http://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_table0-0.shtml)
-    - Category (http://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_table4-1.shtml)
-    - Parameter Number (http://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_table4-2.shtml)
+    - Discipline (https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_table0-0.shtml)
+    - Category (https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_table4-1.shtml)
+    - Parameter Number (https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_table4-2.shtml)
     - Table information (0 for parameters from the WMO table; 1 for parameters from the local
       NCEP table)
     - Abbreviated Variable Name (from the parameters table)
@@ -236,8 +236,8 @@ with examples in the sections below.
     - TG3 is a land surface product (discipline=2)
     - TG3 is a vegetation/biomass product (category=0)
     - Pick an unused parameter number from the table defined by discipline=2 and
-      category=0 (Table 4.2-0-0: http://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_table4-
-      2-0-0.shtml). The parameter number should not be in use in table 4.2 or the current
+      category=0 (Table 4.2-0-0: https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_table4-2-2-0.shtml). 
+      The parameter number should not be in use in table 4.2 or the current
       params_grib2_tbl_new. In this case, the unused parameter number 231 was chosen.
     - Add using the NCEP local table (table=1)
     - Choose an abbreviated parameter name to describe your field (e.g. TG3)
@@ -273,10 +273,7 @@ with examples in the sections below.
        <scale>3.0</scale>
      </param>
 
-9. Add the new variable to the /EMC_post/parm/postcntrl_gfs.xml file, which lists all fields and levels
-   you wish to output for GRIB2. Remake the /EMC_post/parm/postxconfig-NT-GFS.txt file, which is read by
-   UPP and contains the information from the xml.
-    - See the User’s guide on steps for creating the text control file
+9. Add the new variable to the /EMC_post/parm/postcntrl_gfs.xml file, which lists all fields and levels you wish to output for GRIB2. Remake the /EMC_post/parm/postxconfig-NT-GFS.txt file (as described in the section :ref:`InputsOutputs:Creating the Flat Text File`), which is read by UPP and contains the information from the xml.
 
    User procedure
     - Add as:
@@ -311,10 +308,11 @@ with examples in the sections below.
 
     wgrib2 -V GFSPRS.006
 
-    714:37697079:vt=2019061506:500 m underground:6 hour fcst:var discipline=2 center=7 local_table=1 parmcat=0 parm=231:
+    716:37731711:vt=2019061506:500 m underground:6 hour fcst:var discipline=2 center=7 local_table=1 parmcat=0 parm=231:
         ndata=73728:undef=0:mean=278.383:min=215.47:max=302.4
         grid_template=40:winds(N/S):
         Gaussian grid: (384 x 192) units 1e-06 input WE:NS output WE:SN
         number of latitudes between pole-equator=96 #points=73728
         lat 89.284225 to -89.284225
         lon 0.000000 to 359.062500 by 0.937500
+

docs/InputsOutputs.rst

@@ -53,7 +53,7 @@ which fields and levels to process.
 
 A default control file, :bolditalic:`postxconfig-NT.txt`, is provided and read by the UPP. For users
 wishing to customize the control file to add or remove fields and/or levels, they may do so by
-modyfying the :bolditalic:`postcntrl.xml` and then remaking the text file required by the UPP.
+modifying the :bolditalic:`postcntrl.xml` and then remaking the text file as described in the later section :ref:`Creating the Flat Text File`.
 
 .. Note::
    The control file names :bolditalic:`postxconfig-NT.txt` and :bolditalic:`postcntrl.xml` are generic
@@ -84,7 +84,7 @@ isobaric or height levels), the desired levels to be output must be listed (see
 Controlling which levels the UPP outputs
 ----------------------------------------
 
-The <level> tag in the postcntrl.xml is used to list the desired levels for output. The following
+The <level> tag in the postcntrl.xml file is used to list the desired levels for output. The following
 levels are currently available for output:
 
 - For isobaric output, 46 levels are possible, from 2 to 1000 hPa (*2, 5, 7, 10, 20, 30, 50, 70 mb and
@@ -148,9 +148,9 @@ working directory. These files will include all fields that were requested in th
 When running UPP stand-alone, the following Grib2 output files will be generated:
 
    | **GFS Model**: GFSPRS.HHH
-   | **LAM (Limeted Area Model)**: BGDAWP.HHH (surface and other 2D fields) and BGRD3D.HHH (model level
+   | **LAM (Limited Area Model)**: BGDAWP.HHH (surface and other 2D fields) and BGRD3D.HHH (model level
      fields)
 
-If the run did not complete successfully, a log file in the post-processor working directory called
-:bolditalic:`upp.fHHH.out` where :bolditalic:`HHH` is the forecast hour, may be consulted for further
-information.
+When executed with the provided run script, UPP provides log files in the post-processor working directory named
+:bolditalic:`upp.fHHH.out`, where :bolditalic:`HHH` is the forecast hour. These log files may be consulted for further
+run-time information in the event of an error.

docs/Installation.rst

@@ -20,9 +20,8 @@ available on your system. These libraries include:
   - The NCEP libraries
     https://github.com/NOAA-EMC/NCEPLIBS
 
-An introduction of each can be found in their respective top level :bolditalic:`README.md` file.
-Detailed instructions for building the libraries on various platforms can be found in the repository
-**NCEPLIBS-external/doc** directory.
+An introduction of each can be found in their respective top level :bolditalic:`README.md` files.
+Detailed instructions for building the libraries on various platforms can be found in the **NCEPLIBS-external/doc** directory.
 
 Certain machines do have the NCEP libraries in a pre-installed location for use to build UPP. Paths to
 these pre-installed libraries are available on the
@@ -55,7 +54,7 @@ EMC_post.
 where, ``release-tag-name`` is the release tag you wish to clone (e.g. for stand-alone UPP
 version 9, use the release tag :bolditalic:`upp_v9.0.0`).
 
-Move into the top level UPP directory and create and move into the build directory. Build the UPP code.
+Move into the top level UPP directory and create and move into the build directory. Then build the UPP code using the cmake utility.
 The path ``INSTALL_PREFIX`` should point to the location of the pre-installed NCEP libraries.
 
 .. code-block:: console
@@ -87,8 +86,8 @@ tar file.
 .. note::
    To make a clean build, simply remove both the **/build** directory and the
    :bolditalic:`bin/ncep_post` executable and then re-create the build from step #2. This is
-   recommended if a mistake is made during the installation process or if a change is made to the build
-   environment or UPP code.
+   recommended if a mistake is made during the installation process. If a simple change is made to the code,
+   you can simply type :bolditalic:`make install` again in the pre-existing build directory.
 
 =======================
 UPP Directory Structure
@@ -101,7 +100,7 @@ directory that exists only after the build is complete):
 
      | **build**: Contains the UPP build
 
-     | **include***: Source include modules built/used during compilation of UPP
+     | **include***: Contains include modules built/used during compilation of UPP
 
      | **lib***: Libraries built/used by UPP that are separate from NCEPlibs
 

docs/Running.rst

@@ -117,9 +117,9 @@ Run Script Overview
 Upon a successful run, UPP will generate output files for each forecast hour in the
 **/postprd** directory.
 
-If the run did not complete successfully, a log file in the **/postprd** directory called
-:bolditalic:`upp.fhhh.out` where :bolditalic:`"hhh"` is the forecast hour, may be consulted for further
-information.
+When executed with the provided run script, UPP provides log files in the post-processor working directory named
+:bolditalic:`upp.fHHH.out`, where :bolditalic:`HHH` is the forecast hour. These log files may be consulted for further
+run-time information in the event of an error.
 
 .. note::
    FV3 output is on a Guassian grid. To interpolate to a lat/lon or other projection, use wgrib2 (see

docs/conf.py

@@ -31,7 +31,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autosectionlabel'
 ]
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth = 4
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']