Note
Go to the end to download the full example code
PlotDataPlane: Python Embedding Input
met_tool_wrapper/PlotDataPlane/PlotDataPlane_python_embedding.conf
Scientific Objective
Generate a postscript image to test if the input data can be read by the MET tools.
Datasets
METplus Components
This use case utilizes the METplus PlotDataPlane wrapper to generate a command to run the MET tool PlotDataPlane if all required files are found.
METplus Workflow
PlotDataPlane is the only tool called in this example. It processes the following run time:
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/PlotDataPlane/PlotDataPlane_python_embedding.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/PlotDataPlane/PlotDataPlane_python_embedding.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 = PlotDataPlane
###
# 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 = VALID
VALID_TIME_FMT = %Y%m%d%H
VALID_BEG = 2005080712
VALID_END = 2005080712
VALID_INCREMENT = 1M
LEAD_SEQ = 0
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
PLOT_DATA_PLANE_INPUT_DIR =
PLOT_DATA_PLANE_INPUT_TEMPLATE = PYTHON_NUMPY
PLOT_DATA_PLANE_OUTPUT_DIR =
PLOT_DATA_PLANE_OUTPUT_TEMPLATE = {OUTPUT_BASE}/met_tool_wrapper/plot_data_plane/py_embed_fcst.ps
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
PLOT_DATA_PLANE_FIELD_NAME = {MET_INSTALL_DIR}/share/met/python/examples/read_ascii_numpy.py {INPUT_BASE}/met_test/data/python/fcst.txt FCST
###
# PlotDataPlane Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#plotdataplane
###
# Verbosity of MET output - overrides LOG_VERBOSITY for PlotDataPlane only
LOG_PLOT_DATA_PLANE_VERBOSITY = 1
PLOT_DATA_PLANE_TITLE = Python Embedding FCST
PLOT_DATA_PLANE_COLOR_TABLE =
PLOT_DATA_PLANE_RANGE_MIN_MAX =
MET Configuration
This tool does not use a MET configuration file.
Python Embedding
This use case calls a Python script to read the input data. The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
Running METplus
This use case can be run two ways:
Passing in PlotDataPlane_python_embedding.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/PlotDataPlane/PlotDataPlane_python_embedding.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in PlotDataPlane_python_embedding.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/PlotDataPlane/PlotDataPlane_python_embedding.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.
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 met_tool_wrapper/plot_data_plane (relative to OUTPUT_BASE) and will contain the following file:
py_embed_fcst.ps
Keywords
Note
PlotDataPlaneToolUseCase
PythonEmbeddingFileUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-PlotDataPlane.png’
Total running time of the script: (0 minutes 0.000 seconds)