Per #1402, added additional comments to config file including links t…

…o documentation. Added old format version of config file that contain many comments with the _DIR/_TEMPLATE variables grouped together for comparison

parm/use_cases/met_tool_wrapper/GridStat/GridStat.conf

@@ -1,9 +1,23 @@
 [config]
 
+# For additional information, please see the METplus Users Guide.
+
+###
+# Processes to run
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
+###
+
 PROCESS_LIST = GridStat
 
 ###
 # 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
@@ -18,6 +32,7 @@ LOOP_ORDER = times
 
 ###
 # File I/O
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
 ###
 
 FCST_GRID_STAT_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
@@ -38,6 +53,7 @@ GRID_STAT_OUTPUT_TEMPLATE = {init?fmt=%Y%m%d%H}
 
 ###
 # Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
 ###
 
 MODEL = WRF
@@ -55,6 +71,7 @@ OBS_VAR1_THRESH = gt12.7, gt25.4, gt50.8, gt76.2
 
 ###
 # GridStat
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#gridstat
 ###
 
 #LOG_GRID_STAT_VERBOSITY = 2

parm/use_cases/met_tool_wrapper/GridStat/GridStat_comments.conf

@@ -0,0 +1,250 @@
+# GridStat METplus Configuration
+
+# section heading for [config] variables - all items below this line and
+# before the next section heading correspond to the [config] section
+[config]
+
+# List of applications to run - only GridStat for this case
+PROCESS_LIST = GridStat
+
+# time looping - 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 = INIT
+
+# Format of INIT_BEG and INT_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
+INIT_TIME_FMT = %Y%m%d%H
+
+# Start time for METplus run - must match INIT_TIME_FMT
+INIT_BEG=2005080700
+
+# End time for METplus run - must match INIT_TIME_FMT
+INIT_END=2005080700
+
+# Increment between METplus runs (in seconds if no units are specified)
+#  Must be >= 60 seconds
+INIT_INCREMENT = 12H
+
+# 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 = 12
+
+# 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 = times
+
+# directory containing forecast input to GridStat
+FCST_GRID_STAT_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
+
+# Template to look for forecast input to GridStat relative to FCST_GRID_STAT_INPUT_DIR
+FCST_GRID_STAT_INPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/wrfprs_ruc13_{lead?fmt=%HH}.tm00_G212
+
+# directory containing observation input to GridStat
+OBS_GRID_STAT_INPUT_DIR = {INPUT_BASE}/met_test/new
+
+# Template to look for observation input to GridStat relative to OBS_GRID_STAT_INPUT_DIR
+OBS_GRID_STAT_INPUT_TEMPLATE = ST2ml{valid?fmt=%Y%m%d%H}_A03h.nc
+
+# directory containing climatology mean input to GridStat
+# Not used in this example
+GRID_STAT_CLIMO_MEAN_INPUT_DIR =
+
+# Template to look for climatology input to GridStat relative to GRID_STAT_CLIMO_MEAN_INPUT_DIR
+# Not used in this example
+GRID_STAT_CLIMO_MEAN_INPUT_TEMPLATE =
+
+# directory containing climatology mean input to GridStat
+# Not used in this example
+GRID_STAT_CLIMO_STDEV_INPUT_DIR =
+
+# Template to look for climatology input to GridStat relative to GRID_STAT_CLIMO_STDEV_INPUT_DIR
+# Not used in this example
+GRID_STAT_CLIMO_STDEV_INPUT_TEMPLATE =
+
+# directory to write output from GridStat
+GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/GridStat/GridStat
+
+# Optional subdirectories relative to GRID_STAT_OUTPUT_DIR to write output from GridStat
+GRID_STAT_OUTPUT_TEMPLATE = {init?fmt=%Y%m%d%H}
+
+# Used to specify one or more verification mask files for GridStat
+# Not used for this example
+GRID_STAT_VERIFICATION_MASK_TEMPLATE =
+
+
+# Verbosity of MET output - overrides LOG_VERBOSITY for GridStat only
+#LOG_GRID_STAT_VERBOSITY = 2
+
+# Location of MET config file to pass to GridStat
+GRID_STAT_CONFIG_FILE = {PARM_BASE}/met_config/GridStatConfig_wrapped
+
+# grid to remap data. Value is set as the 'to_grid' variable in the 'regrid' dictionary
+# See MET User's Guide for more information
+GRID_STAT_REGRID_TO_GRID = NONE
+
+#GRID_STAT_INTERP_FIELD =
+#GRID_STAT_INTERP_VLD_THRESH =
+#GRID_STAT_INTERP_SHAPE =
+#GRID_STAT_INTERP_TYPE_METHOD =
+#GRID_STAT_INTERP_TYPE_WIDTH =
+
+#GRID_STAT_NC_PAIRS_VAR_NAME =
+
+#GRID_STAT_CLIMO_MEAN_TIME_INTERP_METHOD =
+#GRID_STAT_CLIMO_STDEV_TIME_INTERP_METHOD =
+
+#GRID_STAT_GRID_WEIGHT_FLAG =
+
+# Name to identify model (forecast) data in output
+MODEL = WRF
+
+# Name to identify observation data in output
+OBTYPE = MC_PCP
+
+# set the desc value in the GridStat MET config file
+GRID_STAT_DESC = NA
+
+# List of variables to compare in GridStat - FCST_VAR1 variables correspond
+#  to OBS_VAR1 variables
+# Note [FCST/OBS/BOTH]_GRID_STAT_VAR<n>_NAME can be used instead if different evaluations
+# are needed for different tools
+
+# Name of forecast variable 1
+FCST_VAR1_NAME = APCP
+
+# List of levels to evaluate for forecast variable 1
+# A03 = 3 hour accumulation in GRIB file
+FCST_VAR1_LEVELS = A03
+
+# List of thresholds to evaluate for each name/level combination for
+#  forecast variable 1
+FCST_VAR1_THRESH = gt12.7, gt25.4, gt50.8, gt76.2
+
+#FCST_GRID_STAT_FILE_TYPE =
+
+# Name of observation variable 1
+OBS_VAR1_NAME = APCP_03
+
+# List of levels to evaluate for observation variable 1
+# (*,*) is NetCDF notation - must include quotes around these values!
+# must be the same length as FCST_VAR1_LEVELS
+OBS_VAR1_LEVELS = "(*,*)"
+
+# List of thresholds to evaluate for each name/level combination for
+#  observation variable 1
+OBS_VAR1_THRESH = gt12.7, gt25.4, gt50.8, gt76.2
+
+#OBS_GRID_STAT_FILE_TYPE =
+
+# Time relative to valid time (in seconds) to allow files to be considered
+#  valid. Set both BEGIN and END to 0 to require the exact time in the filename
+#  Not used in this example.
+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
+
+# MET GridStat neighborhood values
+# See the MET User's Guide GridStat section for more information
+
+# width value passed to nbrhd dictionary in the MET config file
+GRID_STAT_NEIGHBORHOOD_WIDTH = 1
+
+# shape value passed to nbrhd dictionary in the MET config file
+GRID_STAT_NEIGHBORHOOD_SHAPE = SQUARE
+
+# cov thresh list passed to nbrhd dictionary in the MET config file
+GRID_STAT_NEIGHBORHOOD_COV_THRESH = >=0.5
+
+# Set to true to run GridStat separately for each field specified
+# Set to false to create one run of GridStat per run time that
+#   includes all fields specified.
+GRID_STAT_ONCE_PER_FIELD = False
+
+# Set to true if forecast data is probabilistic
+FCST_IS_PROB = false
+
+# Only used if FCST_IS_PROB is true - sets probabilistic threshold
+FCST_GRID_STAT_PROB_THRESH = ==0.1
+
+# Set to true if observation data is probabilistic
+#  Only used if configuring forecast data as the 'OBS' input
+OBS_IS_PROB = false
+
+# Only used if OBS_IS_PROB is true - sets probabilistic threshold
+OBS_GRID_STAT_PROB_THRESH = ==0.1
+
+GRID_STAT_OUTPUT_PREFIX = {MODEL}_{CURRENT_FCST_NAME}_vs_{OBTYPE}_{CURRENT_OBS_NAME}
+
+#GRID_STAT_CLIMO_MEAN_FILE_NAME =
+#GRID_STAT_CLIMO_MEAN_FIELD =
+#GRID_STAT_CLIMO_MEAN_REGRID_METHOD =
+#GRID_STAT_CLIMO_MEAN_REGRID_WIDTH =
+#GRID_STAT_CLIMO_MEAN_REGRID_VLD_THRESH =
+#GRID_STAT_CLIMO_MEAN_REGRID_SHAPE =
+#GRID_STAT_CLIMO_MEAN_TIME_INTERP_METHOD =
+#GRID_STAT_CLIMO_MEAN_MATCH_MONTH =
+#GRID_STAT_CLIMO_MEAN_DAY_INTERVAL =
+#GRID_STAT_CLIMO_MEAN_HOUR_INTERVAL =
+
+#GRID_STAT_CLIMO_STDEV_FILE_NAME =
+#GRID_STAT_CLIMO_STDEV_FIELD =
+#GRID_STAT_CLIMO_STDEV_REGRID_METHOD =
+#GRID_STAT_CLIMO_STDEV_REGRID_WIDTH =
+#GRID_STAT_CLIMO_STDEV_REGRID_VLD_THRESH =
+#GRID_STAT_CLIMO_STDEV_REGRID_SHAPE =
+#GRID_STAT_CLIMO_STDEV_TIME_INTERP_METHOD =
+#GRID_STAT_CLIMO_STDEV_MATCH_MONTH =
+#GRID_STAT_CLIMO_STDEV_DAY_INTERVAL =
+#GRID_STAT_CLIMO_STDEV_HOUR_INTERVAL =
+
+
+#GRID_STAT_CLIMO_CDF_BINS = 1
+#GRID_STAT_CLIMO_CDF_CENTER_BINS = False
+#GRID_STAT_CLIMO_CDF_WRITE_BINS = True
+
+#GRID_STAT_OUTPUT_FLAG_FHO = NONE
+GRID_STAT_OUTPUT_FLAG_CTC = STAT
+GRID_STAT_OUTPUT_FLAG_CTS = STAT
+#GRID_STAT_OUTPUT_FLAG_MCTC = NONE
+#GRID_STAT_OUTPUT_FLAG_MCTS = NONE
+#GRID_STAT_OUTPUT_FLAG_CNT = NONE
+#GRID_STAT_OUTPUT_FLAG_SL1L2 = NONE
+#GRID_STAT_OUTPUT_FLAG_SAL1L2 = NONE
+#GRID_STAT_OUTPUT_FLAG_VL1L2 = NONE
+#GRID_STAT_OUTPUT_FLAG_VAL1L2 = NONE
+#GRID_STAT_OUTPUT_FLAG_VCNT = NONE
+#GRID_STAT_OUTPUT_FLAG_PCT = NONE
+#GRID_STAT_OUTPUT_FLAG_PSTD = NONE
+#GRID_STAT_OUTPUT_FLAG_PJC = NONE
+#GRID_STAT_OUTPUT_FLAG_PRC = NONE
+GRID_STAT_OUTPUT_FLAG_ECLV = BOTH
+#GRID_STAT_OUTPUT_FLAG_NBRCTC = NONE
+#GRID_STAT_OUTPUT_FLAG_NBRCTS = NONE
+#GRID_STAT_OUTPUT_FLAG_NBRCNT = NONE
+GRID_STAT_OUTPUT_FLAG_GRAD = BOTH
+#GRID_STAT_OUTPUT_FLAG_DMAP = NONE
+
+GRID_STAT_NC_PAIRS_FLAG_LATLON = FALSE
+GRID_STAT_NC_PAIRS_FLAG_RAW = FALSE
+GRID_STAT_NC_PAIRS_FLAG_DIFF = FALSE
+GRID_STAT_NC_PAIRS_FLAG_CLIMO = FALSE
+#GRID_STAT_NC_PAIRS_FLAG_CLIMO_CDP = FALSE
+#GRID_STAT_NC_PAIRS_FLAG_WEIGHT = FALSE
+#GRID_STAT_NC_PAIRS_FLAG_NBRHD = FALSE
+#GRID_STAT_NC_PAIRS_FLAG_FOURIER = FALSE
+#GRID_STAT_NC_PAIRS_FLAG_GRADIENT = FALSE
+#GRID_STAT_NC_PAIRS_FLAG_DISTANCE_MAP = FALSE
+GRID_STAT_NC_PAIRS_FLAG_APPLY_MASK = FALSE