Note

Click here to download the full example code

5.1.27.4. UserScript: Run Once Per Valid Use Case

met_tool_wrapper/UserScript/UserScript_run_once_per_valid.conf

Scientific Objective

Demonstrate how to run a user-defined script that should be executed once for each valid 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 init and lead 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:

Valid: 2014-10-31 09:30:15
Valid: 2014-10-31 21:30:15
Valid: 2014-11-01 09:30:15

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_valid.conf

# UserScript wrapper example

[config]

# List of applications to run - only UserScript for this case
PROCESS_LIST = UserScript


# time looping - 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
LOOP_BY = VALID

# Format of VALID_BEG and VALID_END using % items
# %Y = 4 digit year, %m = 2 digit month, %d = 2 digit day, etc.
# see www.strftime.org for more information
# %Y%m%d%H expands to YYYYMMDDHH
VALID_TIME_FMT = %Y%m%d%H%M%S

# Start time for METplus run - must match VALID_TIME_FMT
VALID_BEG = 20141031093015

# End time for METplus run - must match VALID_TIME_FMT
VALID_END = 20141101093015

# Increment between METplus runs (in seconds if no units are specified)
#  Must be >= 60 seconds
VALID_INCREMENT = 12H

# List of forecast leads to process for each run time (init or valid)
# In hours if units are not specified
# If unset, defaults to 0 (don't loop through forecast leads)
LEAD_SEQ = 0H, 12H, 24H, 120H

# Order of loops to process data - Options are times, processes
# Not relevant if only one item is in the PROCESS_LIST
# times = run all wrappers in the PROCESS_LIST for a single run time, then
#   increment the run time and run all wrappers again until all times have
#   been evaluated.
# processes = run the first wrapper in the PROCESS_LIST for all times
#   specified, then repeat for the next item in the PROCESS_LIST until all
#   wrappers have been run
LOOP_ORDER = processes

# list of strings to loop over for each run time.
# value for each item can be referenced in filename templates with {custom?fmt=%s}
USER_SCRIPT_CUSTOM_LOOP_LIST = nc

USER_SCRIPT_RUNTIME_FREQ = RUN_ONCE_PER_INIT_OR_VALID

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

USER_SCRIPT_COMMAND = ls {USER_SCRIPT_INPUT_DIR}/{USER_SCRIPT_INPUT_TEMPLATE}

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_valid.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_valid.conf_run_once -c /path/to/user_system.conf

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

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

Valid time: 2014-10-31 09:30:15

  • init_20141024093015_valid_20141031093015_lead_168.nc

  • init_20141025093015_valid_20141031093015_lead_144.nc

  • init_20141026093015_valid_20141031093015_lead_120.nc

  • init_20141027093015_valid_20141031093015_lead_096.nc

  • init_20141028093015_valid_20141031093015_lead_072.nc

  • init_20141029093015_valid_20141031093015_lead_048.nc

  • init_20141030093015_valid_20141031093015_lead_024.nc

  • init_20141030213015_valid_20141031093015_lead_012.nc

  • init_20141031093015_valid_20141031093015_lead_000.nc

Valid time: 2014-10-31 21:30:15

  • init_20141024213015_valid_20141031213015_lead_168.nc

  • init_20141025213015_valid_20141031213015_lead_144.nc

  • init_20141026213015_valid_20141031213015_lead_120.nc

  • init_20141027213015_valid_20141031213015_lead_096.nc

  • init_20141028213015_valid_20141031213015_lead_072.nc

  • init_20141029213015_valid_20141031213015_lead_048.nc

  • init_20141030213015_valid_20141031213015_lead_024.nc

  • init_20141031093015_valid_20141031213015_lead_012.nc

  • init_20141031213015_valid_20141031213015_lead_000.nc

Valid time: 2014-11-01 09:30:15

  • init_20141025093015_valid_20141101093015_lead_168.nc

  • init_20141026093015_valid_20141101093015_lead_144.nc

  • init_20141027093015_valid_20141101093015_lead_120.nc

  • init_20141028093015_valid_20141101093015_lead_096.nc

  • init_20141029093015_valid_20141101093015_lead_072.nc

  • init_20141030093015_valid_20141101093015_lead_048.nc

  • init_20141031093015_valid_20141101093015_lead_024.nc

  • init_20141031213015_valid_20141101093015_lead_012.nc

  • init_20141101093015_valid_20141101093015_lead_000.nc

Keywords

Note

UserScriptUseCase, RuntimeFreqUseCase

Total running time of the script: ( 0 minutes 0.000 seconds)

Gallery generated by Sphinx-Gallery