Note
Go to the end to download the full example code
RegridDataPlane: Run once per field
met_tool_wrapper/RegridDataPlane/RegridDataPlane_multi_field _multi_file.conf
Scientific Objective
Simply regridding data to match a desired grid domain for comparisons. Process each field separately and write a file for each.
Datasets
METplus Components
This use case utilizes the METplus RegridDataPlane wrapper to generate a command to run the MET tool RegridDataPlane if all required files are found.
METplus Workflow
RegridDataPlane is the only tool called in this example. It processes the following run time:
This use case regrids data to another domain specified with REGRID_DATA_PLANE_VERIF_GRID. This is done so that forecast and observation comparisons are done on the same grid. Many MET comparison tools have regridding capabilities built in. However, if the same file is read for comparisons multiple times, it is redundant to regrid that file each time. Running RegridDataPlane allows you to regrid once and use the output in many comparisons/evaluations.
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/RegridDataPlane/RegridDataPlane_multi_field_multi_file.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/RegridDataPlane/RegridDataPlane_multi_field_multi_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 = RegridDataPlane
###
# 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 = INIT
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG=2005080700
INIT_END=2005080700
INIT_INCREMENT = 1M
LEAD_SEQ = 3H
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
OBS_REGRID_DATA_PLANE_RUN = True
OBS_REGRID_DATA_PLANE_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
OBS_REGRID_DATA_PLANE_INPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/wrfprs_ruc13_{lead?fmt=%2H}.tm00_G212
OBS_REGRID_DATA_PLANE_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/RegridDataPlane/multi_field_multi_file
OBS_REGRID_DATA_PLANE_OUTPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/wrfprs_{obs_name}_{lead?fmt=%2H}.tm00_G212
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
REGRID_DATA_PLANE_ONCE_PER_FIELD = True
OBS_REGRID_DATA_PLANE_VAR1_INPUT_FIELD_NAME = APCP
OBS_REGRID_DATA_PLANE_VAR1_INPUT_LEVEL = L0
OBS_REGRID_DATA_PLANE_VAR1_OUTPUT_FIELD_NAME = APCP_01
OBS_REGRID_DATA_PLANE_VAR2_INPUT_FIELD_NAME = TMP
OBS_REGRID_DATA_PLANE_VAR2_INPUT_LEVEL = L0
###
# RegridDataPlane Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#regriddataplane
###
MODEL = QPF
OBTYPE = QPE
REGRID_DATA_PLANE_VERIF_GRID={INPUT_BASE}/met_test/data/sample_obs/ST2ml/ST2ml2005080703.Grb_G212
REGRID_DATA_PLANE_METHOD = BUDGET
REGRID_DATA_PLANE_WIDTH = 2
REGRID_DATA_PLANE_GAUSSIAN_DX =
REGRID_DATA_PLANE_GAUSSIAN_RADIUS =
MET Configuration
None. RegridDataPlane does not use configuration files.
Running METplus
This use case can be run two ways:
Passing in RegridDataPlane_multi_field_multi_file.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/RegridDataPlane/RegridDataPlane_multi_field_multi_file.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in RegridDataPlane_multi_field_multi_file.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/RegridDataPlane/RegridDataPlane_multi_field_multi_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/RegridDataPlane (relative to OUTPUT_BASE) and will contain the following files:
multi_field_multi_file/2005080700/wrfprs_APCP_03.tm00_G212
multi_field_multi_file/2005080700/wrfprs_TMP_03.tm00_G212
Keywords
Note
RegridDataPlaneToolUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-RegridDataPlane.png’
Total running time of the script: (0 minutes 0.000 seconds)