per #1816, rename use cases that run GenEnsProd instead of EnsembleSt…

…at, moved short_range use cases to be in alphabetical order
dtcenter · Sep 21, 2022 · a7ae338 · a7ae338
1 parent d5ddda6
commit a7ae338
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 76 deletions.
diff --git a/...nsembleStat_fcstHRRRE_FcstOnly_NetCDF.png → ...-GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.png b/...nsembleStat_fcstHRRRE_FcstOnly_NetCDF.png → ...-GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.png
diff --git a/...tat_fcstHRRR_fcstOnly_SurrogateSevere.png → ...rod_fcstHRRR_fcstOnly_SurrogateSevere.png b/...tat_fcstHRRR_fcstOnly_SurrogateSevere.png → ...rod_fcstHRRR_fcstOnly_SurrogateSevere.png
diff --git a/...EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.py → ...n/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py b/...EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.py → ...n/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.py
@@ -1,8 +1,8 @@
 """
-Ensemble-Stat: Basic Post-Processing only  
-================================================================
+Gen-Ens-Prod: Basic Post-Processing only
+========================================
 
-model_application/precipitation/EnsembleStat_fcstHRRRE
+model_application/precipitation/GenEnsProd_fcstHRRRE
 _FcstOnly_NetCDF.conf
 
 """
@@ -25,15 +25,15 @@
 # METplus Components
 # ------------------
 #
-# This use case runs Ensemble-Stat on HRRRE data from 3 members after
+# This use case runs gen_ens_prod on HRRRE data from 3 members after
 # running it through pcp_combine to create a 3 hour precipitation accumulation
 
 ###############################################################################
 # METplus Workflow
 # ----------------
 #
 # The following tools are used for each run time:
-# EnsembleStat
+# GenEnsProd
 #
 # This example loops by initialization time. For each initialization time
 # it will process forecast leads 3, 6, 9 and 12
@@ -70,12 +70,11 @@
 # METplus Configuration
 # ---------------------
 #
-# METplus first loads all of the configuration files found in parm/metplus_config,
+# METplus first loads all of the configurations found in parm/metplus_config,
 # then it loads any configuration files passed to METplus via the command line
-# with the -c option, i.e. -c parm/use_cases/model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf
 #
 # .. highlight:: bash
-# .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf
 
 ##############################################################################
 # MET Configuration
@@ -89,39 +88,19 @@
 # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to:
 # :ref:`Overriding Unsupported MET config file settings<met-config-overrides>`
 #
-# .. note:: See the :ref:`EnsembleStat MET Configuration<ens-stat-met-conf>` section of the User's Guide for more information on the environment variables used in the file below:
+# .. note:: See the :ref:`GenEnsProd MET Configuration<gen-ens-prod-met-conf>` section of the User's Guide for more information on the environment variables used in the file below:
 #
 # .. highlight:: bash
-# .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped
+# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped
 
 ##############################################################################
 # Running METplus
 # ---------------
 #
-# This use case can be run two ways:
+# The command to run this use case is::
 #
-# 1) Passing in EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf then a user-specific system configuration file::
+#    run_metplus.py /path/to/METplus/parm/use_cases/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf
 #
-#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf -c /path/to/user_system.conf
-#
-# 2) Modifying the configurations in parm/metplus_config, then passing in EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf::
-#
-#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf
-#
-# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
-#
-# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases
-# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions
-# * **MET_INSTALL_DIR** - Path to location where MET is installed locally
-#
-# Example User Configuration File::
-#
-#   [dir]
-#   INPUT_BASE = /path/to/sample/input/data
-#   OUTPUT_BASE = /path/to/output/dir
-#   MET_INSTALL_DIR = /path/to/met-X.Y 
-#
-# **NOTE:** All of these items must be found under the [dir] section.
 #
 
 ##############################################################################
@@ -133,22 +112,22 @@
 #   INFO: METplus has successfully finished running.
 #
 # Refer to the value set for **OUTPUT_BASE** to find where the output data was generated.
-# Output for this use case will be found in model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF/EnsembleStat (relative to **OUTPUT_BASE**)
+# Output for this use case will be found in model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF/GenEnsProd (relative to **OUTPUT_BASE**)
 # The following folder/file combination will be created:
 #
 # -201905191200
 #
-# * ensemble_stat_APCP_03_20190519_150000V_ens.nc
-# * ensemble_stat_APCP_03_20190519_180000V_ens.nc
-# * ensemble_stat_APCP_03_20190519_210000V_ens.nc
-# * ensemble_stat_APCP_03_20190520_000000V_ens.nc
+# * gen_ens_prod_APCP_03_20190519_150000V_ens.nc
+# * gen_ens_prod_APCP_03_20190519_180000V_ens.nc
+# * gen_ens_prod_APCP_03_20190519_210000V_ens.nc
+# * gen_ens_prod_APCP_03_20190520_000000V_ens.nc
 #
 # -201905200000
 #
-# * ensemble_stat_APCP_03_20190520_030000V_ens.nc
-# * ensemble_stat_APCP_03_20190520_060000V_ens.nc
-# * ensemble_stat_APCP_03_20190520_090000V_ens.nc
-# * ensemble_stat_APCP_03_20190520_120000V_ens.nc
+# * gen_ens_prod_APCP_03_20190520_030000V_ens.nc
+# * gen_ens_prod_APCP_03_20190520_060000V_ens.nc
+# * gen_ens_prod_APCP_03_20190520_090000V_ens.nc
+# * gen_ens_prod_APCP_03_20190520_120000V_ens.nc
 
 
 ##############################################################################
@@ -157,7 +136,7 @@
 #
 # .. note::
 #
-#   * EnsembleStatToolUseCase
+#   * GenEnsProdToolUseCase
 #   * NOAAHWTOrgUseCase
 #   * PrecipitationAppUseCase
 #   * NetCDFFileUseCase
@@ -170,5 +149,5 @@
 #
 #
 #
-# sphinx_gallery_thumbnail_path = '_static/precipitation-EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.png'
+# sphinx_gallery_thumbnail_path = '_static/precipitation-GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.png'
 #
diff --git a/...Stat_fcstHRRR_fcstOnly_SurrogateSevere.py → ...Prod_fcstHRRR_fcstOnly_SurrogateSevere.py b/...Stat_fcstHRRR_fcstOnly_SurrogateSevere.py → ...Prod_fcstHRRR_fcstOnly_SurrogateSevere.py
@@ -1,18 +1,18 @@
 """
-Surrogate Severe Calculation: PCPCombine, EnsembleStat, and RegridDataPlane 
-===================================================================================================
+Surrogate Severe Calculation: PCPCombine, GenEnsProd, and RegridDataPlane
+=========================================================================
 
 model_applications/
 short_range/
-EnsembleStat_fcstHRRR_fcstOnly
+GenEnsProd_fcstHRRR_fcstOnly
 _SurrogateSevere.conf
 
 """
 ###################################################################################################
 # Scientific Objective
 # --------------------
 #
-# Run PCPCombine, EnsembleStat, and RegridDataPlane tools to create surrogate severe probability 
+# Run PCPCombine, GenEnsProd, and RegridDataPlane tools to create surrogate severe probability
 # forecasts (SSPFs) for a given date. SSPFs are a severe weather forecasting tool and is a techniqu
 # used by the Storm Prediction Center (SPC) as well as others. SSPFs are based on updraft helicity 
 # (UH; UH = ∫z0 to zt (ω * ζ) dz) since certain thresholds of UH have been shown as good proxies for# severe weather. SSPFs can be thought of as the perfect model forecast. They are derived as follows:
@@ -44,25 +44,25 @@
 # METplus Components
 # ------------------
 #
-# This use case runs the PCPCombine, EnsembleStat, and RegridDataPlane MET tools.
+# This use case runs the PCPCombine, GenEnsProd, and RegridDataPlane MET tools.
 
 ###################################################################################################
 # METplus Workflow
 # ----------------
 #
 # This workflow loops over the data by process, meaning that each MET tool will run over all times
-# before moving onto the tool. PCPCombine is called first, followed by EnsembleStat,
+# before moving onto the tool. PCPCombine is called first, followed by GenEnsProd,
 # and then, finally, RegridDataPlane.
 
 ###################################################################################################
 # METplus Configuration
 # ---------------------
 #
-# METplus first loads all of the configuration files found in parm/metplus_config. Then, it loads
-# any configuration files passed to METplus by the command line with the -c option.
+# METplus first loads all of the configurations found in parm/metplus_config.
+# Then it loads any configuration files passed to METplus by the command line.
 #
 # .. highlight:: bash
-# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRR_fcstOnly_SurrogateSevere.conf
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf
 
 ###################################################################################################
 # MET Configuration
@@ -76,18 +76,18 @@
 # If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to:
 # :ref:`Overriding Unsupported MET config file settings<met-config-overrides>`
 #
-# .. note:: See the :ref:`EnsembleStat MET Configuration<ens-stat-met-conf>` section of the User's Guide for more information on the environment variables used in the file below:
+# .. note:: See the :ref:`GenEnsProd MET Configuration<gen-ens-prod-met-conf>` section of the User's Guide for more information on the environment variables used in the file below:
 #
 # .. highlight:: bash
-# .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped
+# .. literalinclude:: ../../../../parm/met_config/GenEnsProdConfig_wrapped
 
 ###################################################################################################
 # Running METplus
 # ---------------
 #
 # The command to run this use case is::
 #
-#    run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/EnsembleStat_fcstHRRR_fcstOnly_SurrogateSevere.conf
+#    run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf
 
 ###################################################################################################
 # Expected Output
@@ -105,9 +105,9 @@
 #
 # * 20190518/hrrr_ncep_2019051800f036.nc
 #
-# **EnsembleStat output**:
+# **GenEnsProd output**:
 #
-# * ensemble_stat_20190519_120000V_ens.nc
+# * gen_ens_prod_20190519_120000V_ens.nc
 #
 # **RegridDataPlane output**:
 # 
@@ -121,12 +121,12 @@
 # .. note::
 #
 #   * PCPCombineUseCase
-#   * EnsembleStatUseCase
+#   * GenEnsProdUseCase
 #   * RegridDataPlaneUseCase
 #
 #   Navigate to the :ref:`quick-search` page to discover other similar use cases.
 #
 #
 #
-# sphinx_gallery_thumbnail_path = '_static/short_range-EnsembleStat_fcstHRRR_fcstOnly_SurrogateSevere.png'
+# sphinx_gallery_thumbnail_path = '_static/short_range-GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.png'
 #
diff --git a/internal_tests/use_cases/all_use_cases.txt b/internal_tests/use_cases/all_use_cases.txt
@@ -71,19 +71,6 @@ Category: climate
 1::MODE_fcstCESM_obsGPCP_AsianMonsoonPrecip::model_applications/climate/MODE_fcstCESM_obsGPCP_AsianMonsoonPrecip.conf
 
 
-Category: short_range
-0::EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField::model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf
-1::MODE_fcstHRRR_obsMRMS_Hail_GRIB2::model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf
-2::EnsembleStat_fcstHRRR_fcstOnly_SurrogateSevere::model_applications/short_range/EnsembleStat_fcstHRRR_fcstOnly_SurrogateSevere.conf
-3::GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere::model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf
-4::GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb::model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf
-5::Point2Grid_obsLSR_ObsOnly_PracticallyPerfect::model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf
-6::GridStat_fcstFV3_obsGOES_BrightnessTempDmap:: model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf
-7::MODE_fcstFV3_obsGOES_BrightnessTemp::model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf,model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp/ci_overrides.conf
-8::MODE_fcstFV3_obsGOES_BrightnessTempObjs:: model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf
-9::METdbLoad_fcstFV3_obsGoes_BrightnessTemp::model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf:: metdataio_env,metviewer
-
-
 Category: data_assimilation
 0::StatAnalysis_fcstHAFS_obsPrepBufr_JEDI_IODA_interface::model_applications/data_assimilation/StatAnalysis_fcstHAFS_obsPrepBufr_JEDI_IODA_interface.conf
 
@@ -113,7 +100,7 @@ Category: medium_range
 
 
 Category: precipitation
-0::EnsembleStat_fcstHRRRE_FcstOnly_NetCDF:: model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.conf
+0::GenEnsProd_fcstHRRRE_FcstOnly_NetCDF:: model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf
 1::GridStat_fcstHREFmean_obsStgIV_Gempak:: model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_Gempak.conf:: gempak_env
 2::GridStat_fcstHREFmean_obsStgIV_NetCDF:: model_applications/precipitation/GridStat_fcstHREFmean_obsStgIV_NetCDF.conf
 3::GridStat_fcstGFS_obsCCPA_GRIB:: model_applications/precipitation/GridStat_fcstGFS_obsCCPA_GRIB.conf
@@ -149,6 +136,19 @@ Category: s2s_mjo
 4:: UserScript_obsCFSR_obsOnly_MJO_ENSO:: model_applications/s2s_mjo/UserScript_obsCFSR_obsOnly_MJO_ENSO.conf:: spacetime_env, metdataio
 
 
+Category: short_range
+0::EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField::model_applications/short_range/EnsembleStat_fcstHRRRE_obsHRRRE_Sfc_MultiField.conf
+1::MODE_fcstHRRR_obsMRMS_Hail_GRIB2::model_applications/short_range/MODE_fcstHRRR_obsMRMS_Hail_GRIB2.conf
+2::GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere::model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.conf
+3::GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere::model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevere.conf
+4::GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb::model_applications/short_range/GridStat_fcstHRRR_obsPracPerfect_SurrogateSevereProb.conf
+5::Point2Grid_obsLSR_ObsOnly_PracticallyPerfect::model_applications/short_range/Point2Grid_obsLSR_ObsOnly_PracticallyPerfect.conf
+6::GridStat_fcstFV3_obsGOES_BrightnessTempDmap:: model_applications/short_range/GridStat_fcstFV3_obsGOES_BrightnessTempDmap.conf
+7::MODE_fcstFV3_obsGOES_BrightnessTemp::model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf,model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp/ci_overrides.conf
+8::MODE_fcstFV3_obsGOES_BrightnessTempObjs:: model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf
+9::METdbLoad_fcstFV3_obsGoes_BrightnessTemp::model_applications/short_range/METdbLoad_fcstFV3_obsGoes_BrightnessTemp.conf:: metdataio_env,metviewer
+
+
 Category: space_weather
 0::GridStat_fcstGloTEC_obsGloTEC_vx7:: model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf
 1::GenVxMask_fcstGloTEC_FcstOnly_solar_altitude:: model_applications/space_weather/GenVxMask_fcstGloTEC_FcstOnly_solar_altitude.conf

diff --git a/...sembleStat_fcstHRRRE_FcstOnly_NetCDF.conf → ...GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf b/...sembleStat_fcstHRRRE_FcstOnly_NetCDF.conf → ...GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.conf
@@ -1,7 +1,7 @@
 [config]
 
 # Documentation for this use case can be found at
-# https://metplus.readthedocs.io/en/latest/generated/model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF.html
+# https://metplus.readthedocs.io/en/latest/generated/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF.html
 
 # For additional information, please see the METplus Users Guide.
 # https://metplus.readthedocs.io/en/latest/Users_Guide
@@ -44,7 +44,7 @@ LOOP_ORDER = processes
 GEN_ENS_PROD_INPUT_DIR = {INPUT_BASE}/model_applications/precipitation/HRRRE/pcp_combine
 GEN_ENS_PROD_INPUT_TEMPLATE = hrrrebegin_end_incr(1,3,1,2)_{init?fmt=%Y%m%d%H}f{lead?fmt=%HHH}_A03.nc
 
-GEN_ENS_PROD_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/precipitation/EnsembleStat_fcstHRRRE_FcstOnly_NetCDF/EnsembleStat
+GEN_ENS_PROD_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/precipitation/GenEnsProd_fcstHRRRE_FcstOnly_NetCDF/GenEnsProd
 GEN_ENS_PROD_OUTPUT_TEMPLATE = {init?fmt=%Y%m%d%H%M}/gen_ens_prod_{ENS_VAR1_NAME}_{valid?fmt=%Y%m%d_%H%M%S}V_ens.nc
 
 

diff --git a/...at_fcstHRRR_fcstOnly_SurrogateSevere.conf → ...od_fcstHRRR_fcstOnly_SurrogateSevere.conf b/...at_fcstHRRR_fcstOnly_SurrogateSevere.conf → ...od_fcstHRRR_fcstOnly_SurrogateSevere.conf
@@ -1,7 +1,7 @@
 [config]
 
 # Documentation for this use case can be found at
-# https://metplus.readthedocs.io/en/latest/generated/model_applications/short_range/EnsembleStat_fcstHRRR_fcstOnly_SurrogateSevere.html
+# https://metplus.readthedocs.io/en/latest/generated/model_applications/short_range/GenEnsProd_fcstHRRR_fcstOnly_SurrogateSevere.html
 
 # For additional information, please see the METplus Users Guide.
 # https://metplus.readthedocs.io/en/latest/Users_Guide