Note
Go to the end to download the full example code.
MODE: CESM and GPCP Asian Monsoon Precipitation
model_applications/climate/MODE_fcstCESM_obsGPCP_AsianMonsoonPrecip.conf
Scientific Objective
To evaluate the CESM model daily precipitation against the GPCP daily precipitation over the Indian Monsoon region to obtain object based output statistics. This was developed as part of the NCAR System for Integrated Modeling of the Atmosphere (SIMA) project.
Version Added
METplus version 3.1
Datasets
Forecast: CESM Daily Precipitation
Observation: GPCP Daily Precipitation
Climatology: None
Location: All of the input data required for this use case can be found in a sample data tarball. Each use case category will have one or more sample data tarballs. It is only necessary to download the tarball with the use case’s dataset and not the entire collection of sample data. Click here to access the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See Running METplus section for more information.
METplus Components
This use case runs mode to create object based statistics on daily precipitation data from the CESM model and observations from the GPCP.
METplus Workflow
Beginning time (INIT_BEG): 2014060100
End time (INIT_END): 2014060200
Increment between beginning and end times (INIT_INCREMENT): 1 day
Sequence of forecast leads to process (LEAD_SEQ): 24, 48
The mode tool is run for each time. This example loops by model initialization time. It processes two initialization times and two lead times for each for a total of 4 valid times, listed below.
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, parm/use_cases/model_applications/climate/MODE_fcstCESM_obsGPCP_AsianMonsoonPrecip.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/model_applications/climate/MODE_fcstCESM_obsGPCP_AsianMonsoonPrecip.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 = 2014060100
INIT_END = 2014060200
INIT_INCREMENT = 86400
LEAD_SEQ = 24, 48
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
FCST_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/climate/CESM
FCST_MODE_INPUT_TEMPLATE = MetPlus.globe.{init?fmt=%Y-%m-%d}-00000.cam.h1.{init?fmt=%Y-%m-%d?shift=86400}-00000.nc
OBS_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/climate/GPCP
OBS_MODE_INPUT_TEMPLATE = gpcp_v01r03_daily_d{valid?fmt=%Y%m%d?shift=-86400}_c20170530.nc
MODE_OUTPUT_DIR = {OUTPUT_BASE}/climate/CESM_MODE
MODE_OUTPUT_TEMPLATE = {init?fmt=%Y_%m_%d_%H%M%S}
MODE_VERIFICATION_MASK_TEMPLATE = {FCST_MODE_INPUT_DIR}/asia_monsoon_cesm_mask.nc
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
MODEL = CESM
FCST_VAR1_NAME = PRECT
FCST_VAR1_LEVELS = "({valid?fmt=%Y%m%d_%H%M%S},*,*)"
FCST_VAR1_OPTIONS = convert(x) = 86400000*x;
MODE_FCST_FILTER_ATTR_NAME = AREA
MODE_FCST_FILTER_ATTR_THRESH = >=7
MODE_OBS_FILTER_ATTR_NAME = AREA
MODE_OBS_FILTER_ATTR_THRESH = >=7
OBTYPE = GPCP
OBS_VAR1_NAME = precip
OBS_VAR1_LEVELS = "(0,*,*)"
###
# MODE Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#mode
###
MODE_GRID_RES = 1
MODE_QUILT = True
MODE_CONV_RADIUS = 2
MODE_CONV_THRESH = ge12.0, ge25.0
MODE_MERGE_THRESH = ge10.0, ge20.0
MODE_MERGE_FLAG = THRESH
MODE_MATCH_FLAG = NO_MERGE
MODE_NC_PAIRS_FLAG_POLYLINES = False
MODE_MASK_POLY_FLAG = BOTH
MODE_WEIGHT_ASPECT_DIFF = 1.0
MODE_REGRID_TO_GRID = FCST
MODE_MASK_MISSING_FLAG = BOTH
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:
MODEConfig_wrapped
////////////////////////////////////////////////////////////////////////////////
//
// 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_compare_fcst =
${METPLUS_MULTIVAR_INTENSITY_COMPARE_FCST}
//multivar_intensity_compare_obs =
${METPLUS_MULTIVAR_INTENSITY_COMPARE_OBS}
//
// Forecast and observation fields to be verified
//
fcst = {
//field = {
${METPLUS_FCST_FIELD}
//censor_thresh = [
${METPLUS_FCST_CENSOR_THRESH}
//censor_val = [
${METPLUS_FCST_CENSOR_VAL}
//conv_radius =
${METPLUS_FCST_CONV_RADIUS}
//conv_thresh =
${METPLUS_FCST_CONV_THRESH}
//vld_thresh =
${METPLUS_FCST_VLD_THRESH}
//filter_attr_name = [
${METPLUS_FCST_FILTER_ATTR_NAME}
//filter_attr_thresh = [
${METPLUS_FCST_FILTER_ATTR_THRESH}
//merge_thresh =
${METPLUS_FCST_MERGE_THRESH}
//merge_flag =
${METPLUS_FCST_MERGE_FLAG}
${METPLUS_FCST_FILE_TYPE}
${METPLUS_FCST_MULTIVAR_NAME}
${METPLUS_FCST_MULTIVAR_LEVEL}
}
obs = {
//field = {
${METPLUS_OBS_FIELD}
//censor_thresh = [
${METPLUS_OBS_CENSOR_THRESH}
//censor_val = [
${METPLUS_OBS_CENSOR_VAL}
//conv_radius =
${METPLUS_OBS_CONV_RADIUS}
//conv_thresh =
${METPLUS_OBS_CONV_THRESH}
//vld_thresh =
${METPLUS_OBS_VLD_THRESH}
//filter_attr_name = [
${METPLUS_OBS_FILTER_ATTR_NAME}
//filter_attr_thresh = [
${METPLUS_OBS_FILTER_ATTR_THRESH}
//merge_thresh =
${METPLUS_OBS_MERGE_THRESH}
//merge_flag =
${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 = {
//centroid_dist = (
${METPLUS_INTEREST_FUNCTION_CENTROID_DIST}
//boundary_dist = (
${METPLUS_INTEREST_FUNCTION_BOUNDARY_DIST}
//convex_hull_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_TIME_OFFSET_WARNING}
${METPLUS_MET_CONFIG_OVERRIDES}
Python Embedding
This use case does not use Python embedding.
User Scripting
This use case does not use additional scripts. However, a sample NCL script to plot the output is available on the Sample Analysis Scripts page.
Running METplus
Pass the use case configuration file to the run_metplus.py script along with any user-specific system configuration files if desired:
run_metplus.py /path/to/METplus/parm/use_cases/model_applications/climate/MODE_fcstCESM_obsGPCP_AsianMonsoonPrecip.conf /path/to/user_system.conf
See Running METplus for more information.
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 {OUTPUT_BASE}/model_applications/climate/CESM_MODE and will contain the following files:
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T1_cts.txt
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T1_obj.nc
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T1_obj.txt
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T1.ps
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T2_cts.txt
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T2_obj.nc
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T2_obj.txt
* 2014_06_01_000000/mode_000000L_20140602_000000V_000000A_R1_T2.ps
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T1_cts.txt
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T1_obj.nc
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T1_obj.txt
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T1.ps
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T2_cts.txt
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T2_obj.nc
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T2_obj.txt
* 2014_06_01_000000/mode_000000L_20140603_000000V_000000A_R1_T2.ps
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T1_cts.txt
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T1_obj.nc
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T1_obj.txt
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T1.ps
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T2_cts.txt
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T2_obj.nc
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T2_obj.txt
* 2014_06_02_000000/mode_000000L_20140603_000000V_000000A_R1_T2.ps
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T1_cts.txt
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T1_obj.nc
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T1_obj.txt
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T1.ps
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T2_cts.txt
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T2_obj.nc
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T2_obj.txt
* 2014_06_02_000000/mode_000000L_20140604_000000V_000000A_R1_T2.ps
For the netCDF file, 18 variable fields are present (not including the lat/lon fields). Those variables are:
* fcst_raw(lat, lon)
* fcst_obj_raw(lat, lon)
* fcst_obj_id(lat, lon)
* fcst_clus_id(lat, lon)
* obs_raw(lat, lon)
* obs_obj_raw(lat, lon)
* obs_obj_id(lat, lon)
* obs_clus_id(lat, lon)
* fcst_conv_radius
* obs_conv_radius
* fcst_conv_threshold(fcst_thresh_length)
* obs_conv_threshold(obs_thresh_length)
* fcst_variable(fcst_variable_length)
* obs_variable(obs_variable_length)
* fcst_level(fcst_level_length)
* obs_level(obs_level_length)
* fcst_units(fcst_units_length)
* obs_units(obs_units_length)
Keywords
Note
MODEToolUseCase
ClimateAppUseCase
NetCDFFileUseCase
NCAROrgUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.