per #1402, rearrange and clean up config files for s2s, s2s_mid_lat, …

…and s2s_mjo. ci-run-all-diff
dtcenter · Jul 22, 2022 · ce09848 · ce09848
1 parent 664ec51
commit ce09848
Show file tree

Hide file tree

Showing 15 changed files with 816 additions and 1,083 deletions.
diff --git a/...ses/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf b/...ses/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.conf
@@ -1,36 +1,78 @@
-# Grid to Grid APIK Verification - S2S Use Case 1: Comparison of NMME hindcasts to CPC observations
-
 [config]
 
-# List of applications to run
+# Documentation for this use case can be found at
+# https://metplus.readthedocs.io/en/latest/generated/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast.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 = GridStat, SeriesAnalysis(climo), SeriesAnalysis(full_stats)
 
-# loop by INIT time (options are INIT, VALID, or ?)
-LOOP_BY = INIT
 
-# Format of INIT_BEG and INIT_END
-INIT_TIME_FMT = %Y%m
+###
+# 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
+###
 
-# Start time for METplus run
+LOOP_BY = INIT
+INIT_TIME_FMT = %Y%m
 INIT_BEG = 198207
-
-# End time for METplus run
 INIT_END = 201007
-
 INIT_INCREMENT = 1Y
 
-# list of forecast leads to process  (JLV-NOTE: This only works for grid_stat and example wrappers right now, using feature_281_py_embed)
 LEAD_SEQ = 1m, 2m, 3m, 4m, 5m, 6m
 
-#SERIES_ANALYSIS_CUSTOM_LOOP_LIST =
+SERIES_ANALYSIS_RUNTIME_FREQ = RUN_ONCE_PER_LEAD
 
-# Options are times, processes
-# times = run all items in the PROCESS_LIST for a single initialization
-# time, then repeat until all times have been evaluated.
-# processes = run each item in the PROCESS_LIST for all times
-#   specified, then repeat for the next item in the PROCESS_LIST.
 LOOP_ORDER = processes
 
+
+###
+# 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}/model_applications/s2s/NMME/hindcast/monthly
+FCST_GRID_STAT_INPUT_TEMPLATE = nmme_pr_hcst_{init?fmt=%b}IC_{valid?fmt=%m}_*.nc
+
+OBS_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/s2s/NMME/obs
+OBS_GRID_STAT_INPUT_TEMPLATE = obs_cpc_pp.1x1.nc
+
+GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast/GridStat
+
+BOTH_SERIES_ANALYSIS_INPUT_DIR = {GRID_STAT_OUTPUT_DIR}
+BOTH_SERIES_ANALYSIS_INPUT_TEMPLATE = grid_stat_{MODEL}-hindcast_precip_vs_{OBTYPE}_IC{init?fmt=%Y%b}_V{valid?fmt=%Y%m}01_*pairs.nc
+
+SERIES_ANALYSIS_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast/SeriesAnalysis
+SERIES_ANALYSIS_OUTPUT_TEMPLATE = series_analysis_{MODEL}_{OBTYPE}_stats_F{lead?fmt=%2m}_{instance?fmt=%s}.nc
+
+[full_stats]
+
+SERIES_ANALYSIS_CLIMO_MEAN_INPUT_DIR = {SERIES_ANALYSIS_OUTPUT_DIR}
+SERIES_ANALYSIS_CLIMO_MEAN_INPUT_TEMPLATE = series_analysis_{MODEL}_{OBTYPE}_stats_F{lead?fmt=%2m}_climo.nc
+
+[config]
+
+
+###
+# Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
+###
+
+MODEL = NMME
+OBTYPE = CPC
+
 FCST_GRID_STAT_VAR1_NAME = pr
 FCST_GRID_STAT_VAR1_LEVELS = "({valid?fmt=%Y%m01_000000},*,*)"
 FCST_GRID_STAT_VAR1_THRESH = >0, >50, >100, >150, >200, >250, >300, >400, >500
@@ -45,13 +87,11 @@ FCST_SERIES_ANALYSIS_VAR1_LEVELS = "(*,*)"
 OBS_SERIES_ANALYSIS_VAR1_NAME = OBS_precip_FULL
 OBS_SERIES_ANALYSIS_VAR1_LEVELS = "(*,*)"
 
-# description of data to be processed
-# used in output file path
-MODEL = NMME
-OBTYPE = CPC
 
-# location of grid_stat MET config file
-GRID_STAT_CONFIG_FILE = {PARM_BASE}/met_config/GridStatConfig_wrapped
+###
+# GridStat Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#gridstat
+###
 
 GRID_STAT_OUTPUT_FLAG_CTC = STAT
 GRID_STAT_OUTPUT_FLAG_CNT = STAT
@@ -61,90 +101,32 @@ GRID_STAT_NC_PAIRS_FLAG_APPLY_MASK = FALSE
 
 GRID_STAT_NC_PAIRS_VAR_NAME = precip
 
-# variables to describe format of forecast data
-FCST_IS_PROB = false
-
-# variables to describe format of observation data
-#  none needed
-
-# Increase verbosity of MET tools
-#LOG_MET_VERBOSITY=4
-
 GRID_STAT_OUTPUT_PREFIX = {MODEL}-hindcast_{CURRENT_OBS_NAME}_vs_{OBTYPE}_IC{init?fmt=%Y%b}_V{valid?fmt=%Y%m%d}
 
-# sets the desc variable in the SeriesAnalysis config file
+###
+# SeriesAnalysis Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#seriesanalysis
+###
+
 SERIES_ANALYSIS_DESC = hindcast
 
-# sets the cat_thresh variable in the SeriesAnalysis config file
 SERIES_ANALYSIS_CAT_THRESH = >=50, >=100, >=150, >=200, >=250, >=300, >=400, >=500
 
-# sets the vld_thresh variable in the SeriesAnalysis config file
 SERIES_ANALYSIS_VLD_THRESH = 0.50
 
-# sets the block_size variable in the SeriesAnalysis config file
 SERIES_ANALYSIS_BLOCK_SIZE = 360*181
 
-# set to True to add the -paired flag to the SeriesAnalysis command
 SERIES_ANALYSIS_IS_PAIRED = False
 
-# MET Configuration file passed to SeriesAnalysis
-SERIES_ANALYSIS_CONFIG_FILE = {PARM_BASE}/met_config/SeriesAnalysisConfig_wrapped
-
-# If True/yes, run plot_data_plane on output from Series-Analysis to generate
-# images for each stat item listed in SERIES_ANALYSIS_STAT_LIST
 SERIES_ANALYSIS_GENERATE_PLOTS = no
-
-# If True/yes, run convert on output from Series-Analysis to generate
-# a gif using images in groups of name/level/stat
 SERIES_ANALYSIS_GENERATE_ANIMATIONS = no
 
-# grid to remap data. Value is set as the 'to_grid' variable in the 'regrid' dictionary
-# See MET User's Guide for more information
-#SERIES_ANALYSIS_REGRID_TO_GRID = NONE
-
-SERIES_ANALYSIS_RUNTIME_FREQ = RUN_ONCE_PER_LEAD
-
 SERIES_ANALYSIS_RUN_ONCE_PER_STORM_ID = False
 
-# used for SeriesAnalysis(climo) instance
+
 SERIES_ANALYSIS_STAT_LIST = OBAR
 
 [full_stats]
 
 SERIES_ANALYSIS_STAT_LIST =TOTAL, FBAR, OBAR, ME, MAE, RMSE, ANOM_CORR, PR_CORR
 SERIES_ANALYSIS_CTS_LIST = BASER, CSI, GSS
-
-SERIES_ANALYSIS_CLIMO_MEAN_INPUT_DIR = {SERIES_ANALYSIS_OUTPUT_DIR}
-SERIES_ANALYSIS_CLIMO_MEAN_INPUT_TEMPLATE = series_analysis_{MODEL}_{OBTYPE}_stats_F{lead?fmt=%2m}_climo.nc
-
-
-[dir]
-
-# input and output data directories
-FCST_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/s2s/NMME/hindcast/monthly
-OBS_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/s2s/NMME/obs
-GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast/GridStat
-
-BOTH_SERIES_ANALYSIS_INPUT_DIR = {GRID_STAT_OUTPUT_DIR}
-
-SERIES_ANALYSIS_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/s2s/GridStat_SeriesAnalysis_fcstNMME_obsCPC_seasonal_forecast/SeriesAnalysis
-
-# used in full_stats instance file only
-SERIES_ANALYSIS_CLIMO_MEAN_INPUT_DIR =
-
-
-[filename_templates]
-
-# format of filenames
-# FCST
-FCST_GRID_STAT_INPUT_TEMPLATE = nmme_pr_hcst_{init?fmt=%b}IC_{valid?fmt=%m}_*.nc
-
-# ANLYS
-OBS_GRID_STAT_INPUT_TEMPLATE = obs_cpc_pp.1x1.nc
-
-BOTH_SERIES_ANALYSIS_INPUT_TEMPLATE = grid_stat_{MODEL}-hindcast_precip_vs_{OBTYPE}_IC{init?fmt=%Y%b}_V{valid?fmt=%Y%m}01_*pairs.nc
-
-SERIES_ANALYSIS_OUTPUT_TEMPLATE = series_analysis_{MODEL}_{OBTYPE}_stats_F{lead?fmt=%2m}_{instance?fmt=%s}.nc
-
-# used in full_stat instance only
-SERIES_ANALYSIS_CLIMO_MEAN_INPUT_TEMPLATE =
diff --git a/parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf b/parm/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.conf
@@ -1,9 +1,28 @@
 [config]
 
+# Documentation for this use case can be found at
+# https://metplus.readthedocs.io/en/latest/generated/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile.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 = 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
@@ -16,11 +35,12 @@ LEAD_SEQ =
 
 LOOP_ORDER = processes
 
+
 ###
 # File I/O
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
 ###
 
-
 FCST_GRID_STAT_INPUT_TEMPLATE = PYTHON_NUMPY
 
 OBS_GRID_STAT_INPUT_TEMPLATE = PYTHON_NUMPY
@@ -37,6 +57,7 @@ GRID_STAT_OUTPUT_TEMPLATE = {init?fmt=%Y%m}
 
 ###
 # Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
 ###
 
 MODEL = CFSv2
@@ -52,51 +73,31 @@ OBS_VAR1_THRESH = lt1.5, lt2.5
 
 CONFIG_DIR = {PARM_BASE}/use_cases/model_applications/s2s/GridStat_fcstCFSv2_obsGHCNCAMS_MultiTercile
 
+
 ###
-# GridStat
+# GridStat Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#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 = 
-