per #1402, clean up rest of met_tool_wrapper use case conf files, ci-…

…run-all-diff
dtcenter · Jul 6, 2022 · 551f8c7 · 551f8c7
1 parent 2d76352
commit 551f8c7
Show file tree

Hide file tree

Showing 24 changed files with 955 additions and 1,097 deletions.
diff --git a/parm/use_cases/met_tool_wrapper/PointStat/PointStat.conf b/parm/use_cases/met_tool_wrapper/PointStat/PointStat.conf
@@ -1,9 +1,28 @@
 [config]
 
+# Documentation for this use case can be found at
+# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/PointStat/PointStat.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 = PointStat
 
+
 ###
 # 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 = INIT
@@ -14,8 +33,10 @@ INIT_INCREMENT = 1M
 
 LEAD_SEQ = 36
 
+
 ###
 # File I/O
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
 ###
 
 FCST_POINT_STAT_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
@@ -32,8 +53,10 @@ POINT_STAT_CLIMO_MEAN_INPUT_TEMPLATE =
 POINT_STAT_CLIMO_STDEV_INPUT_DIR =
 POINT_STAT_CLIMO_STDEV_INPUT_TEMPLATE =
 
+
 ###
 # Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
 ###
 
 POINT_STAT_ONCE_PER_FIELD = False
@@ -62,8 +85,10 @@ OBS_VAR3_NAME = VGRD
 OBS_VAR3_LEVELS = Z10
 OBS_VAR3_THRESH = >=5
 
+
 ###
-# PointStat
+# PointStat Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#pointstat
 ###
 
 #LOG_POINT_STAT_VERBOSITY = 2

diff --git a/parm/use_cases/met_tool_wrapper/PointStat/PointStat_once_per_field.conf b/parm/use_cases/met_tool_wrapper/PointStat/PointStat_once_per_field.conf
@@ -1,120 +1,68 @@
 [config]
 
-# List of applications to run - only PointStat for this case
+# Documentation for this use case can be found at
+# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/PointStat/PointStat_once_per_field.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 = PointStat
 
-# time looping - options are INIT, VALID, RETRO, and REALTIME
+
+###
+# 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
-LOOP_BY = VALID
+# LEAD_SEQ is the list of forecast leads to process
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
+###
 
-# Format of VALID_BEG and VALID_END using % items
-# %Y = 4 digit year, %m = 2 digit month, %d = 2 digit day, etc.
-# see www.strftime.org for more information
-# %Y%m%d%H expands to YYYYMMDDHH
+LOOP_BY = VALID
 VALID_TIME_FMT = %Y%m%d
-
-# Start time for METplus run - must match VALID_TIME_FMT
 VALID_BEG = 20070330
-
-# End time for METplus run - must match VALID_TIME_FMT
 VALID_END = 20070330
-
-# Increment between METplus runs (in seconds if no units are specified)
-#  Must be >= 60 seconds
 VALID_INCREMENT = 1M
 
-# List of forecast leads to process for each run time (init or valid)
-# In hours if units are not specified
-# If unset, defaults to 0 (don't loop through forecast leads)
 LEAD_SEQ = 0
 
-# Order of loops to process data - Options are times, processes
-# Not relevant if only one item is in the PROCESS_LIST
-# times = run all wrappers in the PROCESS_LIST for a single run time, then
-#   increment the run time and run all wrappers again until all times have
-#   been evaluated.
-# processes = run the first wrapper in the PROCESS_LIST for all times
-#   specified, then repeat for the next item in the PROCESS_LIST until all
-#   wrappers have been run
 LOOP_ORDER = processes
 
-# Verbosity of MET output - overrides LOG_VERBOSITY for PointStat only
-#LOG_POINT_STAT_VERBOSITY = 2
-
-# Location of MET config file to pass to GridStat
-# References PARM_BASE which is the location of the parm directory corresponding
-# to the ush directory of the run_metplus.py script that is called
-# or the value of the environment variable METPLUS_PARM_BASE if set
-POINT_STAT_CONFIG_FILE ={PARM_BASE}/met_config/PointStatConfig_wrapped
-
-POINT_STAT_CLIMO_MEAN_TIME_INTERP_METHOD = NEAREST
-
-POINT_STAT_INTERP_TYPE_METHOD = BILIN
-POINT_STAT_INTERP_TYPE_WIDTH = 2
 
-POINT_STAT_OUTPUT_FLAG_SL1L2 = STAT
-POINT_STAT_OUTPUT_FLAG_VL1L2 = STAT
-
-# Time relative to each input file's valid time (in seconds if no units are specified) for data within the file to be
-# considered valid. Values are set in the 'obs_window' dictionary in the PointStat config file
-OBS_POINT_STAT_WINDOW_BEGIN = -5400
-OBS_POINT_STAT_WINDOW_END = 5400
+###
+# File I/O
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
+###
 
-# Optional list of offsets to look for point observation data
-POINT_STAT_OFFSETS = 0
-
-# Model/fcst and obs name, e.g. GFS, NAM, GDAS, etc.
-MODEL = WRF
-OBTYPE =
-
-#POINT_STAT_DESC =
-
-# Regrid to specified grid.  Indicate NONE if no regridding, or the grid id
-# (e.g. G212)
-POINT_STAT_REGRID_TO_GRID = NONE
-POINT_STAT_REGRID_METHOD = BILIN
-POINT_STAT_REGRID_WIDTH = 2
+FCST_POINT_STAT_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
+FCST_POINT_STAT_INPUT_TEMPLATE = {valid?fmt=%Y%m%d%H}/nam.t00z.awip1236.tm00.{valid?fmt=%Y%m%d}.grb
 
-#POINT_STAT_OUTPUT_PREFIX = {fcst_name?fmt=%s}_{fcst_level?fmt=%s}
-POINT_STAT_OUTPUT_PREFIX = {CURRENT_FCST_NAME}_{CURRENT_FCST_LEVEL}
+OBS_POINT_STAT_INPUT_DIR = {INPUT_BASE}/met_test/out/pb2nc
+OBS_POINT_STAT_INPUT_TEMPLATE = sample_pb.nc
 
-# sets the -obs_valid_beg command line argument (optional)
-# not used for this example
-#POINT_STAT_OBS_VALID_BEG = {valid?fmt=%Y%m%d_%H}
+POINT_STAT_CLIMO_MEAN_INPUT_DIR =
+POINT_STAT_CLIMO_MEAN_INPUT_TEMPLATE =
 
-# sets the -obs_valid_end command line argument (optional)
-# not used for this example
-#POINT_STAT_OBS_VALID_END = {valid?fmt=%Y%m%d_%H}
+POINT_STAT_CLIMO_STDEV_INPUT_DIR =
+POINT_STAT_CLIMO_STDEV_INPUT_TEMPLATE =
 
-# Verification Masking regions
-# Indicate which grid and polygon masking region, if applicable
-POINT_STAT_GRID = DTC165, DTC166
+POINT_STAT_OUTPUT_DIR = {OUTPUT_BASE}/point_stat
 
-# List of full path to poly masking files.  NOTE: Only short lists of poly
-# files work (those that fit on one line), a long list will result in an
-# environment variable that is too long, resulting in an error.  For long
-# lists of poly masking files (i.e. all the mask files in the NCEP_mask
-# directory), define these in the MET point_stat configuration file.
-POINT_STAT_POLY = MET_BASE/poly/LMV.poly
-POINT_STAT_STATION_ID =
 
-# Message types, if all message types are to be returned, leave this empty,
-# otherwise indicate the message types of interest.
-POINT_STAT_MESSAGE_TYPE = ADPUPA, ADPSFC
-# Variables and levels as specified in the field dictionary of the MET
-# point_stat configuration file. Specify as FCST_VARn_NAME, FCST_VARn_LEVELS,
-# (optional) FCST_VARn_OPTION
+###
+# Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
+###
 
-# set to True to run PointStat once for each name/level combination
-# set to False to run PointStat once per run time including all fields
 POINT_STAT_ONCE_PER_FIELD = True
 
-# fields to compare
-# Note: If FCST_VAR<n>_* is set, then a corresponding OBS_VAR<n>_* variable must be set
-# To use one variables for both forecast and observation data, set BOTH_VAR<n>_* instead
 FCST_VAR1_NAME = TMP
 FCST_VAR1_LEVELS = P750-900
 FCST_VAR1_THRESH = <=273, >273
@@ -137,37 +85,46 @@ OBS_VAR3_LEVELS = Z10
 OBS_VAR3_THRESH = >=5
 
 
-# End of [config] section and start of [dir] section
-[dir]
-FCST_POINT_STAT_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
-OBS_POINT_STAT_INPUT_DIR = {INPUT_BASE}/met_test/out/pb2nc
+###
+# PointStat Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#pointstat
+###
 
-# directory containing climatology mean input to PointStat
-# Not used in this example
-POINT_STAT_CLIMO_MEAN_INPUT_DIR =
+#LOG_POINT_STAT_VERBOSITY = 2
 
-# directory containing climatology mean input to PointStat
-# Not used in this example
-POINT_STAT_CLIMO_STDEV_INPUT_DIR =
+POINT_STAT_CONFIG_FILE ={PARM_BASE}/met_config/PointStatConfig_wrapped
 
+POINT_STAT_CLIMO_MEAN_TIME_INTERP_METHOD = NEAREST
 
-POINT_STAT_OUTPUT_DIR = {OUTPUT_BASE}/point_stat
+POINT_STAT_INTERP_TYPE_METHOD = BILIN
+POINT_STAT_INTERP_TYPE_WIDTH = 2
 
+POINT_STAT_OUTPUT_FLAG_SL1L2 = STAT
+POINT_STAT_OUTPUT_FLAG_VL1L2 = STAT
 
-# End of [dir] section and start of [filename_templates] section
-[filename_templates]
+OBS_POINT_STAT_WINDOW_BEGIN = -5400
+OBS_POINT_STAT_WINDOW_END = 5400
 
-# Template to look for forecast input to PointStat relative to FCST_POINT_STAT_INPUT_DIR
-FCST_POINT_STAT_INPUT_TEMPLATE = {valid?fmt=%Y%m%d%H}/nam.t00z.awip1236.tm00.{valid?fmt=%Y%m%d}.grb
+POINT_STAT_OFFSETS = 0
 
-# Template to look for observation input to PointStat relative to OBS_POINT_STAT_INPUT_DIR
-OBS_POINT_STAT_INPUT_TEMPLATE = sample_pb.nc
+MODEL = WRF
+OBTYPE =
 
-# Template to look for climatology input to PointStat relative to POINT_STAT_CLIMO_MEAN_INPUT_DIR
-# Not used in this example
-POINT_STAT_CLIMO_MEAN_INPUT_TEMPLATE =
+#POINT_STAT_DESC =
 
-# Template to look for climatology input to PointStat relative to POINT_STAT_CLIMO_STDEV_INPUT_DIR
-# Not used in this example
-POINT_STAT_CLIMO_STDEV_INPUT_TEMPLATE =
+POINT_STAT_REGRID_TO_GRID = NONE
+POINT_STAT_REGRID_METHOD = BILIN
+POINT_STAT_REGRID_WIDTH = 2
 
+#POINT_STAT_OUTPUT_PREFIX = {fcst_name?fmt=%s}_{fcst_level?fmt=%s}
+POINT_STAT_OUTPUT_PREFIX = {CURRENT_FCST_NAME}_{CURRENT_FCST_LEVEL}
+
+#POINT_STAT_OBS_VALID_BEG = {valid?fmt=%Y%m%d_%H}
+#POINT_STAT_OBS_VALID_END = {valid?fmt=%Y%m%d_%H}
+
+POINT_STAT_GRID = DTC165, DTC166
+POINT_STAT_POLY = MET_BASE/poly/LMV.poly
+
+POINT_STAT_STATION_ID =
+
+POINT_STAT_MESSAGE_TYPE = ADPUPA, ADPSFC