feature 1684 use case HSS s2s

.github/parm/use_case_groups.json

@@ -179,6 +179,11 @@
     "index_list": "13",
     "run": false
   },
+  {
+    "category": "s2s",
+    "index_list": "14",
+    "run": false
+  },
   {
     "category": "space_weather",
     "index_list": "0-1",

docs/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.py

@@ -0,0 +1,144 @@
+"""
+GridStat: Determine dominant ensemble members terciles and calculate categorical outputs
+========================================================================================
+
+model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+# This use case ingests a CFSv2 Ensemble forecast, with all ensemble members in a single file for a given year. 
+# 29 years of forecast ensembles are used to create probabilities for each tercile, which is accomplished by a Python script. 
+# Of the terciles, each gridpoint is assigned a value corresponding to the tercile that is most likely to occur. This is compared to an observation set
+# that contains the tercile data and MCTS line type is requested.
+# This use case highlights the inclusion of tercile data for calculating HSS; in particular, how to utilize the hss_ec_value option to 
+# preset the expected values rather than relying on categorical values.
+
+##############################################################################
+# Datasets
+# ---------------------
+#
+# | **Forecast:** 29 CFSv2 Ensemble files, 2m temperature fields
+#
+# | **Observations:** GHCNCAMS, 2m temperature field
+#
+#
+# | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases
+# | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
+#
+# | **Data Source:** CPC
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case calls a Python script 29 times, once for each year of data of the CFSv2 ensemble.
+# Each time a successful call to the script is made, a grid of 1s, 2s, and 3s is returned, representing which tercile was dominant for the gridpoint.
+# GridStat processes the forecast and observation fields, and outputs the requested line types.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# This use case utilizes 29 years of forecast data, with 24 members in each ensemble forecast.
+# The following boundary times are used for the entire script:
+#
+# | **Init Beg:** 1982-01-01
+# | **Init End:** 2010-01-02
+# 
+# Because the increment is 1 year, all January 1st from 1982 to 2010 are processed for a total of 29 years.
+# 
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all of the configuration files found in parm/metplus_config,
+# then it loads any configuration files passed to METplus via the command line
+# i.e. -c parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf
+#
+
+##############################################################################
+# MET Configuration
+# ---------------------
+#
+# METplus sets environment variables based on the values in the METplus configuration file. These variables are referenced in the MET configuration file. **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!** If there is a setting in the MET configuration file that is not controlled by an environment variable, you can add additional environment variables to be set only within the METplus environment using the [user_env_vars] section of the METplus configuration files. See the ‘User Defined Config’ section on the ‘System Configuration’ page of the METplus User’s Guide for more information.
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped
+#
+
+##############################################################################
+# Running METplus
+# ---------------
+#
+# This use case can be run two ways:
+#
+# 1) Passing in GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf then a user-specific system configuration file::
+#
+#        run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile /path/to/user_system.conf
+#
+# 2) Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile::
+#
+#        run_metplus.py /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.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::
+#
+#   [config]
+#   INPUT_BASE = /path/to/sample/input/data
+#   OUTPUT_BASE = /path/to/output/dir
+#   MET_INSTALL_DIR = /path/to/met-X.Y 
+#
+#
+
+##############################################################################
+# Expected Output
+# ---------------
+#
+# A successful run will output the following both to the screen and to the logfile::
+#
+#   INFO: METplus has successfully finished running.
+#
+# Refer to the value set for **OUTPUT_BASE** to find where the output data was generated.
+# Output for the use case will be found in 29 folders(relative to **OUTPUT_BASE**).
+# The output will follow the time information of the run. Specifically:
+#
+# * YYYY01
+#
+# where YYYY will be replaced by values corresponding to each of the years (1982 through 2010).
+# Each of those folders will have the following files:
+#
+# * grid_stat_000000L_19820101_000000V_pairs.nc
+# * grid_stat_000000L_19820101_000000V_mctc.txt
+# * grid_stat_000000L_19820101_000000V_mcts.txt
+# * grid_stat_000000L_19820101_000000V.stat
+#
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * GridStatUseCase
+#   * ProbabilityVerificationUseCase
+#   * PythonEmbeddingFileUseCase
+#   * S2SAppUseCase
+#   * NETCDFFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
+# sphinx_gallery_thumbnail_path = '_static/s2s-GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.png'
+

internal_tests/use_cases/all_use_cases.txt

@@ -138,6 +138,7 @@ Category: s2s
 11:: UserScript_fcstGFS_obsERA_WeatherRegime:: model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.conf:: weatherregime_env,cartopy,metplus
 12:: UserScript_obsERA_obsOnly_Stratosphere:: model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.conf:: metplotpy_env,metdatadb
 13::SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool:: model_applications/s2s/SeriesAnalysis_fcstCFSv2_obsGHCNCAMS_climoStandardized_MultiStatisticTool.conf:: netcdf4_env
+14::GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile:: model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf:: netcdf4_env
 
 Category: space_weather
 0::GridStat_fcstGloTEC_obsGloTEC_vx7:: model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf

parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf

@@ -0,0 +1,102 @@
+[config]
+
+PROCESS_LIST = GridStat
+
+###
+# Time Info
+###
+
+LOOP_BY = INIT
+INIT_TIME_FMT = %Y%m%d%H
+INIT_BEG=1982010100
+INIT_END=2010020100
+INIT_INCREMENT = 1Y
+
+LEAD_SEQ =
+
+LOOP_ORDER = processes
+
+###
+# File I/O
+###
+
+
+FCST_GRID_STAT_INPUT_TEMPLATE = PYTHON_NUMPY
+
+OBS_GRID_STAT_INPUT_TEMPLATE = PYTHON_NUMPY
+
+GRID_STAT_CLIMO_MEAN_INPUT_DIR =
+GRID_STAT_CLIMO_MEAN_INPUT_TEMPLATE =
+
+GRID_STAT_CLIMO_STDEV_INPUT_DIR =
+GRID_STAT_CLIMO_STDEV_INPUT_TEMPLATE =
+
+GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/HSS_out_Mplus
+GRID_STAT_OUTPUT_TEMPLATE = {init?fmt=%Y%m}
+
+
+###
+# Field Info
+###
+
+MODEL = CFSv2
+OBTYPE = OBS
+
+FCST_VAR1_NAME = {CONFIG_DIR}/forecast_read-in_CFSv2_categoricalthresholds.py {INPUT_BASE}/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile/CFSv2.tmp2m.{init?fmt=%Y%m}.fcst.nc:tmp2m:{init?fmt=%Y%m%d%H}:0:0
+FCST_VAR1_LEVELS = 
+FCST_VAR1_THRESH = lt1.5, lt2.5
+
+OBS_VAR1_NAME = {CONFIG_DIR}/forecast_read-in_CFSv2_categoricalthresholds_obs.py {INPUT_BASE}/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile/CFSv2.tmp2m.{init?fmt=%Y%m}.fcst.nc:tmp2m:{init?fmt=%Y%m%d%H}:0:0
+OBS_VAR1_LEVELS = 
+OBS_VAR1_THRESH = lt1.5, lt2.5
+
+CONFIG_DIR = {PARM_BASE}/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile
+
+###
+# GridStat
+###
+
+
+
+GRID_STAT_CONFIG_FILE = {PARM_BASE}/met_config/GridStatConfig_wrapped
+
+
+GRID_STAT_REGRID_TO_GRID = FCST
+
+
+GRID_STAT_DESC = NA
+
+FCST_GRID_STAT_FILE_WINDOW_BEGIN = 0
+FCST_GRID_STAT_FILE_WINDOW_END = 0
+OBS_GRID_STAT_FILE_WINDOW_BEGIN = 0
+OBS_GRID_STAT_FILE_WINDOW_END = 0
+
+GRID_STAT_NEIGHBORHOOD_WIDTH = 1
+GRID_STAT_NEIGHBORHOOD_SHAPE = SQUARE
+
+GRID_STAT_NEIGHBORHOOD_COV_THRESH = >=0.5
+
+GRID_STAT_ONCE_PER_FIELD = False
+
+FCST_IS_PROB = false
+
+FCST_GRID_STAT_PROB_THRESH = ==0.1
+
+OBS_IS_PROB = false
+
+OBS_GRID_STAT_PROB_THRESH = ==0.1
+
+GRID_STAT_OUTPUT_PREFIX = 
+
+
+
+GRID_STAT_OUTPUT_FLAG_MCTC = BOTH
+GRID_STAT_OUTPUT_FLAG_MCTS = BOTH
+
+GRID_STAT_NC_PAIRS_FLAG_LATLON = TRUE
+GRID_STAT_NC_PAIRS_FLAG_RAW = TRUE
+GRID_STAT_NC_PAIRS_FLAG_DIFF = TRUE
+
+
+GRID_STAT_HSS_EC_VALUE = 
+