Note
Go to the end to download the full example code
GridDiag: Basic Use Case
met_tool_wrapper/GridDiag/GridDiag.conf
Scientific Objective
The Grid-Diag tool creates histograms (probability distributions when normalized) for an arbitrary collection of data fields and levels.
Datasets
METplus Components
This use case utilizes the METplus GridDiag wrapper to search for files that are valid at a given run time and generate a command to run the MET tool grid_diag if all required files are found.
METplus Workflow
GridDiag is the only tool called in this example. It processes the following run times:
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/GridDiag/GridDiag.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/GridDiag/GridDiag.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 = GridDiag
###
# 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
###
GRID_DIAG_RUNTIME_FREQ = RUN_ONCE_PER_INIT_OR_VALID
LOOP_BY = INIT
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG = 2016092900
INIT_END = 2016092900
INIT_INCREMENT = 21600
LEAD_SEQ = 141, 144, 147
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
GRID_DIAG_INPUT_DIR = {INPUT_BASE}/met_test/new/model_data/grib2/gfs_fv3
GRID_DIAG_INPUT_TEMPLATE = gfs.subset.t00z.pgrb2.0p25.f{lead?fmt=%H}, gfs.subset.t00z.pgrb2.0p25.f{lead?fmt=%H}
GRID_DIAG_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/GridDiag
GRID_DIAG_OUTPUT_TEMPLATE = grid_diag_out.nc
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
BOTH_VAR1_NAME = APCP
BOTH_VAR1_LEVELS = L0
BOTH_VAR1_OPTIONS = n_bins = 55; range = [0, 55];
BOTH_VAR2_NAME = PWAT
BOTH_VAR2_LEVELS = L0
BOTH_VAR2_OPTIONS = n_bins = 35; range = [35, 70];
###
# GridDiag Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#griddiag
###
#LOG_GRID_DIAG_VERBOSITY = 2
GRID_DIAG_DESC = GFS
GRID_DIAG_CONFIG_FILE = {PARM_BASE}/met_config/GridDiagConfig_wrapped
#GRID_DIAG_REGRID_TO_GRID = NONE
#GRID_DIAG_REGRID_METHOD = NEAREST
#GRID_DIAG_REGRID_WIDTH = 1
#GRID_DIAG_REGRID_VLD_THRESH = 0.5
#GRID_DIAG_REGRID_SHAPE = SQUARE
#GRID_DIAG_REGRID_CONVERT =
#GRID_DIAG_REGRID_CENSOR_THRESH =
#GRID_DIAG_REGRID_CENSOR_VAL =
GRID_DIAG_MASK_POLY = MET_BASE/poly/SAO.poly
MET Configuration
METplus sets environment variables based on user settings in the METplus configuration file. See How METplus controls MET config file settings for more details.
YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!
If there is a setting in the MET configuration file that is currently not supported by METplus you’d like to control, please refer to: Overriding Unsupported MET config file settings
Note
See the GridDiag MET Configuration section of the User’s Guide for more information on the environment variables used in the file below:
////////////////////////////////////////////////////////////////////////////////
//
// Grid-Diag configuration file.
//
// For additional information, see the MET_BASE/config/GridDiagConfig_default file.
//
////////////////////////////////////////////////////////////////////////////////
//
// Description
//
${METPLUS_DESC}
////////////////////////////////////////////////////////////////////////////////
//
// Output grid
//
${METPLUS_REGRID_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// May be set separately in each "field" entry
//
${METPLUS_CENSOR_THRESH}
${METPLUS_CENSOR_VAL}
//
// Data fields
//
${METPLUS_DATA_DICT}
${METPLUS_MASK_DICT}
tmp_dir = "${MET_TMP_DIR}";
${METPLUS_MET_CONFIG_OVERRIDES}
Running METplus
This use case can be run two ways:
Passing in GridDiag.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridDiag/GridDiag.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in GridDiag.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridDiag/GridDiag.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/GridDiag (relative to OUTPUT_BASE) and will contain the following files:
grid_diag_out.nc
Keywords
Note
GridDiagToolUseCase
RuntimeFreqUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-GridDiag.png’
Total running time of the script: (0 minutes 0.000 seconds)