PyEmbedIngest: Multiple Fields in One File

met_tool_wrapper/PyEmbedIngest/PyEmbedIngest_multi_field_one_file.conf

Scientific Objective

Converting file formats so data can be read by the MET tools. This use case demonstrates the ability to utilize two python embedding script calls to generate multiple fields in a single output file.

Datasets

Inputs: Canned ASCII data to test functionality

Location: All of the input data required for this use case can be found in the met_test sample data tarball. Click here to 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 utilizes the METplus PyEmbedIngest wrapper to generate a command to run the MET tool RegridDataPlane if all required files are found.

METplus Workflow

PyEmbedIngest is the only tool called in this example. It has one run time, but the time is not relevant because the files processed do not have any time information in the names.

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/PyEmbedIngest/PyEmbedIngest_multi_field_one_file.conf

[config]

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


###
# 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 = 2013022712
VALID_END = 2013022712
VALID_INCREMENT = 21600

LEAD_SEQ = 0


###
# PyEmbedIngest Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#pyembedingest
###

PY_EMBED_INGEST_1_OUTPUT_DIR =
PY_EMBED_INGEST_1_OUTPUT_TEMPLATE = {OUTPUT_BASE}/met_tool_wrapper/PyEmbedIngest/test.nc

PY_EMBED_INGEST_1_SCRIPT_1 = {MET_INSTALL_DIR}/share/met/python/examples/read_ascii_numpy.py {INPUT_BASE}/met_test/data/python/fcst.txt FCST
PY_EMBED_INGEST_1_TYPE = NUMPY
PY_EMBED_INGEST_1_OUTPUT_GRID = G130


PY_EMBED_INGEST_2_OUTPUT_DIR =
PY_EMBED_INGEST_2_OUTPUT_TEMPLATE = {OUTPUT_BASE}/met_tool_wrapper/PyEmbedIngest/regrid_data_plane.nc

PY_EMBED_INGEST_2_SCRIPT_1 = {MET_INSTALL_DIR}/share/met/python/examples/read_ascii_numpy.py {INPUT_BASE}/met_test/data/python/fcst.txt FCST
PY_EMBED_INGEST_2_OUTPUT_FIELD_NAME_1 = Forecast

PY_EMBED_INGEST_2_SCRIPT_2 = {MET_INSTALL_DIR}/share/met/python/examples/read_ascii_numpy.py {INPUT_BASE}/met_test/data/python/obs.txt OBS
PY_EMBED_INGEST_2_OUTPUT_FIELD_NAME_2 = Observation

PY_EMBED_INGEST_2_TYPE = NUMPY
PY_EMBED_INGEST_2_OUTPUT_GRID = G130

MET Configuration

None. RegridDataPlane does not use configuration files.

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

read_ascii_numpy.py

Running METplus

This use case can be run two ways:

1. Passing in PyEmbedIngest_multi_field_one_file.conf then a user-specific system configuration file:

   run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/PyEmbedIngest/PyEmbedIngest_multi_field_one_file.conf -c /path/to/user_system.conf
   

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

   run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/PyEmbedIngest/PyEmbedIngest_multi_field_one_file.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/PyEmbedIngest (relative to OUTPUT_BASE) and will contain the following file:

• test.nc

• regrid_data_plane.nc

Keywords

Note

• PyEmbedIngestToolUseCase

• PythonEmbeddingFileUseCase

• RegridDataPlaneToolUseCase

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