Feature 2406 redo usecase rrfs (#2488)

* issue #2406 RRFS use case files

* issue #2406 added usecase to tests

* Issue #2406 added metplotpy and metcalcpy as dependencies

.github/parm/use_case_groups.json

@@ -61,12 +61,12 @@
   },
   {
     "category": "marine_and_cryosphere",
-    "index_list": "0-1",
+    "index_list": "0-2",
     "run": false
   },
   {
     "category": "marine_and_cryosphere",
-    "index_list": "2-5",
+    "index_list": "3-5",
     "run": false
   },
   {
@@ -264,6 +264,11 @@
     "index_list": "13",
     "run": false
   },
+  {
+    "category": "short_range",
+    "index_list": "14",
+    "run": false
+  },
   {
     "category": "space_weather",
     "index_list": "0-1",

docs/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py

@@ -0,0 +1,255 @@
+"""
+UserScript: Reformat MET .stat ECNT data, calculate aggregation statistics, and generate a spread skill plot
+======================================================================================================================
+
+model_applications/
+short_range/
+UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot_ecnt_spread_skill.py
+
+"""
+
+#################################################################################
+# Scientific Objective
+# --------------------
+#
+# This use case illustrates how to use MET .stat output (using the ECNT linetype data) to generate a
+# spread skill plot using a subset of the METplus Analysis Tools (METdataio, METcalcpy,
+# and METplotpy). The METdataio METreformat module extracts the ECNT linetype data and
+# performs reformatting, the METcalcpy agg-stat module performs aggregation, and the
+# METplotpy line plot is used to generate the spread skill plot.
+#
+
+#################################################################################
+# Datasets
+# --------
+#
+#  * Forecast dataset: RRFS GEFS (Rapid Refresh Forecast System Global Ensemble Forecast System)
+#  * Observation dataset: None
+#
+#  **Input**: MET .stat files from MET ensemble-stat tool for RRFS for 20220506
+#
+#  **Location**: All the input data required for this use case can be found in the met_test sample data tarball
+#  (**sample_data-short_range.tgz**).
+#
+#  Click here to see the METplus releases page and download sample data for the appropriate
+#  release: https://github.com/dtcenter/METplus/releases
+#
+#  See `Running METplus <https://metplus.readthedocs.io/en/develop/Users_Guide/getting_started.html#running-metplus>`_
+#  section for more information.
+#
+#  **This tarball should be unpacked into the directory corresponding to the value of INPUT_BASE** in the
+#  `User Configuration File <https://metplus.readthedocs.io/en/develop/Users_Guide/systemconfiguration.html#user-configuration-file>`_
+#  section.
+#
+
+#############################################################################
+# External Dependencies
+# ---------------------
+# You will need to use the version of Python that is required for the METplus version
+# in use.  Refer to the Installation section of the User's Guide for basic Python requirements:
+# https://metplus.readthedocs.io/en/latest/Users_Guide/installation.html
+#
+# The METplus Analysis tools: METdataio, METcalcpy, and METplotpy have the additional third-party
+# Python package requirements.  The version numbers are found in the requirements.txt file found at the
+# top-level directory of each repository.
+#
+#  * lxml
+#  * pandas
+#  * pyyaml
+#  * numpy
+#  * netcdf4
+#  * xarray
+#  * scipy
+#  * metpy
+#  * pint
+#  * python-dateutil
+#  * kaleido (python-kaleido)
+#  * plotly
+#  * matplotlib
+
+
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case runs the UserScript wrapper tool to run a user provided script, 
+# in this case, reformat_ecnt_linetype.py, agg_stat_ecnt.py and plot_spread_skill.py.
+# It also requires the METdataio, METcalcpy and METplotpy source code to reformat the MET .stat output,
+# perform aggregation, and generate the plot. Clone the METdataio repository
+# (https://github.com/dtcenter/METdataio),
+# METcalcpy repository (https://github.com/dtcenter/METcalcpy, and the METplotpy
+# repository (https://github.com/dtcenter/METplotpy) under the same base directory as the
+# METPLUS_BASE directory so that the METdataio, METcalcpy, and METplotpy directories are under the
+# same base directory (i.e. if the METPLUS_BASE directory is /home/username/working/METplus,
+# then clone the METdataio, METcalcpy and METplotpy source code into the /home/username/working directory)
+#
+# Clone the METdataio, METcalcpy, and METplotpy source code from their repositories under a base directory. The
+# repositories are located:
+#
+#   *  https://github.com/dtcenter/METdataio
+#   *  https://github.com/dtcenter/METcalcpy
+#   *  https://github.com/dtcenter/METplotpy
+#
+#
+#
+# Define the OUTPUT_BASE, INPUT_BASE, and MET_INSTALL_DIR settings in the user
+# configuration file. For instructions on how to set up the user configuration file, refer to the `User ConfigurationFile
+# <https://metplus.readthedocs.io/en/develop/Users_Guide/systemconfiguration.html#user-configuration-file>`_ section.
+#
+
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# This use case reads in the MET .stat output that contains the ECNT linetype (from
+# the MET ensemble-stat tool).  The .stat output *MUST* reside under one directory.
+# If .stat files are spread among multiple directories, these must be consolidated under a
+# single directory.
+# The use case loops over three processes: reformatting, aggregating, and plotting.
+#
+
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all the configuration files 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/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf
+#
+
+#############################################################################
+# MET Configuration
+# ---------------------
+#
+# There are no MET tools used in this use case. The use case uses MET .stat
+# output as input for the reformatting step.
+#
+
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# There is no python embedding in this use case
+#
+
+##############################################################################
+# Python Scripts
+# ----------------
+# This use case uses Python scripts to invoke the METdataio reformatter, the METcalcpy aggregator, and the METplotpy
+# line plot.
+#
+# The following Python script (from METdataio) is used to reformat the MET .stat ECNT linetype data
+# into a format that can be used by the aggregating script.
+#
+# .. highlight:: python
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/reformat_ecnt_linetype.py
+#
+# This Python script (from METcalcpy) is used to calculate aggregation statistics for the ECNT linetype.
+#
+# .. highlight:: python
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/aggregate_ecnt.py
+#
+# Finally,this Python script (from METplotpy) is used to generate a spread-skill plot using the METplotypy line plot code.
+#
+# .. highlight:: python
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py
+#
+
+##############################################################################
+# Running METplus
+# ---------------
+#
+# This use case can be run two ways:
+#
+# 1) Passing in UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf,
+# then a user-specific system configuration file::
+#
+#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf -c /path/to/user_system.conf
+#
+# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf::
+#
+#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.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
+#
+#  and for the [exe] section, you will need to define the location of NON-MET executables.
+#  If the executable is in the user's path, METplus will find it from the name. 
+#  If the executable is not in the path, specify the full path to the executable here (i.e. RM = /bin/rm)  
+#  The following executables are required for performing series analysis use cases:
+#
+# 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
+#
+#
+#   [exe]
+#   RM = /path/to/rm
+#   CUT = /path/to/cut
+#   TR = /path/to/tr
+#   NCAP2 = /path/to/ncap2
+#   CONVERT = /path/to/convert
+#   NCDUMP = /path/to/ncdump
+#
+
+##############################################################################
+# Expected Output
+# ----------------
+#
+# A successful run will output the following both to the screen and to the logfile, one for the
+# reformat, aggregate, and plot steps of the use case::
+#
+#   INFO: METplus has successfully finished running.
+#
+#
+# **Reformat Output**
+#
+# The reformatted ensemble-stat ECNT linetype data should exist in the location specified in the user
+# configuration file (OUTPUT_BASE).  Verify that the ensemble_stat_ecnt.data file exists.  The file now has all
+# the statistics under the stat_name and stat_value columns, all ECNT statistic columns labelled with their
+# corresponding names (e.g. crps, crpss, rmse, etc.) and confidence level values under the
+# following columns:  stat_btcl and stat_btcu
+#
+#
+# **Aggregation Output**
+#
+# The METcalcpy agg_stat module is used to calculate aggregated statistics and confidence intervals for each
+# series (line) point.
+#
+# **Plot Output**
+#
+# A spread-skill plot of temperature for the RMSE, SPREAD_PLUS_OERR, and a ratio line of SPREAD_PLUS_OERR/RMSE is
+# created and found in the output location specified in the user configuration file (OUTPUT_BASE).  The plot is named
+# short-range_UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.png
+#
+#
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * UserScriptUseCase
+#   * ShortRangeAppUseCase
+#   * METdataioUseCase
+#   * METcalcpyUseCase
+#   * METplotpyUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
+# sphinx_gallery_thumbnail_path = '_static/short-range_UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.png'

internal/tests/use_cases/all_use_cases.txt

@@ -175,6 +175,7 @@ Category: short_range
 11::UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile::model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalProfile.conf:: metplotpy_env
 12::UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection::model_applications/short_range/UserScript_fcstFV3_fcstOnly_PhysicsTendency_VerticalCrossSection.conf:: metplotpy_env
 13::MODEMultivar_fcstHRRR_obsMRMS_HRRRanl::model_applications/short_range/MODEMultivar_fcstHRRR_obsMRMS_HRRRanl.conf
+14::UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot::model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf:: metdataio, metcalcpy, metplotpy,mp_analysis_env
 
 
 Category: space_weather

parm/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot.conf

@@ -0,0 +1,67 @@
+[config]
+
+# Documentation for this use case can be found at
+# https://metplus.readthedocs.io/en/latest/generated/model_applications/short-range/UserScript_fcstRRFS_obsOnly_Reformat_Aggregate_Plot.html
+
+# For additional information, please see the METplus Users Guide.
+# https://metplus.readthedocs.io/en/latest/Users_Guide
+
+###
+# Processes to run
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
+###
+
+PROCESS_LIST = UserScript(reformatter), UserScript(aggregate), UserScript(plotting)
+
+###
+# Time Info
+# LOOP_BY options are INIT, VALID, RETRO, and REALTIME
+# If set to INIT or RETRO:
+#   INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
+# If set to VALID or REALTIME:
+#   VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
+# LEAD_SEQ is the list of forecast leads to process
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
+###
+
+LOOP_BY = VALID
+VALID_TIME_FMT = %Y%m%d_%H%M%S
+VALID_BEG = 20220506_000000
+
+USER_SCRIPT_RUNTIME_FREQ = RUN_ONCE
+LOOP_ORDER = processes
+
+###
+# UserScript Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#userscript
+###
+
+
+[user_env_vars]
+REFORMAT_YAML_CONFIG_NAME = {PARM_BASE}/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/reformat_ecnt.yaml
+AGGREGATE_YAML_CONFIG_NAME = {PARM_BASE}/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/aggregate_ecnt.yaml
+PLOTTING_YAML_CONFIG_NAME = {PARM_BASE}/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.yaml
+REFORMAT_INPUT_BASE = {INPUT_BASE}/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot
+REFORMAT_OUTPUT_BASE = {OUTPUT_BASE}/reformatted
+AGGREGATE_INPUT_BASE = {REFORMAT_OUTPUT_BASE}
+AGGREGATE_OUTPUT_BASE = {OUTPUT_BASE}/aggregated
+PLOT_INPUT_BASE = {AGGREGATE_OUTPUT_BASE}
+PLOT_OUTPUT_BASE = {OUTPUT_BASE}/plot
+METDATAIO_BASE = {METPLUS_BASE}/../METdataio
+METCALCPY_BASE = {METPLUS_BASE}/../METcalcpy
+METPLOTPY_BASE = {METPLUS_BASE}/../METplotpy
+PYTHONPATH = {METDATAIO_BASE}:{METDATAIO_BASE}/METdbLoad:{METDATAIO_BASE}/METdbLoad/ush:{METDATAIO_BASE}/METreformat:{METCALCPY_BASE}:{METCALCPY_BASE}/metcalcpy:{METPLOTPY_BASE}:{METPLOTPY_BASE}/metplotpy/plots
+
+
+[reformatter]
+USER_SCRIPT_COMMAND = {PARM_BASE}/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/reformat_ecnt_linetype.py
+
+[aggregate]
+USER_SCRIPT_COMMAND = {PARM_BASE}/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/aggregate_ecnt.py
+
+[plotting]
+USER_SCRIPT_COMMAND = {PARM_BASE}/use_cases/model_applications/short_range/UserScript_fcstRRFS_fcstOnly_Reformat_Aggregate_Plot/plot_spread_skill.py
+
+
+
+