Note
Go to the end to download the full example code.
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 where created by Maria Gehne at the Physical Sciences Labratory in NOAA
Version Added
METplus version 4.1
Datasets
Forecast: None
Observation: ERAI
Climatology: None
Location: All of the input data required for this use case can be found in a sample data tarball. Each use case category will have one or more sample data tarballs. It is only necessary to download the tarball with the use case’s dataset and not the entire collection of sample data. Click here to access 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 UserScript wrapper tool to run a user provided script, in this case, hovmoeller.py.
It also requires the METcalcpy and METplotpy source code to generate the plot. Clone the METcalcpy repository (https://github.com/dtcenter/METcalcpy) and the METplotpy repository (https://github.com/dtcenter/METplotpy) under the same base directory as the METPLUS_BASE directory so that the METplotpy, METcalcpy, and METplotpy directories are under the same base directory (i.e. if the METPLUS_BASE directory is /home/username/working/METplus, then clone the METcalcpy and METplotpy source code into the /home/username/working directory).
METplus Workflow
Beginning time (VALID_BEG): None
End time (VALID_END): None
Increment between beginning and end times (VALID_INCREMENT): None
Sequence of forecast leads to process (LEAD_SEQ): None
This use case does not loop but plots the entire time period 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 parm/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.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
###
LOOP_BY = REALTIME
VALID_TIME_FMT = %Y
VALID_BEG = 2014
USER_SCRIPT_RUNTIME_FREQ = RUN_ONCE
###
# UserScript Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#userscript
###
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"
YAML_CONFIG_NAME = {PARM_BASE}/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller/hovmoeller.yaml
INPUT_FILE_NAME = {INPUT_BASE}/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller/precip.erai.sfc.1p0.2x.2014-2016.nc
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.
User Scripting
User Scripting is not used in this use case.
Running METplus
Pass the use case configuration file to the run_metplus.py script along with any user-specific system configuration files if desired:
run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.conf /path/to/user_system.conf
See Running METplus for more information.
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
METplotpyUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/Hovmoeller_ERAIprecip_2016-01-01-2016-03-31.png’