5.2.9.6. UserScript: Make a Hovmoeller plot

model_applications/ s2s/ UserScript_obsPrecip_obsOnly_Hovmoeller.py

Scientific Objective

This use case calls the METplotpy hovmoeller plot to create a sample Hovmoeller diagram using sample data created by METcalcpy hovmoeller functions

The Hovmoeller plot and hovmoeller calculations were created by Maria Gehne at the Physical Sciences Labratory in NOAA

Datasets

METplus Components

This use case runs the UserScript wrapper tool to run a user provided script, in this case, hovmoeller.py.

METplus Workflow

This use case does not loop but plots the entire time period of data

UserScript This uses data from 2016-01-01 to 2016-03-31

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/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf

[config]

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

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

# BLank for this usecase but the parameter still needs to be there 
VALID_BEG = 

# BLank for this usecase but the parameter still needs to be there 
VALID_END =

# BLank for this usecase but the parameter still needs to be there 
VALID_INCREMENT = 

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

# 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

PROCESS_LIST = UserScript

USER_SCRIPT_RUNTIME_FREQ = RUN_ONCE 

USER_SCRIPT_COMMAND = {PARM_BASE}/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller/hovmoeller_diagram.py


[user_env_vars]

# Difficulty index specific variables

LOG_FILE = "Hovmoeller_diagram.log"

LOG_LEVEL = "INFO"

INPUT_FILE_NAME = {INPUT_BASE}/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller/precip.erai.sfc.1p0.2x.2014-2016.nc
YAML_CONFIG_NAME = {PARM_BASE}/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller/hovmoeller.yaml

METPLOTPY_BASE = {METPLUS_BASE}/../METplotpy/metplotpy/
OUTPUT_DIR = {OUTPUT_BASE}/plots

MET Configuration

There are no MET tools used in this use case.

Python Embedding

There is no python embedding in this use case

Running METplus

This use case can be run two ways:

1) Passing in hovmoeller_diagram.conf, then a user-specific system configuration file:

run_metplus.py \
-c /path/to/METplus/parm/use_cases/model_applications/s2s/hovmoeller_diagram.conf \
-c /path/to/user_system.conf

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

   run_metplus.py \
   -c /path/to/METplus/parm/use_cases/model_applications/s2s/hovmoeller_diagram.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

and for the [exe] section, you will need to define the location of NON-MET executables. If the executable is in the user’s path, METplus will find it from the name. If the executable is not in the path, specify the full path to the executable here (i.e. RM = /bin/rm) The following executables are required for performing series analysis use cases:

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

[exe]
RM = /path/to/rm
CUT = /path/to/cut
TR = /path/to/tr
NCAP2 = /path/to/ncap2
CONVERT = /path/to/convert
NCDUMP = /path/to/ncdump

Expected Output

A successful run will output the following both to the screen and to the logfile:

INFO: METplus has successfully finished running.

Keywords

Note

UserScriptUseCase, S2SAppUseCase,

sphinx_gallery_thumbnail_path = ‘_static/Hovmoeller_ERAIprecip_2016-01-01-2016-03-31.png’