per #1816, removed nmep_smooth, nbrhd_prob, and ensemble_flag diction…

…ary variables from EnsembleStat wrapper and added support for nc_orank_flag
dtcenter · Sep 20, 2022 · 4af5d05 · 4af5d05
1 parent c842514
commit 4af5d05
Show file tree

Hide file tree

Showing 6 changed files with 130 additions and 353 deletions.
diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst
@@ -5586,19 +5586,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 +5628,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 +5907,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` 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` 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` 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.
@@ -9937,3 +9891,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
diff --git a/docs/Users_Guide/wrappers.rst b/docs/Users_Guide/wrappers.rst
@@ -217,21 +217,12 @@ METplus Configuration
 | :term:`ENSEMBLE_STAT_DESC`
 | :term:`ENSEMBLE_STAT_ENS_SSVAR_BIN_SIZE`
 | :term:`ENSEMBLE_STAT_ENS_PHIST_BIN_SIZE`
-| :term:`ENSEMBLE_STAT_NBRHD_PROB_WIDTH`
-| :term:`ENSEMBLE_STAT_NBRHD_PROB_SHAPE`
-| :term:`ENSEMBLE_STAT_NBRHD_PROB_VLD_THRESH`
 | :term:`ENSEMBLE_STAT_CLIMO_CDF_BINS`
 | :term:`ENSEMBLE_STAT_CLIMO_CDF_CENTER_BINS`
 | :term:`ENSEMBLE_STAT_CLIMO_CDF_WRITE_BINS`
 | :term:`ENSEMBLE_STAT_CLIMO_CDF_DIRECT_PROB`
 | :term:`ENSEMBLE_STAT_DUPLICATE_FLAG`
 | :term:`ENSEMBLE_STAT_SKIP_CONST`
-| :term:`ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_DX`
-| :term:`ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_RADIUS`
-| :term:`ENSEMBLE_STAT_NMEP_SMOOTH_VLD_THRESH`
-| :term:`ENSEMBLE_STAT_NMEP_SMOOTH_SHAPE`
-| :term:`ENSEMBLE_STAT_NMEP_SMOOTH_METHOD`
-| :term:`ENSEMBLE_STAT_NMEP_SMOOTH_WIDTH`
 | :term:`ENSEMBLE_STAT_CENSOR_THRESH`
 | :term:`ENSEMBLE_STAT_CENSOR_VAL`
 | :term:`ENSEMBLE_STAT_DUPLICATE_FLAG`
@@ -286,20 +277,13 @@ METplus Configuration
 | :term:`ENSEMBLE_STAT_OUTPUT_FLAG_PJC`
 | :term:`ENSEMBLE_STAT_OUTPUT_FLAG_PRC`
 | :term:`ENSEMBLE_STAT_OUTPUT_FLAG_ECLV`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_LATLON`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MEAN`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_STDEV`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MINUS`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_PLUS`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MIN`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MAX`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_RANGE`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_VLD_COUNT`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_FREQUENCY`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_NEP`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_NMEP`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_RANK`
-| :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_WEIGHT`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_LATLON`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_MEAN`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_RAW`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_RANK`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_PIT`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_VLD_COUNT`
+| :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_WEIGHT`
 | :term:`ENSEMBLE_STAT_OBS_QUALITY_INC`
 | :term:`ENSEMBLE_STAT_OBS_QUALITY_EXC`
 | :term:`ENSEMBLE_STAT_MET_CONFIG_OVERRIDES`
@@ -494,42 +478,6 @@ see :ref:`How METplus controls MET config file settings<metplus-control-met>`.
 
 .. note:: For more information on controlling the forecast field attributes in METplus, please see the :ref:`Field_Info` section of the User's Guide.
 
-**${METPLUS_NBRHD_PROB_DICT}**
-
-.. list-table::
-   :widths: 5 5
-   :header-rows: 0
-
-   * - METplus Config(s)
-     - MET Config File
-   * - :term:`ENSEMBLE_STAT_NBRHD_PROB_WIDTH`
-     - nbrhd_prob.width
-   * - :term:`ENSEMBLE_STAT_NBRHD_PROB_SHAPE`
-     - nbrhd_prob.shape
-   * - :term:`ENSEMBLE_STAT_NBRHD_PROB_VLD_THRESH`
-     - nbrhd_prob.vld_thresh
-
-**${METPLUS_NMEP_SMOOTH_DICT}**
-
-.. list-table::
-   :widths: 5 5
-   :header-rows: 0
-
-   * - METplus Config(s)
-     - MET Config File
-   * - :term:`ENSEMBLE_STAT_NMEP_SMOOTH_VLD_THRESH`
-     - nmep_smooth.vld_thresh
-   * - :term:`ENSEMBLE_STAT_NMEP_SMOOTH_SHAPE`
-     - nmep_smooth.shape
-   * - :term:`ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_DX`
-     - nmep_smooth.gaussian_dx
-   * - :term:`ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_RADIUS`
-     - nmep_smooth.gaussian_radius
-   * - :term:`ENSEMBLE_STAT_NMEP_SMOOTH_METHOD`
-     - nmep_smooth.type.method
-   * - :term:`ENSEMBLE_STAT_NMEP_SMOOTH_WIDTH`
-     - nmep_smooth.type.width
-
 **${METPLUS_PROB_CAT_THRESH}**
 
 .. list-table::
@@ -862,42 +810,28 @@ see :ref:`How METplus controls MET config file settings<metplus-control-met>`.
    * - :term:`ENSEMBLE_STAT_OUTPUT_FLAG_ECLV`
      - output_flag.eclv
 
-**${METPLUS_ENSEMBLE_FLAG_DICT}**
+**${METPLUS_NC_ORANK_FLAG_DICT}**
 
 .. list-table::
    :widths: 5 5
    :header-rows: 0
 
    * - METplus Config(s)
      - MET Config File
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_LATLON`
-     - ensemble_flag.latlon
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MEAN`
-     - ensemble_flag.mean
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_STDEV`
-     - ensemble_flag.stdev
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MINUS`
-     - ensemble_flag.minus
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_PLUS`
-     - ensemble_flag.plus
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MIN`
-     - ensemble_flag.min
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_MAX`
-     - ensemble_flag.max
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_RANGE`
-     - ensemble_flag.range
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_VLD_COUNT`
-     - ensemble_flag.vld_count
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_FREQUENCY`
-     - ensemble_flag.frequency
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_NEP`
-     - ensemble_flag.nep
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_NMEP`
-     - ensemble_flag.nmep
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_RANK`
-     - ensemble_flag.rank
-   * - :term:`ENSEMBLE_STAT_ENSEMBLE_FLAG_WEIGHT`
-     - ensemble_flag.weight
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_LATLON`
+     - nc_orank_flag.latlon
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_MEAN`
+     - nc_orank_flag.mean
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_RAW`
+     - nc_orank_flag.raw
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_RANK`
+     - nc_orank_flag.rank
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_PIT`
+     - nc_orank_flag.pit
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_VLD_COUNT`
+     - nc_orank_flag.vld_count
+   * - :term:`ENSEMBLE_STAT_NC_ORANK_FLAG_WEIGHT`
+     - nc_orank_flag.weight
 
 **${METPLUS_OUTPUT_PREFIX}**