Note
Click here to download the full example code
5.1.22.1. 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
#
# CONFIGURATION
#
[config]
# Looping by times: steps through each 'task' in the PROCESS_LIST for each
# defined time, and repeats until all times have been evaluated.
LOOP_ORDER = times
# 'Tasks' to be run
PROCESS_LIST = TCRMW
LOOP_BY = INIT
# The init time begin and end times, increment, and last init hour.
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG = 2016092900
INIT_END = 2016092900
# This is the step-size. Increment in seconds from the begin time to the end time
# set to 6 hours = 21600 seconds
INIT_INCREMENT = 21600
LOG_TC_RMW_VERBOSITY = 2
TC_RMW_CONFIG_FILE = {CONFIG_DIR}/TCRMWConfig_wrapped
MODEL = fv3
BOTH_VAR1_NAME = PRMSL
BOTH_VAR1_LEVELS = L0
BOTH_VAR2_NAME = TMP
BOTH_VAR2_LEVELS = P1000, P900, P800, P700, P500, P100
# The following variables set values in the MET
# configuration file used by this example
# Leaving these values commented will use the value
# found in the default MET configuration file
#TC_RMW_REGRID_METHOD = NEAREST
#TC_RMW_REGRID_WIDTH = 1
#TC_RMW_REGRID_VLD_THRESH = 0.5
#TC_RMW_REGRID_SHAPE = SQUARE
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 =
#
# DIRECTORIES
#
[dir]
# location of configuration files used by MET applications
CONFIG_DIR={PARM_BASE}/met_config
# Location of input track data directory for DECK data
#TC_RMW_DECK_INPUT_DIR = /d1/projects/MET/MET_test_data/unit_test/tc_data/adeck
TC_RMW_DECK_INPUT_DIR = {INPUT_BASE}/met_test/new/tc_data/adeck
#TC_RMW_INPUT_DIR = /d1/projects/MET/MET_test_data/unit_test/model_data/grib2/gfs_fv3
TC_RMW_INPUT_DIR = {INPUT_BASE}/met_test/new/model_data/grib2/gfs_fv3
TC_RMW_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/TCRMW
[filename_templates]
#TC_RMW_DECK_TEMPLATE = a{basin?fmt=%s}{cyclone?fmt=%s}{date?fmt=%Y}.dat
TC_RMW_DECK_TEMPLATE = aal14{date?fmt=%Y}_short.dat
#TC_RMW_INPUT_TEMPLATE = gfs.t00z.pgrb2.0p25.f144
TC_RMW_INPUT_TEMPLATE = gfs.subset.t00z.pgrb2.0p25.f*
TC_RMW_OUTPUT_TEMPLATE = tc_rmw_aal14{date?fmt=%Y}.nc
MET Configuration¶
METplus sets environment variables based on the values in the METplus configuration file. These variables are referenced in the MET configuration file. 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 not controlled by an environment variable, you can add additional environment variables to be set only within the METplus environment using the [user_env_vars] section of the METplus configuration files. See the ‘User Defined Config’ section on the ‘System Configuration’ page of the METplus User’s Guide for more information.
////////////////////////////////////////////////////////////////////////////////
//
// 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.
// ${MODEL} sets "model = <user setting>;"
// ${STORM_ID} sets "storm_id = <user setting>;"
// ${BASIN} sets "basin = <user setting>;"
// ${CYCLONE} sets "cyclone = <user setting>;"
// ${STORM_NAME} sets " = <user setting>;"
// ${INIT_INCLUDE} sets "init_inc = <user setting>;"
// ${VALID_BEG} sets "valid_beg = <user setting>;"
// ${VALID_END} sets "valid_end = <user setting>;"
// ${VALID_INCLUDE_LIST} sets "valid_inc = [<user setting>];"
// ${VALID_EXCLUDE_LIST} sets "valid_exc = [<user setting>];"
// ${VALID_HOUR_LIST} sets "valid_hour = [<user setting>];"
// ${LEAD_LIST} sets "lead = [<user setting>];"
${MODEL}
${STORM_ID}
${BASIN}
${CYCLONE}
${INIT_INCLUDE}
${VALID_BEG}
${VALID_END}
${VALID_INCLUDE_LIST}
${VALID_EXCLUDE_LIST}
${VALID_HOUR_LIST}
${LEAD_LIST}
//
// May be set separately in each "field" entry
//
censor_thresh = [];
censor_val = [];
//
// Data fields
//
data = {
${DATA_FILE_TYPE}
field = [ ${DATA_FIELD} ];
}
////////////////////////////////////////////////////////////////////////////////
//
// Regridding options
//
${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.
// ${N_RANGE} sets "n_range = <user setting>;"
// ${N_AZIMUTH} sets "n_azimuth = <user setting>;"
// ${MAX_RANGE_KM} sets "max_range_km = <user setting>;"
// ${DELTA_RANGE_KM} sets "delta_range_km = <user setting>;"
// ${RMW_SCALE} sets "rmw_scale = <user setting>;"
${N_RANGE}
${N_AZIMUTH}
${MAX_RANGE_KM}
${DELTA_RANGE_KM}
${RMW_SCALE}
////////////////////////////////////////////////////////////////////////////////
version = "V9.1";
////////////////////////////////////////////////////////////////////////////////
See the TCRMW MET Configuration section of the User’s Guide for more information on the environment variables set in this file.
Running METplus¶
This use case can be run two ways:
Passing in TCRMW.conf then a user-specific system configuration file:
master_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:
master_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