Note
Go to the end to download the full example code
MODE: Brightness Temperature Verification
model_applications/ short_range/ MODE_fcstFV3_obsGOES_BrightnessTemp.conf
Scientific Objective
To provide statistical inforation on regions of low brightness temperatures, defined by creating objects, in the FV3 model compared to GOES satellite.
Datasets
Forecast dataset: FV3 Model member data
Observation dataset: GOES Brightness Temperature
METplus Components
This use case runs MODE to create object statistics on brightness temperatures below 235 K.
METplus Workflow
The MODE tool is run for each of 2 ensemble members and for eachtime. This example loops by initialization time. It processes 2 lead 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 with the -c option, i.e. -c parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.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(lsm1), MODE(mp1)
###
# 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 = 2019052100
INIT_END = 2019052100
INIT_INCREMENT = 3600
LEAD_SEQ = 1,2
###
# 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/short_range/brightness_temperature
FCST_MODE_INPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/core_{instance}/core_{instance}_{init?fmt=%Y%m%d}_{init?fmt=%H%M}_f{lead?fmt=%HH}.nc
OBS_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/short_range/brightness_temperature
OBS_MODE_INPUT_TEMPLATE = {valid?fmt=%Y_%m_%d}_141/remap_GOES-16.{valid?fmt=%Y%m%d}.{valid?fmt=%H%M%S}.nc
MODE_OUTPUT_DIR = {OUTPUT_BASE}/short_range/brightness_temperature
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
MODEL = FV3_core
FCST_VAR1_NAME = SBTA1613_topofatmosphere
FCST_VAR1_LEVELS = "(*,*)"
FCST_VAR1_OPTIONS = file_type = NETCDF_MET;
MODE_FCST_CENSOR_THRESH = <=0
MODE_FCST_CENSOR_VAL = 9999
OBTYPE = GOES
OBS_VAR1_NAME = channel_13_brightness_temperature
OBS_VAR1_LEVELS = "(*,*)"
OBS_VAR1_OPTIONS = file_type = NETCDF_MET;
MODE_OBS_CENSOR_THRESH = <=0
MODE_OBS_CENSOR_VAL = 9999
###
# MODE Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#mode
###
MODE_QUILT = FALSE
MODE_CONV_RADIUS = 5
MODE_CONV_THRESH = <=235
MODE_MERGE_THRESH = <=235
MODE_MERGE_FLAG = NONE
MODE_GRID_RES = 3
MODE_MAX_CENTROID_DIST = 600.0/grid_res
MODE_INTEREST_FUNCTION_CENTROID_DIST = ( ( 0.0, 1.0 ) ( 60.0/grid_res, 1.0 ) ( 450.0/grid_res, 0.0 ) )
MODE_MASK_MISSING_FLAG = BOTH
MODE_WEIGHT_CENTROID_DIST = 4.0
MODE_WEIGHT_BOUNDARY_DIST = 3.0
MODE_WEIGHT_CONVEX_HULL_DIST = 1.0
MODE_WEIGHT_AREA_RATIO = 4.0
MODE_WEIGHT_INT_AREA_RATIO = 3.0
MODE_TOTAL_INTEREST_THRESH = 0.65
MODE_REGRID_TO_GRID = NONE
MODE_OUTPUT_PREFIX = FV3_core_{instance}
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_fcstFV3_obsGOES_BrightnessTemp.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in MODE_fcstFV3_obsGOES_BrightnessTemp.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTemp.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 short_range/brightness_temperature (relative to OUTPUT_BASE) and will contain the following files:
mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_cts.txt mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_obj.nc mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_obj.txt mode_FV3_core_lsm1_010000L_20190521_010000V_NAA.ps mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_cts.txt mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_obj.nc mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_obj.txt mode_FV3_core_lsm1_010000L_20190521_020000V_NAA.ps mode_FV3_core_mp1_010000L_20190521_010000V_NAA_cts.txt mode_FV3_core_mp1_010000L_20190521_010000V_NAA_obj.nc mode_FV3_core_mp1_010000L_20190521_010000V_NAA_obj.txt mode_FV3_core_mp1_010000L_20190521_010000V_NAA.ps mode_FV3_core_mp1_010000L_20190521_020000V_NAA_cts.txt mode_FV3_core_mp1_010000L_20190521_020000V_NAA_obj.nc mode_FV3_core_mp1_010000L_20190521_020000V_NAA_obj.txt mode_FV3_core_mp1_010000L_20190521_020000V_NAA.ps
Keywords
Note
MODEToolUseCase
MODEToolUseCase
ShortRangeAppUseCase
NetCDFFileUseCase
NOAAEMCOrgUseCase
NOAAHWTOrgUseCase
ValidationUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/short_range-MODE_fcstFV3_obsGOES_BrightnessTemp.png’
Total running time of the script: (0 minutes 0.000 seconds)