Note
Go to the end to download the full example code
TCPairs: Basic Use Case for Extra Tropical Cyclones
met_tool_wrapper/TCPairs/TCPairs_extra_tropical.conf
Scientific Objective
Once this method is complete, a forecast and reference track analysis file will have been paired up, allowing statistical information to be extracted.
Datasets
METplus Components
This use case utilizes the METplus TCPairs wrapper to search for files that are valid at a given run time and generate a command to run the MET tool tc_pairs.
METplus Workflow
TCPairs 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 /path/to/TCPairs_extra_tropical.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/TCPairs/TCPairs_extra_tropical.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 = TCPairs
###
# 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 = 2014121318
INIT_END = 2014121318
INIT_INCREMENT = 21600
TC_PAIRS_RUN_ONCE = True
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
TC_PAIRS_ADECK_INPUT_DIR = {INPUT_BASE}/met_test/new/track_data
TC_PAIRS_ADECK_TEMPLATE = {date?fmt=%Y%m}/a{basin?fmt=%s}q{date?fmt=%Y%m}*.gfso.{cyclone?fmt=%s}
TC_PAIRS_BDECK_INPUT_DIR = {TC_PAIRS_ADECK_INPUT_DIR}
TC_PAIRS_BDECK_TEMPLATE = {date?fmt=%Y%m}/b{basin?fmt=%s}q{date?fmt=%Y%m}*.gfso.{cyclone?fmt=%s}
TC_PAIRS_REFORMAT_DIR = {OUTPUT_BASE}/track_data_atcf
#TC_PAIRS_DIAG_DIR1 =
#TC_PAIRS_DIAG_TEMPLATE1 =
#TC_PAIRS_DIAG_SOURCE1 =
TC_PAIRS_OUTPUT_DIR = {OUTPUT_BASE}/tc_pairs
TC_PAIRS_OUTPUT_TEMPLATE = {date?fmt=%Y%m}/{basin?fmt=%s}q{date?fmt=%Y%m%d%H}.gfso.{cyclone?fmt=%s}
TC_PAIRS_SKIP_IF_OUTPUT_EXISTS = yes
TC_PAIRS_SKIP_IF_REFORMAT_EXISTS = yes
TC_PAIRS_READ_ALL_FILES = no
#TC_PAIRS_SKIP_LEAD_SEQ = False
TC_PAIRS_REFORMAT_DECK = yes
TC_PAIRS_REFORMAT_TYPE = SBU
###
# TCPairs Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#tcpairs
###
TC_PAIRS_CONFIG_FILE = {PARM_BASE}/met_config/TCPairsConfig_wrapped
TC_PAIRS_INIT_INCLUDE =
TC_PAIRS_INIT_EXCLUDE =
TC_PAIRS_INIT_BEG = 2014121318
TC_PAIRS_INIT_END = 2014121418
#TC_PAIRS_VALID_INCLUDE =
#TC_PAIRS_VALID_EXCLUDE =
#TC_PAIRS_WRITE_VALID =
TC_PAIRS_VALID_BEG =
TC_PAIRS_VALID_END =
MODEL =
#TC_PAIRS_DESC =
TC_PAIRS_STORM_ID =
TC_PAIRS_BASIN =
TC_PAIRS_CYCLONE =
TC_PAIRS_STORM_NAME =
TC_PAIRS_DLAND_FILE = {MET_INSTALL_DIR}/share/met/tc_data/dland_global_tenth_degree.nc
TC_PAIRS_MISSING_VAL_TO_REPLACE = -99
TC_PAIRS_MISSING_VAL = -9999
#TC_PAIRS_CONSENSUS1_NAME =
#TC_PAIRS_CONSENSUS1_MEMBERS =
#TC_PAIRS_CONSENSUS1_REQUIRED =
#TC_PAIRS_CONSENSUS1_MIN_REQ =
#TC_PAIRS_CONSENSUS1_WRITE_MEMBERS =
#TC_PAIRS_CHECK_DUP =
#TC_PAIRS_INTERP12 =
#TC_PAIRS_MATCH_POINTS =
#TC_PAIRS_DIAG_INFO_MAP1_DIAG_SOURCE =
#TC_PAIRS_DIAG_INFO_MAP1_TRACK_SOURCE =
#TC_PAIRS_DIAG_INFO_MAP1_FIELD_SOURCE =
#TC_PAIRS_DIAG_INFO_MAP1_MATCH_TO_TRACK =
#TC_PAIRS_DIAG_INFO_MAP1_DIAG_NAME =
#TC_PAIRS_DIAG_CONVERT_MAP1_DIAG_SOURCE =
#TC_PAIRS_DIAG_CONVERT_MAP1_KEY =
#TC_PAIRS_DIAG_CONVERT_MAP1_CONVERT =
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 TCPairs MET Configuration section of the User’s Guide for more information on the environment variables used in the file below:
////////////////////////////////////////////////////////////////////////////////
//
// Default TCPairs configuration file
//
////////////////////////////////////////////////////////////////////////////////
//
// ATCF file format reference:
// http://www.nrlmry.navy.mil/atcf_web/docs/database/new/abrdeck.html
//
//
// Models
//
${METPLUS_MODEL}
//
// Description
//
${METPLUS_DESC}
//
// Storm identifiers
//
${METPLUS_STORM_ID}
//
// Basins
//
${METPLUS_BASIN}
//
// Cyclone numbers
//
${METPLUS_CYCLONE}
//
// Storm names
//
${METPLUS_STORM_NAME}
//
// Model initialization time windows to include or exclude
//
${METPLUS_INIT_BEG}
${METPLUS_INIT_END}
// init_inc =
${METPLUS_INIT_INC}
// init_exc =
${METPLUS_INIT_EXC}
// valid_inc =
${METPLUS_VALID_INC}
// valid_exc =
${METPLUS_VALID_EXC}
// write_valid =
${METPLUS_WRITE_VALID}
//
// Valid model time window
//
${METPLUS_VALID_BEG}
${METPLUS_VALID_END}
//
// Model initialization hours
//
init_hour = [];
//
// Required lead time in hours
//
lead_req = [];
//
// lat/lon polylines defining masking regions
//
init_mask = "";
valid_mask = "";
//
// Specify if the code should check for duplicate ATCF lines
//
//check_dup =
${METPLUS_CHECK_DUP}
//
// Specify special processing to be performed for interpolated models.
// Set to NONE, FILL, or REPLACE.
//
//interp12 =
${METPLUS_INTERP12}
//
// Specify how consensus forecasts should be defined
//
//consensus =
${METPLUS_CONSENSUS_LIST}
//
// Forecast lag times
//
lag_time = [];
//
// CLIPER/SHIFOR baseline forecasts to be derived from the BEST
// and operational (CARQ) tracks.
//
best_technique = [ "BEST" ];
best_baseline = [];
oper_technique = [ "CARQ" ];
oper_baseline = [];
//
// Specify the datasets to be searched for analysis tracks (NONE, ADECK, BDECK,
// or BOTH).
//
anly_track = BDECK;
//
// Specify if only those track points common to both the ADECK and BDECK
// tracks be written out.
//
//match_points =
${METPLUS_MATCH_POINTS}
//
// Specify the NetCDF output of the gen_dland tool containing a gridded
// representation of the minimum distance to land.
//
${METPLUS_DLAND_FILE}
//
// Specify watch/warning information:
// - Input watch/warning filename
// - Watch/warning time offset in seconds
//
watch_warn = {
file_name = "MET_BASE/tc_data/wwpts_us.txt";
time_offset = -14400;
}
//diag_info_map = {
${METPLUS_DIAG_INFO_MAP_LIST}
//diag_convert_map = {
${METPLUS_DIAG_CONVERT_MAP_LIST}
//
// Indicate a version number for the contents of this configuration file.
// The value should generally not be modified.
//
//version = "V9.0";
tmp_dir = "${MET_TMP_DIR}";
${METPLUS_MET_CONFIG_OVERRIDES}
Running METplus
It is recommended to run this use case by:
Passing in TCPairs_extra_tropical.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/TCPairs_extra_tropical.conf -c /path/to/user_system.conf
The following METplus configuration variables must be set correctly to run this example.:
INPUT_BASE - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs).
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 tc_pairs/201412 (relative to OUTPUT_BASE) and will contain the following files:
mlq2014121318.gfso.0103.tcst
mlq2014121318.gfso.0104.tcst
Keywords
Note
TCPairsToolUseCase
SBUOrgUseCase
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-TCPairs.png’
Total running time of the script: (0 minutes 0.000 seconds)