UserScript: Run Once Per Lead Use Case

met_tool_wrapper/UserScript/UserScript_run_once_per_lead.conf

Scientific Objective

Demonstrate how to run a user-defined script that should be executed once for each forecast lead time. This use case runs a simple ls command to list the contents of a directory. A wildcard character (*) is used to replace filename template tags for valid and init to find all files that match any of the times available.

Datasets

Input: Empty test files from the METplus repository

METplus Components

This use case utilizes the METplus UserScript wrapper to generate a command that is specified by the user.

METplus Workflow

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

Forecast Lead: 0 hour

Forecast Lead: 12 hour

Forecast Lead: 24 hour

Forecast Lead: 120 hour

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/UserScript/UserScript_run_once_per_lead.conf

[config]

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


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

USER_SCRIPT_RUNTIME_FREQ = RUN_ONCE_PER_LEAD

LOOP_BY = INIT
INIT_TIME_FMT = %Y%m%d%H%M%S
INIT_BEG = 20141031093015
INIT_END = 20141101093015
INIT_INCREMENT = 12H

LEAD_SEQ = 0H, 12H, 24H, 120H

USER_SCRIPT_CUSTOM_LOOP_LIST = nc


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

USER_SCRIPT_INPUT_TEMPLATE = init_{init?fmt=%Y%m%d%H%M%S}_valid_{valid?fmt=%Y%m%d%H%M%S}_lead_{lead?fmt=%3H}.{custom}
USER_SCRIPT_INPUT_DIR = {INPUT_BASE}/met_test/new/test


###
# UserScript Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#userscript
###

USER_SCRIPT_COMMAND = {PARM_BASE}/use_cases/met_tool_wrapper/UserScript/print_file_list.py

MET Configuration

None. UserScript does not use configuration files.

Running METplus

This use case can be run two ways:

1. Passing in UserScript_run_once_per_lead.conf_run_once then a user-specific system configuration file:

   run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/UserScript/UserScript_run_once_per_lead.conf_run_once -c /path/to/user_system.conf
   

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

   run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridStat/UserScript_run_once_per_lead.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.

No output files are generated from this use case, but the logfile will contain the results of the directory listing command(s)

Forecast Lead: 0 hour

• init_20141031093015_valid_20141031093015_lead_000.nc

• init_20141031213015_valid_20141031213015_lead_000.nc

• init_20141101093015_valid_20141101093015_lead_000.nc

Forecast Lead: 12 hour

• init_20141030213015_valid_20141031093015_lead_012.nc

• init_20141031093015_valid_20141031213015_lead_012.nc

• init_20141031213015_valid_20141101093015_lead_012.nc

• init_20141101093015_valid_20141101213015_lead_012.nc

Forecast Lead: 24 hour

• init_20141030093015_valid_20141031093015_lead_024.nc

• init_20141030213015_valid_20141031213015_lead_024.nc

• init_20141031093015_valid_20141101093015_lead_024.nc

• init_20141031213015_valid_20141101213015_lead_024.nc

• init_20141101093015_valid_20141102093015_lead_024.nc

Forecast Lead: 120 hour

• init_20141026093015_valid_20141031093015_lead_120.nc

• init_20141026213015_valid_20141031213015_lead_120.nc

• init_20141027093015_valid_20141101093015_lead_120.nc

• init_20141031093015_valid_20141105093015_lead_120.nc

• init_20141031213015_valid_20141105213015_lead_120.nc

• init_20141101093015_valid_20141106093015_lead_120.nc

Keywords

Note

• UserScriptUseCase

• RuntimeFreqUseCase

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