5.1.8.1. 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

Data: GFS FV3
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 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:

Init: 2016-09-29_0Z
Forecast leads: 141, 144, and 147 hours

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

#
#  CONFIGURATION
#
[config]

# Looping by times: steps through each 'task' in the PROCESS_LIST for each
# defined time, and repeats until all times have been evaluated.
LOOP_ORDER = processes

# 'Tasks' to be run
PROCESS_LIST = GridDiag

LOOP_BY = INIT

# The init time begin and end times, increment, and last init hour.
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG = 2016092900
INIT_END = 2016092900

# This is the step-size. Increment in seconds from the begin time to the end time
# set to 6 hours = 21600 seconds
INIT_INCREMENT = 21600

LEAD_SEQ = 141, 144, 147

# frequency to run the tool
# valid options include:
# RUN_ONCE, RUN_ONCE_PER_INIT_OR_VALID, RUN_ONCE_PER_LEAD, RUN_ONCE_FOR_EACH
GRID_DIAG_RUNTIME_FREQ = RUN_ONCE_PER_INIT_OR_VALID

#LOG_GRID_DIAG_VERBOSITY = 2

GRID_DIAG_DESC = GFS

# Configuration file
GRID_DIAG_CONFIG_FILE = {CONFIG_DIR}/GridDiagConfig_wrapped

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];

# The following variables set values in the MET
# configuration file used by this example
# Leaving these values commented will use the value
# found in the default MET configuration file
#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_MASK_POLY = MET_BASE/poly/SAO.poly

#
#  DIRECTORIES
#
[dir]

# location of configuration files used by MET applications
CONFIG_DIR={PARM_BASE}/met_config

GRID_DIAG_INPUT_DIR = {INPUT_BASE}/met_test/new/model_data/grib2/gfs_fv3

GRID_DIAG_OUTPUT_DIR = {OUTPUT_BASE}/met_tool_wrapper/GridDiag

[filename_templates]

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_TEMPLATE = grid_diag_out.nc

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}

${METPLUS_MET_CONFIG_OVERRIDES}

Running METplus

This use case can be run two ways:

  1. 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
    
  2. 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

sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-GridDiag.png’

Total running time of the script: ( 0 minutes 0.000 seconds)

Gallery generated by Sphinx-Gallery