RMWAnalysis: Basic Use Case

met_tool_wrapper/RMWAnalysis/RMWAnalysis.conf

Scientific Objective

The RMW-Analysis tool analyzes a set of output files generated by the TC-RMW tool.

Datasets

Data: TC-RMW output

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 runs the METplus RMWAnalysis wrapper to analyze TC-RMW output.

METplus Workflow

RMWAnalysis is the only tool called in this example. It processes the following run times:

Init: 2023

METplus Configuration

parm/use_cases/met_tool_wrapper/RMWAnalysis/RMWAnalysis.conf

[config]

# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/RMWAnalysis/RMWAnalysis.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 = RMWAnalysis


###
# 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
###

RMW_ANALYSIS_RUNTIME_FREQ = RUN_ONCE

LOOP_BY = INIT
INIT_TIME_FMT = %Y
INIT_BEG=2023


RMW_ANALYSIS_CUSTOM_LOOP_LIST =

###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###

RMW_ANALYSIS_INPUT_DIR = {INPUT_BASE}/met_test/new/tc_rmw
RMW_ANALYSIS_INPUT_TEMPLATE = tc_rmw_aal14{init?fmt=%Y}.nc

RMW_ANALYSIS_OUTPUT_DIR = {OUTPUT_BASE}/rmw_analysis
RMW_ANALYSIS_OUTPUT_TEMPLATE = rmw_analysis_aal14{init?fmt=%Y}.nc


###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###

BOTH_VAR1_NAME = PRMSL
BOTH_VAR2_NAME = TMP

###
# RMWAnalysis Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#rmwanalysis
###

#LOG_RMW_ANALYSIS_VERBOSITY = 2

RMW_ANALYSIS_CONFIG_FILE = {PARM_BASE}/met_config/RMWAnalysisConfig_wrapped

#RMW_ANALYSIS_MODEL =

#RMW_ANALYSIS_BASIN =

#RMW_ANALYSIS_STORM_NAME =

#RMW_ANALYSIS_STORM_ID =

#RMW_ANALYSIS_CYCLONE =

#RMW_ANALYSIS_INIT_BEG =
#RMW_ANALYSIS_INIT_END =

#RMW_ANALYSIS_VALID_BEG =
#RMW_ANALYSIS_VALID_END =

#RMW_ANALYSIS_INIT_MASK =
#RMW_ANALYSIS_VALID_MASK =

MET Configuration

Note

See the RMWAnalysis MET Configuration section of the User’s Guide for more information on the environment variables used in the file below.

parm/met_config/RMWAnalysisConfig_wrapped

////////////////////////////////////////////////////////////////////////////////
//
// RMW-Analysis configuration file.
//
// For additional information, please see the MET Users Guide.
//
////////////////////////////////////////////////////////////////////////////////

//
// Data
//
data = {
  ${METPLUS_DATA_FIELD}
}

////////////////////////////////////////////////////////////////////////////////

//
// Model
//
//model =
${METPLUS_MODEL}

//
// Basin
//
//basin =
${METPLUS_BASIN}

//
// Storm name
//
//storm_name =
${METPLUS_STORM_NAME}

//
// Storm identifier
//
//storm_id =
${METPLUS_STORM_ID}

//
// Cyclone number
//
//cyclone =
${METPLUS_CYCLONE}

//
// Initialization model time window
//
//init_beg =
${METPLUS_INIT_BEG}
//init_end =
${METPLUS_INIT_END}

//
// Valid model time window
//
//valid_beg =
${METPLUS_VALID_BEG}
//valid_end =
${METPLUS_VALID_END}

//
// lat/lon polylines defining masking regions
//
//init_mask =
${METPLUS_INIT_MASK}
//valid_mask =
${METPLUS_VALID_MASK}

////////////////////////////////////////////////////////////////////////////////

tmp_dir = "${MET_TMP_DIR}";

//version = "V12.1.0";

////////////////////////////////////////////////////////////////////////////////

${METPLUS_MET_CONFIG_OVERRIDES}

Running METplus

Provide the use case .conf configuration file to the run_metplus.py script.

/path/to/METplus/parm/use_cases/met_tool_wrapper/RMWAnalysis/RMWAnalysis.conf

See the Running METplus section of the System Configuration chapter for more details.

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 rmw_analysis (relative to OUTPUT_BASE) and will contain the following files:

• rmw_analysis_aal142023.nc

Keywords

Note

• RMWAnalysisToolUseCase

Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.

#