Note
Click here to download the full example code
5.1.19.3. 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]
# List of applications to run - only RegridDataPlane for this case
PROCESS_LIST = RegridDataPlane
# 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 = INIT
# Format of INIT_BEG and INT_END using % items
# %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
INIT_TIME_FMT = %Y%m%d%H
# Start time for METplus run - must match INIT_TIME_FMT
INIT_BEG=2005080700
# End time for METplus run - must match INIT_TIME_FMT
INIT_END=2005080700
# Increment between METplus runs (in seconds if no units are specified)
# Must be >= 60 seconds
INIT_INCREMENT = 1M
# 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 = 3H
# 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 = times
# If True, run regrid_data_plane on observation data
OBS_REGRID_DATA_PLANE_RUN = True
# name of input field to process
# if unset, OBS_VAR1_NAME will be used
OBS_REGRID_DATA_PLANE_VAR1_INPUT_FIELD_NAME = APCP
OBS_REGRID_DATA_PLANE_VAR2_INPUT_FIELD_NAME = TMP
# level of input field to process
# if unset, OBS_VAR1_LEVELS will be used
OBS_REGRID_DATA_PLANE_VAR1_INPUT_LEVEL = L0
OBS_REGRID_DATA_PLANE_VAR2_INPUT_LEVEL = L0
# name of output field to create
# if unset, OBS_VAR1_NAME and OBS_VAR1_LEVELS will be combined to generate an output field name
OBS_REGRID_DATA_PLANE_VAR1_OUTPUT_FIELD_NAME = APCP_01
# If true, process each field individually and write a file for each
# If false, run once per run time passing in all fields specified
REGRID_DATA_PLANE_ONCE_PER_FIELD = True
# If running a MET tool comparison tool after RegridDataPlane, one can instead set OBS_VAR1_[NAME/LEVELS] to
# a value that corresponds to the desired name/level to use in the comparison
# this value will be used to determine output name/level to pass to RegridDataPlane as well
#OBS_VAR1_NAME = APCP
#OBS_VAR1_LEVELS = A01
# Name to identify model data in output
MODEL = QPF
# Name to identify observation data in output
OBTYPE = QPE
# Used by regrid_data_plane to remap data
REGRID_DATA_PLANE_VERIF_GRID={INPUT_BASE}/met_test/data/sample_obs/ST2ml/ST2ml2005080703.Grb_G212
# method to run regrid_data_plane, not setting this will default to NEAREST
REGRID_DATA_PLANE_METHOD = BUDGET
# regridding width used in regrid_data_plane, not setting this will default to 1
REGRID_DATA_PLANE_WIDTH = 2
# Gaussian filter DX value to add as command line argument - not added if unset or blank
REGRID_DATA_PLANE_GAUSSIAN_DX =
# Gaussian filter radius value to add as command line argument - not added if unset or blank
REGRID_DATA_PLANE_GAUSSIAN_RADIUS =
# End of [config] section and start of [dir] section
[dir]
# directory containing observation input to RegridDataPlane
OBS_REGRID_DATA_PLANE_INPUT_DIR = {INPUT_BASE}/met_test/data/sample_fcst
# directory to write observation output from RegridDataPlane
OBS_REGRID_DATA_PLANE_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/RegridDataPlane/multi_field_multi_file
# End of [dir] section and start of [filename_templates] section
[filename_templates]
# template to use to read input data and write output data for RegridDataPlane
# if different names for input and output are desired, set OBS_REGRID_DATA_PLANE_INPUT_TEMPLATE
# and OBS_REGRID_DATA_PLANE_OUTPUT_TEMPLATE instead
OBS_REGRID_DATA_PLANE_INPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/wrfprs_ruc13_{lead?fmt=%2H}.tm00_G212
OBS_REGRID_DATA_PLANE_OUTPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/wrfprs_{obs_name}_{lead?fmt=%2H}.tm00_G212
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
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-RegridDataPlane.png’
Total running time of the script: ( 0 minutes 0.000 seconds)