Note
Go to the end to download the full example code
MODE: Basic Use Case
met_tool_wrapper/MODE/MODE.conf
Scientific Objective
Compare relative humidity 12 hour forecast to 0 hour observations. Generate statistics of the results.
Datasets
METplus Components
This use case utilizes the METplus MODE wrapper to search for files that are valid at a given run time and generate a command to run the MET tool mode if all required files are found.
METplus Workflow
MODE is the only tool called in this example. It processes the following run times:
METplus Configuration
METplus first loads all of 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/met_tool_wrapper/MODE/MODE.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/MODE/MODE.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 = MODE
###
# 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
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG=2005080700
INIT_END=2005080700
INIT_INCREMENT = 12H
LEAD_SEQ = 12
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
FCST_MODE_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
FCST_MODE_INPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/wrfprs_ruc13_{lead?fmt=%HH}.tm00_G212
OBS_MODE_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
OBS_MODE_INPUT_TEMPLATE = {valid?fmt=%Y%m%d%H}/wrfprs_ruc13_00.tm00_G212
MODE_OUTPUT_DIR = {OUTPUT_BASE}/mode
MODE_OUTPUT_TEMPLATE = {valid?fmt=%Y%m%d%H}
FCST_MODE_FILE_WINDOW_BEGIN = 0
FCST_MODE_FILE_WINDOW_END = 0
OBS_MODE_FILE_WINDOW_BEGIN = 0
OBS_MODE_FILE_WINDOW_END = 0
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
FCST_IS_PROB = false
FCST_VAR1_NAME = RH
FCST_VAR1_LEVELS = P500
FCST_MODE_CONV_RADIUS = 5
FCST_MODE_CONV_THRESH = >=80.0
FCST_MODE_MERGE_THRESH = >=75.0
FCST_MODE_MERGE_FLAG = NONE
#MODE_FCST_FILE_TYPE =
#MODE_FCST_FILTER_ATTR_NAME =
#MODE_FCST_FILTER_ATTR_THRESH =
#MODE_FCST_CENSOR_THRESH =
#MODE_FCST_CENSOR_VAL =
#MODE_FCST_VLD_THRESH =
#MODE_FCST_MULTIVAR_NAME =
#MODE_FCST_MULTIVAR_LEVEL =
OBS_VAR1_NAME = RH
OBS_VAR1_LEVELS = P500
OBS_MODE_CONV_RADIUS = 5
OBS_MODE_CONV_THRESH = >=80.0
OBS_MODE_MERGE_THRESH = >=75.0
OBS_MODE_MERGE_FLAG = NONE
#MODE_OBS_FILE_TYPE =
#MODE_OBS_FILTER_ATTR_NAME =
#MODE_OBS_FILTER_ATTR_THRESH =
#MODE_OBS_CENSOR_THRESH =
#MODE_OBS_CENSOR_VAL =
#MODE_OBS_VLD_THRESH =
#MODE_OBS_MULTIVAR_NAME =
#MODE_OBS_MULTIVAR_LEVEL =
###
# MODE Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#mode
###
#LOG_MODE_VERBOSITY = 2
MODEL = WRF
MODE_DESC = NA
OBTYPE = WRF
MODE_CONFIG_FILE = {PARM_BASE}/met_config/MODEConfig_wrapped
#MODE_MULTIVAR_LOGIC =
#MODE_MULTIVAR_INTENSITY_FLAG =
MODE_REGRID_TO_GRID = NONE
#MODE_REGRID_METHOD =
#MODE_REGRID_WIDTH =
#MODE_REGRID_VLD_THRESH =
#MODE_REGRID_SHAPE =
#MODE_REGRID_CONVERT =
#MODE_REGRID_CENSOR_THRESH =
#MODE_REGRID_CENSOR_VAL =
MODE_OUTPUT_PREFIX = {MODEL}_{CURRENT_FCST_NAME}_vs_{OBTYPE}_{CURRENT_OBS_NAME}_{CURRENT_OBS_LEVEL}
MODE_MERGE_CONFIG_FILE =
MODE_GRID_RES = 40
#MODE_INTEREST_FUNCTION_CENTROID_DIST =
#MODE_INTEREST_FUNCTION_BOUNDARY_DIST =
#MODE_INTEREST_FUNCTION_CONVEX_HULL_DIST =
#MODE_TOTAL_INTEREST_THRESH =
#MODE_MASK_GRID =
#MODE_MASK_GRID_FLAG =
#MODE_MASK_POLY =
#MODE_MASK_POLY_FLAG =
MODE_MASK_MISSING_FLAG = BOTH
#MODE_MATCH_FLAG =
#MODE_WEIGHT_CENTROID_DIST =
#MODE_WEIGHT_BOUNDARY_DIST =
#MODE_WEIGHT_CONVEX_HULL_DIST =
#MODE_WEIGHT_ANGLE_DIFF =
#MODE_WEIGHT_ASPECT_DIFF =
#MODE_WEIGHT_AREA_RATIO =
#MODE_WEIGHT_INT_AREA_RATIO =
#MODE_WEIGHT_CURVATURE_RATIO =
#MODE_WEIGHT_COMPLEXITY_RATIO =
#MODE_WEIGHT_INTEN_PERC_RATIO =
#MODE_WEIGHT_INTEN_PERC_VALUE =
#MODE_NC_PAIRS_FLAG_LATLON =
#MODE_NC_PAIRS_FLAG_RAW =
#MODE_NC_PAIRS_FLAG_OBJECT_RAW =
#MODE_NC_PAIRS_FLAG_OBJECT_ID =
#MODE_NC_PAIRS_FLAG_CLUSTER_ID =
#MODE_NC_PAIRS_FLAG_POLYLINES =
MODE_QUILT = True
#MODE_PS_PLOT_FLAG =
#MODE_CT_STATS_FLAG =
MET Configuration
METplus sets environment variables based on user settings in the METplus configuration file. See How METplus controls MET config file settings for more details.
YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!
If there is a setting in the MET configuration file that is currently not supported by METplus you’d like to control, please refer to: Overriding Unsupported MET config file settings
Note
See the MODE MET Configuration section of the User’s Guide for more information on the environment variables used in the file below:
////////////////////////////////////////////////////////////////////////////////
//
// MODE configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////
//
// Output model name to be written
//
// model =
${METPLUS_MODEL}
//
// Output description to be written
//
// desc =
${METPLUS_DESC}
//
// Output observation type to be written
//
// obtype =
${METPLUS_OBTYPE}
////////////////////////////////////////////////////////////////////////////////
//
// Verification grid
//
// regrid = {
${METPLUS_REGRID_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Approximate grid resolution (km)
//
// grid_res =
${METPLUS_GRID_RES}
////////////////////////////////////////////////////////////////////////////////
//
// Run all permutations of radius and threshold
//
// quilt =
${METPLUS_QUILT}
//
// MODE Multivar boolean combination logic
//
//multivar_logic =
${METPLUS_MULTIVAR_LOGIC}
//multivar_intensity_flag =
${METPLUS_MULTIVAR_INTENSITY_FLAG}
//
// Forecast and observation fields to be verified
//
fcst = {
${METPLUS_FCST_FIELD}
${METPLUS_FCST_CENSOR_THRESH}
${METPLUS_FCST_CENSOR_VAL}
${METPLUS_FCST_CONV_RADIUS}
${METPLUS_FCST_CONV_THRESH}
${METPLUS_FCST_VLD_THRESH}
${METPLUS_FCST_FILTER_ATTR_NAME}
${METPLUS_FCST_FILTER_ATTR_THRESH}
${METPLUS_FCST_MERGE_THRESH}
${METPLUS_FCST_MERGE_FLAG}
${METPLUS_FCST_FILE_TYPE}
${METPLUS_FCST_MULTIVAR_NAME}
${METPLUS_FCST_MULTIVAR_LEVEL}
}
obs = {
${METPLUS_OBS_FIELD}
${METPLUS_OBS_CENSOR_THRESH}
${METPLUS_OBS_CENSOR_VAL}
${METPLUS_OBS_CONV_RADIUS}
${METPLUS_OBS_CONV_THRESH}
${METPLUS_OBS_VLD_THRESH}
${METPLUS_OBS_FILTER_ATTR_NAME}
${METPLUS_OBS_FILTER_ATTR_THRESH}
${METPLUS_OBS_MERGE_THRESH}
${METPLUS_OBS_MERGE_FLAG}
${METPLUS_OBS_FILE_TYPE}
${METPLUS_OBS_MULTIVAR_NAME}
${METPLUS_OBS_MULTIVAR_LEVEL}
}
////////////////////////////////////////////////////////////////////////////////
//
// Handle missing data
//
// mask_missing_flag =
${METPLUS_MASK_MISSING_FLAG}
//
// Match objects between the forecast and observation fields
//
//match_flag =
${METPLUS_MATCH_FLAG}
//
// Maximum centroid distance for objects to be compared
//
//max_centroid_dist =
${METPLUS_MAX_CENTROID_DIST}
////////////////////////////////////////////////////////////////////////////////
//
// Verification masking regions
//
//mask = {
${METPLUS_MASK_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Fuzzy engine weights
//
//weight = {
${METPLUS_WEIGHT_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Fuzzy engine interest functions
//
interest_function = {
${METPLUS_INTEREST_FUNCTION_CENTROID_DIST}
${METPLUS_INTEREST_FUNCTION_BOUNDARY_DIST}
${METPLUS_INTEREST_FUNCTION_CONVEX_HULL_DIST}
angle_diff = (
( 0.0, 1.0 )
( 30.0, 1.0 )
( 90.0, 0.0 )
);
aspect_diff = (
( 0.00, 1.0 )
( 0.10, 1.0 )
( 0.75, 0.0 )
);
corner = 0.8;
ratio_if = (
( 0.0, 0.0 )
( corner, 1.0 )
( 1.0, 1.0 )
);
area_ratio = ratio_if;
int_area_ratio = (
( 0.00, 0.00 )
( 0.10, 0.50 )
( 0.25, 1.00 )
( 1.00, 1.00 )
);
curvature_ratio = ratio_if;
complexity_ratio = ratio_if;
inten_perc_ratio = ratio_if;
}
////////////////////////////////////////////////////////////////////////////////
//
// Total interest threshold for determining matches
//
//total_interest_thresh =
${METPLUS_TOTAL_INTEREST_THRESH}
//
// Interest threshold for printing output pair information
//
print_interest_thresh = 0.0;
////////////////////////////////////////////////////////////////////////////////
//
// Plotting information
//
met_data_dir = "MET_BASE";
fcst_raw_plot = {
color_table = "MET_BASE/colortables/met_default.ctable";
plot_min = 0.0;
plot_max = 0.0;
}
obs_raw_plot = {
color_table = "MET_BASE/colortables/met_default.ctable";
plot_min = 0.0;
plot_max = 0.0;
}
object_plot = {
color_table = "MET_BASE/colortables/mode_obj.ctable";
}
//
// Boolean for plotting on the region of valid data within the domain
//
plot_valid_flag = FALSE;
//
// Plot polyline edges using great circle arcs instead of straight lines
//
plot_gcarc_flag = FALSE;
////////////////////////////////////////////////////////////////////////////////
//
// NetCDF matched pairs, PostScript, and contingency table output files
//
//ps_plot_flag =
${METPLUS_PS_PLOT_FLAG}
//nc_pairs_flag = {
${METPLUS_NC_PAIRS_FLAG_DICT}
//ct_stats_flag =
${METPLUS_CT_STATS_FLAG}
////////////////////////////////////////////////////////////////////////////////
shift_right = 0; // grid squares
////////////////////////////////////////////////////////////////////////////////
${METPLUS_OUTPUT_PREFIX}
//version = "V10.0";
tmp_dir = "${MET_TMP_DIR}";
////////////////////////////////////////////////////////////////////////////////
${METPLUS_MET_CONFIG_OVERRIDES}
Running METplus
This use case can be run two ways:
Passing in MODE.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/MODE/MODE.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in MODE.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/MODE/MODE.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
Example User Configuration File:
[dir]
INPUT_BASE = /path/to/sample/input/data
OUTPUT_BASE = /path/to/output/dir
MET_INSTALL_DIR = /path/to/met-X.Y
NOTE: All of these items must be found under the [dir] section.
Expected Output
A successful run will output the following both to the screen and to the logfile:
INFO: METplus has successfully finished running.
Refer to the value set for OUTPUT_BASE to find where the output data was generated. Output for this use case will be found in mode/2005080712 (relative to OUTPUT_BASE) and will contain the following files:
# * mode_WRF_RH_vs_WRF_RH_P500_120000L_20050807_120000V_000000A_cts.txt
# * mode_WRF_RH_vs_WRF_RH_P500_120000L_20050807_120000V_000000A_obj.nc
# * mode_WRF_RH_vs_WRF_RH_P500_120000L_20050807_120000V_000000A_obj.txt
# * mode_WRF_RH_vs_WRF_RH_P500_120000L_20050807_120000V_000000A.ps
Keywords
Note
MODEToolUseCase
DiagnosticsUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-MODE.png’
Total running time of the script: (0 minutes 0.000 seconds)