Feature #1816 ensemble vx removal from EnsembleStat (#1820)

Co-authored-by: John Halley Gotway <[email protected]>
dtcenter · Sep 21, 2022 · eac157d · eac157d
1 parent 728707c
commit eac157d
Show file tree

Hide file tree

Showing 14 changed files with 461 additions and 771 deletions.
diff --git a/.github/parm/use_case_groups.json b/.github/parm/use_case_groups.json
@@ -117,7 +117,7 @@
   {
     "category": "precipitation",
     "index_list": "3-7",
-    "run": false
+    "run": true
   },
   {
     "category": "precipitation",

diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -85,7 +85,7 @@ jobs:
           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
           EXTERNAL_TRIGGER: ${{ needs.job_control.outputs.external_trigger }}
-          #MET_FORCE_TAG: 10.0.0
+          #MET_FORCE_TAG: 10.1.0
 
   update_data_volumes:
     name: Docker Setup - Update Data Volumes
@@ -109,7 +109,7 @@ jobs:
     name: Use Case Tests
     runs-on: ubuntu-latest
     needs: [get_image, update_data_volumes, job_control]
-    if: ${{ always() && needs.job_control.outputs.run_some_tests == 'true' }}
+    if: ${{ needs.job_control.outputs.run_some_tests == 'true' }}
     strategy:
       fail-fast: false
       matrix: ${{fromJson(needs.job_control.outputs.matrix)}}

diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst
@@ -984,12 +984,18 @@ METplus Configuration Glossary
      | *Used by:*  EnsembleStat
 
    ENSEMBLE_STAT_ENS_VLD_THRESH
+     .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_VLD_THRESH` instead.
+
+   ENSEMBLE_STAT_VLD_THRESH
      Threshold for the ratio of the number of valid data values to the total number of expected ensemble members. This value is passed into the ensemble_stat config file to make sure the percentage of files that are valid meets the expectation.
 
      | *Used by:*  EnsembleStat
 
    ENSEMBLE_STAT_ENS_OBS_THRESH
-     Sets the ens.obs_thresh value in the ensemble_stat MET config file.
+     .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_OBS_THRESH`.
+
+   ENSEMBLE_STAT_OBS_THRESH
+     Sets the obs_thresh value in the ensemble_stat MET config file.
 
      | *Used by:*  EnsembleStat
 
@@ -5586,19 +5592,13 @@ METplus Configuration Glossary
      | *Used by:*  EnsembleStat
 
    ENSEMBLE_STAT_NBRHD_PROB_WIDTH
-     Specify the value for 'nbrhd_prob.width' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NBRHD_PROB_WIDTH` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NBRHD_PROB_SHAPE
-     Specify the value for 'nbrhd_prob.shape' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NBRHD_PROB_SHAPE` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NBRHD_PROB_VLD_THRESH
-     Specify the value for 'nbrhd_prob.vld_thresh' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NBRHD_PROB_VLD_THRESH` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_CLIMO_CDF_CDF_BINS
      See :term:`ENSEMBLE_STAT_CLIMO_CDF_BINS`
@@ -5634,34 +5634,22 @@ METplus Configuration Glossary
      | *Used by:*  EnsembleStat
 
    ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_DX
-     Specify the value for 'nmep_smooth.gaussian_dx' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NMEP_SMOOTH_GAUSSIAN_DX` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_RADIUS
-     Specify the value for 'nmep_smooth.gaussian_radius' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NMEP_SMOOTH_GAUSSIAN_RADIUS` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NMEP_SMOOTH_VLD_THRESH
-     Specify the value for 'nmep_smooth.vld_thresh' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NMEP_SMOOTH_VLD_THRESH` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NMEP_SMOOTH_SHAPE
-     Specify the value for 'nmep_smooth.shape' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NMEP_SMOOTH_SHAPE` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NMEP_SMOOTH_METHOD
-     Specify the value for 'nmep_smooth.type.method' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NMEP_SMOOTH_METHOD` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_NMEP_SMOOTH_WIDTH
-     Specify the value for 'nmep_smooth.type.width' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_NMEP_SMOOTH_WIDTH` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_CENSOR_THRESH
      Specify the value for 'censor_thresh' in the MET configuration file for EnsembleStat.
@@ -5925,74 +5913,46 @@ METplus Configuration Glossary
      | *Used by:* EnsembleStat
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_LATLON
-     Specify the value for 'ensemble_flag.latlon' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_LATLON` or :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_LATLON` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_MEAN
-     Specify the value for 'ensemble_flag.mean' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_MEAN` or :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_MEAN` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_STDEV
-     Specify the value for 'ensemble_flag.stdev' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_STDEV` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_MINUS
-     Specify the value for 'ensemble_flag.minus' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_MINUS` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_PLUS
-     Specify the value for 'ensemble_flag.plus' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_PLUS` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_MIN
-     Specify the value for 'ensemble_flag.min' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_MIN` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_MAX
-     Specify the value for 'ensemble_flag.max' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_MAX` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_RANGE
-     Specify the value for 'ensemble_flag.range' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_RANGE` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_VLD_COUNT
-     Specify the value for 'ensemble_flag.vld_count' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_VLD_COUNT` or :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_VLD_COUNT` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_FREQUENCY
-     Specify the value for 'ensemble_flag.frequency' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_FREQUENCY` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_NEP
-     Specify the value for 'ensemble_flag.nep' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_NEP` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_NMEP
-     Specify the value for 'ensemble_flag.nmep' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_ENSEMBLE_FLAG_NMEP` in :ref:`gen_ens_prod_wrapper` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_RANK
-     Specify the value for 'ensemble_flag.rank' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_RANK` instead.
 
    ENSEMBLE_STAT_ENSEMBLE_FLAG_WEIGHT
-     Specify the value for 'ensemble_flag.weight' in the MET configuration file for EnsembleStat.
-
-     | *Used by:*  EnsembleStat
+          .. warning:: **DEPRECATED:** Please use :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_WEIGHT` instead.
 
    GRID_STAT_MASK_GRID
      Specify the value for 'mask.grid' in the MET configuration file for GridStat.
@@ -6358,9 +6318,12 @@ METplus Configuration Glossary
      | *Used by:*  TCpairs
 
    ENS_ENSEMBLE_STAT_INPUT_DATATYPE
-     Set the file_type entry of the ens dictionary in the MET config file for EnsembleStat.
+          .. warning:: **DEPRECATED:** Please use :term:`GEN_ENS_PROD_INPUT_DATATYPE` in :ref:`gen_ens_prod_wrapper` instead.
 
-     | *Used by:*  EnsembleStat
+   GEN_ENS_PROD_INPUT_DATATYPE
+     Set the file_type entry of the ens dictionary in the MET config file for GenEnsProd.
+
+     | *Used by:*  GenEnsProd
 
    FCST_SERIES_ANALYSIS_INPUT_DATATYPE
      Set the file_type entry of the fcst dictionary in the MET config file for SeriesAnalysis.
@@ -9224,7 +9187,7 @@ METplus Configuration Glossary
      it will automatically be removed by the wrapper to prevent an error in the
      MET tool. This may require adjusting the value for
      :term:`ENSEMBLE_STAT_N_MEMBERS` and/or
-     :term:`ENSEMBLE_STAT_ENS_VLD_THRESH`.
+     :term:`ENSEMBLE_STAT_VLD_THRESH`.
 
      | *Used by:*  EnsembleStat
 
@@ -9937,3 +9900,38 @@ METplus Configuration Glossary
      See :ref:`Overriding Unsupported MET config file settings<met-config-overrides>` for more information
 
      | *Used by:* PlotPointObs
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_LATLON
+     Specify the value for 'nc_orank_flag.latlon' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_MEAN
+     Specify the value for 'nc_orank_flag.mean' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_RAW
+     Specify the value for 'nc_orank_flag.raw' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_RANK
+     Specify the value for 'nc_orank_flag.rank' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_PIT
+     Specify the value for 'nc_orank_flag.pit' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_VLD_COUNT
+     Specify the value for 'nc_orank_flag.vld_count' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat
+
+   ENSEMBLE_STAT_NC_ORANK_FLAG_WEIGHT
+     Specify the value for 'nc_orank_flag.weight' in the MET configuration file for EnsembleStat.
+
+     | *Used by:* EnsembleStat