dtcenter · JohnHalleyGotway · Sep 28, 2022 · Sep 28, 2022 · Sep 28, 2022 · Sep 28, 2022
diff --git a/.github/jobs/build_documentation.sh b/.github/jobs/build_documentation.sh
@@ -3,7 +3,12 @@
 # path to docs directory relative to top level of repository
 # $GITHUB_WORKSPACE is set if the actions/checkout@v2 action is run first
 
-DOCS_DIR=${GITHUB_WORKSPACE}/met/docs
+DOCS_DIR=${GITHUB_WORKSPACE}/docs
+
+if [ ! -e ${DOCS_DIR} ]; then
+    echo "Documentation directory does not exist: ${DOCS_DIR}"
+    exit 1
+fi
 
 # run Make to build the documentation and return to previous directory
 cd ${DOCS_DIR}

diff --git a/docs/Users_Guide/config_options.rst b/docs/Users_Guide/config_options.rst
@@ -212,15 +212,43 @@ MET tool stating the location of the parsing error.
 Runtime Environment Variables
 -----------------------------
 
+.. _config_env_vars:
+
+User-Specified Environment Variables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When editing configuration files, environment variables may be used for setting
+the configurable parameters if convenient. The configuration file parser expands
+environment variables to their full value before proceeding. Within the configuration
+file, environment variables must be specified in the form **${VAR_NAME}**.
+
+For example, using an environment variable to set the message_type (see below)
+parameter to use ADPUPA and ADPSFC message types might consist of the following.
+
+Setting the environment variable in a Bash Shell:
+
+.. code :: bash
+
+  export MSG_TYP='"ADPUPA", "ADPSFC"'
+
+Referencing that environment variable inside a MET configuration file:
+
+.. code ::
+
+  message_type = [ ${MSG_TYP} ];
+
+In addition to supporting user-specified environment variables within configuration
+files, the environment variables listed below have special meaning if set at runtime.
+
 MET_AIRNOW_STATIONS
-^^^^^^^^
+^^^^^^^^^^^^^^^^^^^
 
 The MET_AIRNOW_STATIONS environment variable can be used to specify a file that
-will override the default file. If set it should be a full path to the file.
-The default is:
-   "MET_BASE/table_files/airnow_monitoring_site_locations_v2.dat"
-This file contains ascii column data that allows lookups of latitude,longitude,
-and elevation for all airnow stations based on stationId and/or AqSid.
+will override the default file. If set, it should be the full path to the file.
+The default table can be found in the installed
+*share/met/table_files/airnow_monitoring_site_locations_v2.dat*. This file contains
+ascii column data that allows lookups of latitude, longitude, and elevation for all
+airnow stations based on stationId and/or AqSid.
 
 MET_BASE
 ^^^^^^^^

diff --git a/docs/Users_Guide/ensemble-stat.rst b/docs/Users_Guide/ensemble-stat.rst
@@ -14,6 +14,31 @@ The Ensemble-Stat tool verifies deterministic ensemble members against gridded a
 Scientific and statistical aspects
 ==================================
 
+.. _ES_HiRA_framework:
+
+HiRA framework
+--------------
+
+The HiRA framework described in :numref:`PS_HiRA_framework` is also supported in the Ensemble-Stat tool. That support is provided as an interpolation option via the **interp** dictionary. The interpolation dictionary defines how gridded model data is matched to each observation value. Most interpolation methods, such as **UW_MEAN** for the unweighted mean or **BILIN** for bilinear, compute a single value for each ensemble member. When the High Resolution Assessment (HiRA) interpolation method is chosen, as shown below, all of the nearby neighborhood points surrounding each observation from each member are used. Therefore, processing an N-member ensemble using a HiRA neighborhood of size M produces ensemble output with size N*M. This approach fully leverages information from all nearby grid points to evaluate the ensemble quality.
+
+.. code ::
+
+  interp = {
+    field      = BOTH;
+    vld_thresh = 1.0;
+    shape      = SQUARE;
+
+    type = [
+       {
+          method = HIRA;
+          width  = 2;
+          shape  = SQUARE;
+       }
+    ];
+  }
+
+In this example, all four grid points of the 2x2 square surrounding each observation point are used to define the ensemble. Therefore, an N-member ensemble is evaluated as an ensemble of size Nx4.
+
 Ensemble statistics
 -------------------
 
@@ -125,7 +150,7 @@ ensemble_stat configuration file
 
 The default configuration file for the Ensemble-Stat tool named **EnsembleStatConfig_default** can be found in the installed *share/met/config* directory. Another version is located in *scripts/config*. We encourage users to make a copy of these files prior to modifying their contents. Each configuration file (both the default and sample) contains many comments describing its contents. The contents of the configuration file are also described in the subsections below.
 
-Note that environment variables may be used when editing configuration files, as described in the :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 ____________________
 

diff --git a/docs/Users_Guide/gen-ens-prod.rst b/docs/Users_Guide/gen-ens-prod.rst
@@ -90,7 +90,7 @@ gen_ens_prod configuration file
 
 The default configuration file for the Gen-Ens-Prod tool named **GenEnsProdConfig_default** can be found in the installed *share/met/config* directory. Another version is located in *scripts/config*. We encourage users to make a copy of these files prior to modifying their contents. The contents of the configuration file are described in the subsections below.
 
-Note that environment variables may be used when editing configuration files, as described in :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 ____________________
 

diff --git a/docs/Users_Guide/grid-stat.rst b/docs/Users_Guide/grid-stat.rst
@@ -222,7 +222,7 @@ grid_stat configuration file
 
 The default configuration file for the Grid-Stat tool, named **GridStatConfig_default**, can be found in the installed *share/met/config* directory. Other versions of the configuration file are included in *scripts/config*. We recommend that users make a copy of the default (or other) configuration file prior to modifying it. The contents are described in more detail below.
 
-Note that environment variables may be used when editing configuration files, as described in :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 __________________________
 

diff --git a/docs/Users_Guide/mode.rst b/docs/Users_Guide/mode.rst
@@ -193,7 +193,7 @@ mode configuration file
 
 The default configuration file for the MODE tool, **MODEConfig_default**, can be found in the installed *share/met/config* directory. Another version of the configuration file is provided in *scripts/config*. We encourage users to make a copy of the configuration files prior to modifying their contents. Descriptions of **MODEConfig_default** and the required variables for any MODE configuration file are also provided below. While the configuration file contains many entries, most users will only need to change a few for their use. Specific options are described in the following subsections.
 
-Note that environment variables may be used when editing configuration files, as described in :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 _____________________
 

diff --git a/docs/Users_Guide/plotting.rst b/docs/Users_Guide/plotting.rst
@@ -80,7 +80,8 @@ plot_point_obs configuration file
 
 The default configuration file for the Plot-Point-Obs tool named **PlotPointObsConfig_default** can be found in the installed *share/met/config* directory. The contents of the configuration file are described in the subsections below.
 
-Note that environment variables may be used when editing configuration files, as described in :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
+
 ________________________
 
 .. code-block:: none

diff --git a/docs/Users_Guide/point-stat.rst b/docs/Users_Guide/point-stat.rst
@@ -314,7 +314,7 @@ point_stat configuration file
 
 The default configuration file for the Point-Stat tool named **PointStatConfig_default** can be found in the installed *share/met/config* directory. Another version is located in *scripts/config*. We encourage users to make a copy of these files prior to modifying their contents. The contents of the configuration file are described in the subsections below.
 
-Note that environment variables may be used when editing configuration files, as described in :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 ________________________
 
@@ -1545,7 +1545,6 @@ The first set of header columns are common to all of the output files generated
   * - 31
     - S32
     - Counts multiplied by the weights for FCST_CAT 3 and OBS_CAT 2
-LINE_TYPE TOTAL S12 S13 S21 S23 S31 S32 PV1 PV2 PV3 PF1 PF2 PF3 MEAN_FCST MEAN_OBS SEEPS
   * - 32
     - PF1
     - marginal probabilities of the forecast values (FCST_CAT 1)

diff --git a/docs/Users_Guide/reformat_grid.rst b/docs/Users_Guide/reformat_grid.rst
@@ -523,7 +523,7 @@ wwmca_regrid configuration file
 
 The default configuration file for the WWMCA-Regrid tool named **WWMCARegridConfig_default** can be found in the installed *share/met/config* directory. We encourage users to make a copy of this file prior to modifying its contents. The contents of the configuration file are described in the subsections below.
 
-Note that environment variables may be used when editing configuration files, as described in :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 ____________________________
 

diff --git a/docs/Users_Guide/reformat_point.rst b/docs/Users_Guide/reformat_point.rst
@@ -96,15 +96,7 @@ pb2nc configuration file
 
 The default configuration file for the PB2NC tool named **PB2NCConfig_default** can be found in the installed *share/met/config* directory. The version used for the example run in :numref:`Sample test cases` is available in *scripts/config*. It is recommended that users make a copy of configuration files prior to modifying their contents.
 
-When editing configuration files, environment variables may be used for setting the configurable parameters if convenient. The configuration file parser expands any environment variables to their full value before proceeding. Within the configuration file, environment variables must be specified in the form: **${VAR_NAME}**.
-
-For example, using an environment variable to set the **message_type** (see below) parameter to use ADPUPA and ADPSFC message types might consist of the following:
-
-\* In a C-Shell: **setenv MSG_TYP ' "ADPUPA", "ADPSFC" '**
-
-\* In the configuration file: **message_type = [ ${MSG_TYP} ];**
-
-The contents of the default pb2nc configuration file are described below.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 ____________________
 

diff --git a/docs/Users_Guide/series-analysis.rst b/docs/Users_Guide/series-analysis.rst
@@ -93,7 +93,7 @@ series_analysis configuration file
 ----------------------------------
 The default configuration file for the Series-Analysis tool named **SeriesAnalysisConfig_default** can be found in the installed *share/met/config* directory. The contents of the configuration file are described in the subsections below.
 
-Note that environment variables may be used when editing configuration files, as described in the :numref:`pb2nc configuration file` for the PB2NC tool.
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 ____________________
 

diff --git a/docs/Users_Guide/wavelet-stat.rst b/docs/Users_Guide/wavelet-stat.rst
@@ -203,7 +203,9 @@ In the example, the Wavelet-Stat tool will verify the model data in the **sample
 wavelet_stat configuration file
 -------------------------------
 
-The default configuration file for the Wavelet-Stat tool, **WaveletStatConfig_default**, can be found in the installed *share/met/config* directory. Another version of the configuration file is provided in *scripts/config*. We recommend that users make a copy of the default (or other) configuration file prior to modifying it. The contents are described in more detail below. Note that environment variables may be used when editing configuration files, as described in the :numref:`pb2nc configuration file` for the PB2NC tool.
+The default configuration file for the Wavelet-Stat tool, **WaveletStatConfig_default**, can be found in the installed *share/met/config* directory. Another version of the configuration file is provided in *scripts/config*. We recommend that users make a copy of the default (or other) configuration file prior to modifying it. The contents are described in more detail below.
+
+Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 
 _______________________