Note
Go to the end to download the full example code
TCRMW: Basic Use Case
met_tool_wrapper/TCRMW/TCRMW.conf
Scientific Objective
The TC-RMW tool regrids tropical cyclone model data onto a moving range-azimuth grid centered on points along the storm track. This capability replicates the NOAA Hurricane Research Division DIA-Post module.
Datasets
METplus Components
This use case utilizes the METplus TCRMW wrapper to search for the desired ADECK file and forecast files that are correspond to the track. It generates a command to run the MET tool TC-RMW if all required files are found.
METplus Workflow
TCRMW 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/TCRMW/TCRMW.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/TCRMW/TCRMW.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 = TCRMW
###
# 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 = 2016092900
INIT_END = 2016092900
INIT_INCREMENT = 21600
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
TC_RMW_DECK_INPUT_DIR = {INPUT_BASE}/met_test/new/tc_data/adeck
TC_RMW_DECK_TEMPLATE = aal14{date?fmt=%Y}_short.dat
TC_RMW_INPUT_DIR = {INPUT_BASE}/met_test/new/model_data/grib2/gfs_fv3
TC_RMW_INPUT_TEMPLATE = gfs.subset.t00z.pgrb2.0p25.f*
TC_RMW_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/TCRMW
TC_RMW_OUTPUT_TEMPLATE = tc_rmw_aal14{date?fmt=%Y}.nc
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
BOTH_VAR1_NAME = PRMSL
BOTH_VAR1_LEVELS = L0
BOTH_VAR2_NAME = TMP
BOTH_VAR2_LEVELS = P1000, P900, P800, P700, P500, P100
###
# TCRMW Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#tcrmw
###
#LOG_TC_RMW_VERBOSITY = 2
TC_RMW_CONFIG_FILE = {PARM_BASE}/met_config/TCRMWConfig_wrapped
MODEL = fv3
#TC_RMW_DESC =
#TC_RMW_REGRID_METHOD = NEAREST
#TC_RMW_REGRID_WIDTH = 1
#TC_RMW_REGRID_VLD_THRESH = 0.5
#TC_RMW_REGRID_SHAPE = SQUARE
#TC_RMW_REGRID_CONVERT =
#TC_RMW_REGRID_CENSOR_THRESH =
#TC_RMW_REGRID_CENSOR_VAL =
TC_RMW_STORM_ID = AL142016
TC_RMW_BASIN = AL
TC_RMW_CYCLONE = 14
#TC_RMW_N_RANGE = 100
#TC_RMW_N_AZIMUTH = 180
#TC_RMW_MAX_RANGE_KM = 1000.0
#TC_RMW_DELTA_RANGE_KM = 10.0
#TC_RMW_SCALE = 0.2
#TC_RMW_INIT_INCLUDE =
#TC_RMW_VALID_BEG =
#TC_RMW_VALID_END =
#TC_RMW_VALID_INCLUDE_LIST =
#TC_RMW_VALID_EXCLUDE_LIST =
#TC_RMW_VALID_HOUR_LIST =
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 TCRMW MET Configuration section of the User’s Guide for more information on the environment variables used in the file below:
////////////////////////////////////////////////////////////////////////////////
//
// TC-RMW configuration file.
//
// For additional information, see the MET_BASE/config/README_TC file.
//
////////////////////////////////////////////////////////////////////////////////
// The following environment variables set the text if the corresponding
// variables at defined in the METplus config. If not, they are set to
// and empty string, which will cause MET to use the value defined in the
// default configuration file.
${METPLUS_MODEL}
${METPLUS_STORM_ID}
${METPLUS_BASIN}
${METPLUS_CYCLONE}
${METPLUS_INIT_INCLUDE}
${METPLUS_VALID_BEG}
${METPLUS_VALID_END}
${METPLUS_VALID_INCLUDE_LIST}
${METPLUS_VALID_EXCLUDE_LIST}
${METPLUS_VALID_HOUR_LIST}
${METPLUS_LEAD_LIST}
//
// May be set separately in each "field" entry
//
censor_thresh = [];
censor_val = [];
//
// Data fields
//
data = {
${METPLUS_DATA_FILE_TYPE}
${METPLUS_DATA_FIELD}
}
////////////////////////////////////////////////////////////////////////////////
//
// Regridding options
//
${METPLUS_REGRID_DICT}
//
// Range-Azimuth grid parameters
//
// The following environmnet variables set the text if the corresponding
// variables at defined in the METplus config. If not, they are set to
// and empty string, which will cause MET to use the value defined in the
// default configuration file.
${METPLUS_N_RANGE}
${METPLUS_N_AZIMUTH}
${METPLUS_MAX_RANGE_KM}
${METPLUS_DELTA_RANGE_KM}
${METPLUS_RMW_SCALE}
////////////////////////////////////////////////////////////////////////////////
//version = "V10.0";
////////////////////////////////////////////////////////////////////////////////
tmp_dir = "${MET_TMP_DIR}";
${METPLUS_MET_CONFIG_OVERRIDES}
Running METplus
This use case can be run two ways:
Passing in TCRMW.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/TCRMW/TCRMW.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in TCRMW.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/TCRMW/TCRMW.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 met_tool_wrapper/TCRMW (relative to OUTPUT_BASE) and will contain the following files:
tc_rmw_aal142016.nc
Keywords
Note
TCRMWToolUseCase
GRIB2FileUseCase
TropicalCycloneUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-TCRMW.png’
Total running time of the script: (0 minutes 0.000 seconds)