Merge remote-tracking branch 'origin/develop' into feature_2036_enhan…

…ce_tc_pairs
dtcenter · Oct 18, 2022 · 7d0d721 · 7d0d721
2 parents afca850 + 4cf28a3
commit 7d0d721
Show file tree

Hide file tree

Showing 309 changed files with 1,800 additions and 1,644 deletions.
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/.github/jobs/get_branch_name.sh b/.github/jobs/get_branch_name.sh
@@ -11,5 +11,5 @@ fi
 
 branch_name=${branch_name#"refs/heads/"}
 
-echo ::set-output name=branch_name::$branch_name
+echo "branch_name=${branch_name}" >> $GITHUB_OUTPUT
 echo branch_name: $branch_name
diff --git a/.github/jobs/set_job_controls.sh b/.github/jobs/set_job_controls.sh
@@ -108,15 +108,15 @@ if [ "$run_unit_tests" == "true" ]; then
 
 fi
 
-echo ::set-output name=run_compile::$run_compile
-echo ::set-output name=run_push::$run_push
-echo ::set-output name=run_unit_tests::$run_unit_tests
-echo ::set-output name=run_diff::$run_diff
-echo ::set-output name=run_update_truth::$run_update_truth
-echo ::set-output name=met_base_repo::$met_base_repo
-echo ::set-output name=met_base_tag::$met_base_tag
-echo ::set-output name=input_data_version::$input_data_version
-echo ::set-output name=truth_data_version::$truth_data_version
+echo "run_compile=${run_compile}" >> $GITHUB_OUTPUT
+echo "run_push=${run_push}" >> $GITHUB_OUTPUT
+echo "run_unit_tests=${run_unit_tests}" >> $GITHUB_OUTPUT
+echo "run_diff=${run_diff}" >> $GITHUB_OUTPUT
+echo "run_update_truth=${run_update_truth}" >> $GITHUB_OUTPUT
+echo "met_base_repo=${met_base_repo}" >> $GITHUB_OUTPUT
+echo "met_base_tag=${met_base_tag}" >> $GITHUB_OUTPUT
+echo "input_data_version=${input_data_version}" >> $GITHUB_OUTPUT
+echo "truth_data_version=${truth_data_version}" >> $GITHUB_OUTPUT
 
 echo run_compile: $run_compile
 echo run_push: $run_push

diff --git a/.github/workflows/build_docker_and_trigger_metplus.yml b/.github/workflows/build_docker_and_trigger_metplus.yml
@@ -18,11 +18,11 @@ jobs:
     name: Handle Docker Image
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Get branch name
         id: get_branch_name
-        run: echo ::set-output name=branch_name::${GITHUB_REF#"refs/heads/"}
+        run: echo branch_name=${GITHUB_REF#refs/heads/} >> $GITHUB_OUTPUT
 
       - name: Build Docker Image
         run: .github/jobs/build_docker_image.sh
@@ -47,7 +47,7 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
         with:
           github-token: ${{ secrets.METPLUS_BOT_TOKEN }}
           script: |

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -11,14 +11,15 @@ on:
       - met/docs/**
   pull_request:
     types: [opened, reopened, synchronize]
+  workflow_dispatch:
 
 jobs:
   documentation:
     name: Build Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: '3.6'
       - name: Install dependencies
@@ -27,12 +28,12 @@ jobs:
           sphinx-gallery Pillow sphinx_rtd_theme sphinx-panels
       - name: Build docs
         run: ./.github/jobs/build_documentation.sh
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         if: always()
         with:
           name: documentation
           path: artifact/documentation
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: documentation_warnings.log

diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -40,7 +40,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set job controls
         id: job_status
         run: .github/jobs/set_job_controls.sh
@@ -66,7 +66,7 @@ jobs:
     needs: job_control
     if: ${{ needs.job_control.outputs.run_compile == 'true' }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Create directories to store output
         run: mkdir -p ${RUNNER_WORKSPACE}/logs
@@ -92,7 +92,7 @@ jobs:
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -126,7 +126,7 @@ jobs:
           - 'pb2nc madis2nc pcp_combine'
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run Unit Tests in Docker
         run: .github/jobs/run_unit_docker.sh
@@ -136,14 +136,14 @@ jobs:
           INPUT_DATA_VERSION: ${{ needs.job_control.outputs.input_data_version }}-all
 
       - name: Upload output as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: unit_1a
           path: ${{ runner.workspace }}/output
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -161,7 +161,7 @@ jobs:
           - 'met_test_scripts mode_multivar mode_graphics mtd regrid airnow gsi_tools netcdf modis series_analysis gen_ens_prod wwmca_regrid gen_vx_mask grid_weight interp_shape grid_diag grib_tables lidar2nc shift_data_plane trmm2nc aeronet wwmca_plot ioda2nc gaussian'
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run Unit Tests in Docker
         run: .github/jobs/run_unit_docker.sh
@@ -171,14 +171,14 @@ jobs:
           INPUT_DATA_VERSION: ${{ needs.job_control.outputs.input_data_version }}-all
 
       - name: Upload output as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: unit_1b
           path: ${{ runner.workspace }}/output
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -197,7 +197,7 @@ jobs:
           - 'ref_config_lead_36'
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run Unit Tests in Docker
         run: .github/jobs/run_unit_docker.sh
@@ -207,14 +207,14 @@ jobs:
           INPUT_DATA_VERSION: ${{ needs.job_control.outputs.input_data_version }}-all
 
       - name: Upload output as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: unit_rc_leads
           path: ${{ runner.workspace }}/output
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -231,10 +231,10 @@ jobs:
           - 'ref_config'
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Download ref_config_leads output from artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: unit_rc_leads
           path: ${{ runner.workspace }}/output
@@ -247,14 +247,14 @@ jobs:
           INPUT_DATA_VERSION: 'none'
 
       - name: Upload output as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: unit_rc
           path: ${{ runner.workspace }}/output
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -274,10 +274,10 @@ jobs:
           - 'ensemble_stat stat_analysis_es'
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Download 1a output from artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: unit_1a
           path: ${{ runner.workspace }}/output
@@ -290,14 +290,14 @@ jobs:
           INPUT_DATA_VERSION: ${{ needs.job_control.outputs.input_data_version }}-all
 
       - name: Upload output as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: unit_2a
           path: ${{ runner.workspace }}/output
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -317,10 +317,10 @@ jobs:
           - 'python point2grid plot_data_plane mode mode_analysis perc_thresh hira plot_point_obs quality_filter obs_summary duplicate_flag'
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Download 1a output from artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: unit_1a
           path: ${{ runner.workspace }}/output
@@ -333,14 +333,14 @@ jobs:
           INPUT_DATA_VERSION: ${{ needs.job_control.outputs.input_data_version }}-all
 
       - name: Upload output as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: unit_2b
           path: ${{ runner.workspace }}/output
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -353,14 +353,14 @@ jobs:
     if: ${{ needs.job_control.outputs.run_diff == 'true' }}
     steps:
       - name: Download data from previous jobs
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
 
       - name: Copy test output into single directory
         run: |
           mkdir ${RUNNER_WORKSPACE}/output
           cp -r unit_*/* ${RUNNER_WORKSPACE}/output/
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run Diff Tests in Docker
         run: .github/jobs/run_diff_docker.sh
@@ -371,15 +371,15 @@ jobs:
 
       - name: Upload diff files as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: diff
           path: ${{ runner.workspace }}/diff
           if-no-files-found: ignore
 
       - name: Upload logs as artifact
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: logs
           path: ${{ runner.workspace }}/logs
@@ -391,10 +391,10 @@ jobs:
     needs: [job_control, unit_1b, unit_2a, unit_2b, unit_rc]
     if: ${{ needs.job_control.outputs.run_update_truth == 'true' }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Download data from previous jobs
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
 
       - name: Copy test output into single directory
         run: |

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
 ^^^^^^^^