5.1.23.1. TCMPRPlotter: Basic Use Case

met_tool_wrapper/TCMPRPlotter/TCMPRPlotter.conf

Scientific Objective

Generate plots of tropical cyclone tracks.

Datasets

No datasets are used in this use case, the tc-pairs output from the MET tc-pairs tool is used as input.

Location: All of the input data required for this use case can be found in the met_test sample data tarball. Click here to 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 utilizes the METplus TCMPRPlotter wrapper to invoke the the MET script tcmpr_plotter.R.

METplus Workflow

tcmpr_plotter.R is the only tool (script) called in this example.

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/TCMPRPlotter/TCMPRPlotter.conf

#
#  CONFIGURATION
#
[config]

# Loop over each process in the process list (set in PROCESS_LIST) for all times in the time window of
# interest.
LOOP_ORDER = processes

PROCESS_LIST = TCMPRPlotter

# The init time begin and end times, increment
LOOP_BY = INIT
INIT_TIME_FMT = %Y%m%d
INIT_BEG = 20141214
INIT_END = 20141214

# This is the step-size. Increment in seconds from the begin time to the end
# time
INIT_INCREMENT = 21600 ;; set to every 6 hours=21600 seconds

# A list of times to include, in format YYYYMMDD_hh
INIT_INCLUDE =

# A list of times to exclude, in format YYYYMMDD_hh
INIT_EXCLUDE =

#
# Specify model valid time window in format YYYYMM[DD[_hh]].  Only tracks
# that fall within the valid time window will
# be used.
#
VALID_BEG =
VALID_END =

#  Plot_TCMPR options, if left unset, default values that are
#  pre-defined in the R utility (packaged with MET) will be used.

# Config file used to customize the plot, the tcmpr_customize.conf
# file is used to resize the plot that is produced so that it doesn't
# fill the entire screen.
TCMPR_PLOTTER_CONFIG_FILE = {PARM_BASE}/use_cases/met_tool_wrapper/TCMPRPlotter/TCMPRPlotterConfig_Customize
TCMPR_PLOTTER_PREFIX =
TCMPR_PLOTTER_TITLE =
TCMPR_PLOTTER_SUBTITLE = Your Subtitle Goes Here
TCMPR_PLOTTER_XLAB =
TCMPR_PLOTTER_YLAB = Your y-label Goes Here
TCMPR_PLOTTER_XLIM =
TCMPR_PLOTTER_YLIM =
TCMPR_PLOTTER_FILTER =
# The tcst data file to be used instead of running the MET tc_stat tool
TCMPR_PLOTTER_FILTERED_TCST_DATA_FILE =
# Comma separated, no whitespace.  Default is TK_ERR (track error) unless
# otherwise indicated.
TCMPR_PLOTTER_DEP_VARS = AMSLP-BMSLP,AMAX_WIND-BMAX_WIND,TK_ERR
TCMPR_PLOTTER_SCATTER_X =
TCMPR_PLOTTER_SCATTER_Y =
TCMPR_PLOTTER_SKILL_REF =
TCMPR_PLOTTER_SERIES =
TCMPR_PLOTTER_SERIES_CI =
TCMPR_PLOTTER_LEGEND =
TCMPR_PLOTTER_LEAD =
# Default plot is boxplot, unless otherwise indicated.  If box plot is needed
# in addition to other plots, this needs to be indicated.
TCMPR_PLOTTER_PLOT_TYPES = MEAN, MEDIAN
TCMPR_PLOTTER_RP_DIFF =
TCMPR_PLOTTER_DEMO_YR =
TCMPR_PLOTTER_HFIP_BASELINE =
TCMPR_PLOTTER_FOOTNOTE_FLAG =
TCMPR_PLOTTER_PLOT_CONFIG_OPTS =
TCMPR_PLOTTER_SAVE_DATA =

#  TCMPR FLAGS no == (don't set flag), yes == (set flag)
TCMPR_PLOTTER_NO_EE = no
TCMPR_PLOTTER_NO_LOG = no
TCMPR_PLOTTER_SAVE = no


#
#  DIRECTORIES
#
[dir]
# Location of your model data of interest
TC_PAIRS_OUTPUT_DIR = {INPUT_BASE}/model_applications/medium_range/tc_pairs
TCMPR_PLOTTER_TCMPR_DATA_DIR = {TC_PAIRS_OUTPUT_DIR}
TCMPR_PLOTTER_PLOT_OUTPUT_DIR = {OUTPUT_BASE}/tcmpr_plots

MET Configuration

A MET configuration is not needed to run this single wrapper use case.

Running METplus

This use case can be run two ways:

1. Passing in TCMPRPlotter.conf then a user-specific system configuration file:

   run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/TCMPRPlotter/TCMPRPlotter.conf -c /path/to/user_system.conf
   

2. Modifying the configurations in parm/metplus_config, then passing in TCMPRPlotter.conf:

   run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/TCMPRPlotter/TCMPRPlotter.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 tcmpr_plots/2005080700 (relative to OUTPUT_BASE) and will contain the following files:

• AMAX_WIND-BMAX_WIND_mean.png

• AMAX_WIND-BMAX_WIND_mean.png

• AMSLP-BMSLP_mean.png

• AMSLP-BMSLP_median.png

• TK_ERR_mean.png

• TK_ERR_median.png

Keywords

Note

TCMPRPlotterUseCase