per #1402, clean up use cases in marine_and_cryosphere

dtcenter · Jul 14, 2022 · c0787cb · c0787cb
1 parent f98e178
commit c0787cb
Show file tree

Hide file tree

Showing 9 changed files with 353 additions and 1,005 deletions.
diff --git a/...e_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py b/...e_cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.py
@@ -14,6 +14,7 @@
 # and Ice Mapping System (IMS) and the National Centers for Environmental Prediction (NCEP)
 # sea ice analysis.  This is a validation and diagnostics use case because it is limited to a
 # comparison between IMS analysis to NCEP analysis.
+# Written by Lindsay Blank, NCAR. January 2020
 
 ####################################################################################################
 # Datasets

diff --git a/...cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf b/...cases/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.conf
@@ -1,73 +1,107 @@
-# IMS Ice Concentration (fcst) vs. NCEP Ice Concentration (obs)
-# IMS and NCEP are both observation analyses. For the purpose of running MET, IMS is referred to as
-# the forecast and NCEP as the obs.
-# Written by Lindsay Blank, NCAR. January 2020
-####################################################################################################
 [config]
-# Loop by analysis time
-LOOP_BY = VALID
 
-# Format of VALID_BEG and VALID_END
-VALID_TIME_FMT = %Y%m%d
+# Documentation for this use case can be found at
+# https://metplus.readthedocs.io/en/latest/generated/model_applications/marine_and_cryosphere/GridStat_MODE_fcstIMS_obsNCEP_sea_ice.html
 
-# L: Available dates are 20190201 - 20190228
-# Start time for METplus run
-VALID_BEG=20190201
+# For additional information, please see the METplus Users Guide.
+# https://metplus.readthedocs.io/en/latest/Users_Guide
 
-# End time for METplus run
-VALID_END=20190201
+###
+# Processes to run
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
+###
+
+PROCESS_LIST = GridStat, Mode
 
-# Increment between METplus runs in seconds. Must be >= 60
+
+###
+# 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
+VALID_BEG=20190201
+VALID_END=20190201
 VALID_INCREMENT=86400
 
-# 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 = times
 
-# List of applications to run
-PROCESS_LIST = GridStat, Mode
 
-# Description of data to be processed
-# used in output file path
-MODEL = IMS
-OBTYPE = NCEP
+###
+# File I/O
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
+###
 
-# Set to true if forecast data is probabilistic
-FCST_IS_PROB = false
+FCST_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/IMS_data
+FCST_GRID_STAT_INPUT_TEMPLATE = imssnow96.{valid?fmt=%Y%m%d}.grb.grib2
 
+OBS_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/NCEP_data
+OBS_GRID_STAT_INPUT_TEMPLATE = seaice.t00z.north12psg.grib2.{valid?fmt=%Y%m%d}
+
+GRID_STAT_VERIFICATION_MASK_TEMPLATE = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/seaice_nland127.nc
+
+GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/GridStat
+GRID_STAT_OUTPUT_TEMPLATE = {valid?fmt=%Y%m%d}/grid_stat
+
+
+FCST_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/IMS_data
+FCST_MODE_INPUT_TEMPLATE = imssnow96.{valid?fmt=%Y%m%d}.grb.grib2
+
+OBS_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/NCEP_data
+OBS_MODE_INPUT_TEMPLATE = seaice.t00z.north12psg.grib2.{valid?fmt=%Y%m%d}
+
+MODE_VERIFICATION_MASK_TEMPLATE = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/seaice_nland127.nc
+
+MODE_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/MODE
+MODE_OUTPUT_TEMPLATE = {valid?fmt=%Y%m%d}/mode
+
+
+###
+# Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
+###
+
+MODEL = IMS
+OBTYPE = NCEP
 
-###################################################################################################
-# GridStat Configurations
-###################################################################################################
-# List of variables to compare
-# "THRESH" refers to "cat_thresh"
 FCST_VAR1_NAME = ICEC
 FCST_VAR1_LEVELS = Z0
-FCST_VAR1_THRESH = ==1.0 
+FCST_VAR1_THRESH = ==1.0
+
+FCST_MODE_CONV_THRESH = ==1.00
+OBS_MODE_CONV_THRESH = >=0.40
+
 
 OBS_VAR1_NAME = ICEC
 OBS_VAR1_LEVELS = Z0
 OBS_VAR1_THRESH = >=0.40
 OBS_VAR1_OPTIONS = censor_thresh = [ >1.00 && <=1.28, >1.28 ]; censor_val    = [ 1.00 , -9999 ];
 
+MODE_OBS_CENSOR_THRESH = >1.00 && <=1.28, >1.28
+MODE_OBS_CENSOR_VAL = 1.00 , -9999
+
+
+###
+# GridStat Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#gridstat
+###
+
 GRID_STAT_NEIGHBORHOOD_WIDTH = 3, 5, 7, 9
 
-# regridding domain for GridStat
 GRID_STAT_REGRID_TO_GRID = OBS
 
-# Location of grid_stat MET config file
-GRID_STAT_CONFIG_FILE = {PARM_BASE}/met_config/GridStatConfig_wrapped
-
-# prefix to add to GridStat output filenames
 GRID_STAT_OUTPUT_PREFIX = {MODEL}_{CURRENT_FCST_NAME}_vs_{OBTYPE}_{CURRENT_OBS_NAME}_{CURRENT_FCST_LEVEL}
 
 GRID_STAT_MASK_GRID = 
 
-#GRID_STAT_MASK_POLY =
-
 GRID_STAT_OUTPUT_FLAG_CTC = STAT
 GRID_STAT_OUTPUT_FLAG_CTS = STAT
 GRID_STAT_OUTPUT_FLAG_FHO = STAT
@@ -79,37 +113,23 @@ GRID_STAT_OUTPUT_FLAG_NBRCNT = STAT
 
 GRID_STAT_NC_PAIRS_FLAG_NBRHD = TRUE
 
-####################################################################################################
-# MODE Configurations
-####################################################################################################
-# regridding domain for MODE
+
+###
+# MODE Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#mode
+###
+
 MODE_REGRID_TO_GRID = OBS
 
-# Turn on quilting
 MODE_QUILT = False
 
-# Convolution radius list
 MODE_CONV_RADIUS = 50
 
-# Convolution threshold list
-# L: IMS is a binary field where a value of "1" is equivalent to >=0.40 sea ice concentration.
-FCST_MODE_CONV_THRESH = ==1.00
-OBS_MODE_CONV_THRESH = >=0.40
-
-# Location of mode MET config file
-MODE_CONFIG_FILE = {PARM_BASE}/met_config/MODEConfig_wrapped
-
-# Merge flag: options are NONE, THRESH, ENGINE, or BOTH
 MODE_MERGE_FLAG = NONE
-
-# Merge threshold list
 MODE_MERGE_THRESH = >=1.25
 
 MODE_GRID_RES = 12.7
 
-MODE_OBS_CENSOR_THRESH = >1.00 && <=1.28, >1.28
-MODE_OBS_CENSOR_VAL = 1.00 , -9999
-
 MODE_MASK_MISSING_FLAG = BOTH
 
 MODE_MATCH_FLAG = NO_MERGE
@@ -118,34 +138,4 @@ MODE_MASK_POLY_FLAG = BOTH
 
 MODE_TOTAL_INTEREST_THRESH = 0.8
 
-# prefix to add to MODE output filenames
 MODE_OUTPUT_PREFIX = {MODEL}_{CURRENT_FCST_NAME}_vs_{OBTYPE}_{CURRENT_OBS_NAME}
-
-[dir]
-# input and output data directories for each application in PROCESS_LIST
-OBS_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/NCEP_data
-FCST_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/IMS_data
-
-OBS_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/NCEP_data
-FCST_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/IMS_data
-
-GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/GridStat
-MODE_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/MODE
-
-[filename_templates]
-# format of filenames
-
-# IMS
-FCST_GRID_STAT_INPUT_TEMPLATE = imssnow96.{valid?fmt=%Y%m%d}.grb.grib2
-FCST_MODE_INPUT_TEMPLATE = imssnow96.{valid?fmt=%Y%m%d}.grb.grib2
-
-# NCEP
-OBS_GRID_STAT_INPUT_TEMPLATE = seaice.t00z.north12psg.grib2.{valid?fmt=%Y%m%d}
-OBS_MODE_INPUT_TEMPLATE = seaice.t00z.north12psg.grib2.{valid?fmt=%Y%m%d}
-
-GRID_STAT_VERIFICATION_MASK_TEMPLATE = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/seaice_nland127.nc
-
-MODE_VERIFICATION_MASK_TEMPLATE = {INPUT_BASE}/model_applications/marine_and_cryosphere/sea_ice/seaice_nland127.nc
-
-GRID_STAT_OUTPUT_TEMPLATE = {valid?fmt=%Y%m%d}/grid_stat
-MODE_OUTPUT_TEMPLATE = {valid?fmt=%Y%m%d}/mode