Note

Go to the end to download the full example code.

SeriesAnalysis: Aggregate Output Use Case

met_tool_wrapper/SeriesAnalysis/SeriesAnalysis_aggr.conf

Scientific Objective

Read in output from a previous SeriesAnalysis run into SeriesAnalysis to aggregate the results.

Datasets

Forecast: GFS 6 hour precipitation accumulation
Observation: STAGE4 6 hour precipitation accumulation
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 SeriesAnalysis wrapper to search for files that are valid at a given run time and generates a command to run the MET tool series_analysis if all required files are found.

METplus Workflow

SeriesAnalysis is the only tool called in this example. It processes the following run times:

Init: 2012-04-09_0Z
Forecast lead: 30, 36, and 42 hour

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, e.g. parm/use_cases/met_tool_wrapper/SeriesAnalysis/SeriesAnalysis_aggr.conf

[config]

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


###
# 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
###

SERIES_ANALYSIS_RUNTIME_FREQ = RUN_ONCE_PER_INIT_OR_VALID

LOOP_BY = INIT
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG=2012040900
INIT_END=2012040900
INIT_INCREMENT = 1d

LEAD_SEQ = 30, 36, 42


SERIES_ANALYSIS_RUN_ONCE_PER_STORM_ID = False

SERIES_ANALYSIS_CUSTOM_LOOP_LIST =

###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###

FCST_SERIES_ANALYSIS_INPUT_DIR = {INPUT_BASE}/met_test/new/unit_test/model_data/grib1/gfs_hmt
FCST_SERIES_ANALYSIS_INPUT_TEMPLATE = gfs_{init?fmt=%Y%m%d%H}_F{lead?fmt=%3H}.grib

OBS_SERIES_ANALYSIS_INPUT_DIR = {INPUT_BASE}/met_test/new/unit_test/obs_data/stage4_hmt
OBS_SERIES_ANALYSIS_INPUT_TEMPLATE = stage4_{valid?fmt=%Y%m%d%H}_06h.grib

SERIES_ANALYSIS_TC_STAT_INPUT_DIR =
SERIES_ANALYSIS_TC_STAT_INPUT_TEMPLATE =

SERIES_ANALYSIS_AGGR_INPUT_DIR = {INPUT_BASE}/met_test/new/test_out/series_analysis
SERIES_ANALYSIS_AGGR_INPUT_TEMPLATE = series_analysis_CMD_LINE_APCP_06_{init?fmt=%Y%m%d%H}_to_{init?fmt=%Y%m%d%H?shift=1d}.nc

SERIES_ANALYSIS_OUTPUT_DIR = {OUTPUT_BASE}/series_analysis
SERIES_ANALYSIS_OUTPUT_TEMPLATE = series_analysis_AGGR_CMD_LINE_APCP_06_{init?fmt=%Y%m%d%H}_to_{init?fmt=%Y%m%d%H?shift=1d}.nc

SERIES_ANALYSIS_CLIMO_MEAN_INPUT_DIR =
SERIES_ANALYSIS_CLIMO_MEAN_INPUT_TEMPLATE =

SERIES_ANALYSIS_CLIMO_STDEV_INPUT_DIR =
SERIES_ANALYSIS_CLIMO_STDEV_INPUT_TEMPLATE =


###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###

FCST_CAT_THRESH = >0.0, >5.0
OBS_CAT_THRESH = >0.0, >5.0

FCST_VAR1_NAME = APCP
FCST_VAR1_LEVELS = A06

OBS_VAR1_NAME = APCP
OBS_VAR1_LEVELS = A06


###
# SeriesAnalysis Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#seriesanalysis
###

MODEL = GFS
OBTYPE = STAGE4

#LOG_SERIES_ANALYSIS_VERBOSITY = 2

SERIES_ANALYSIS_CONFIG_FILE = {PARM_BASE}/met_config/SeriesAnalysisConfig_wrapped

SERIES_ANALYSIS_IS_PAIRED = False

#SERIES_ANALYSIS_DESC =

#SERIES_ANALYSIS_CAT_THRESH =

#SERIES_ANALYSIS_VLD_THRESH =

#SERIES_ANALYSIS_BLOCK_SIZE =

#SERIES_ANALYSIS_REGRID_TO_GRID =
#SERIES_ANALYSIS_REGRID_METHOD =
#SERIES_ANALYSIS_REGRID_WIDTH =
#SERIES_ANALYSIS_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_REGRID_SHAPE =
#SERIES_ANALYSIS_REGRID_CONVERT =
#SERIES_ANALYSIS_REGRID_CENSOR_THRESH =
#SERIES_ANALYSIS_REGRID_CENSOR_VAL =

#SERIES_ANALYSIS_CLIMO_MEAN_FILE_NAME =
#SERIES_ANALYSIS_CLIMO_MEAN_FIELD =
#SERIES_ANALYSIS_CLIMO_MEAN_REGRID_METHOD =
#SERIES_ANALYSIS_CLIMO_MEAN_REGRID_WIDTH =
#SERIES_ANALYSIS_CLIMO_MEAN_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_CLIMO_MEAN_REGRID_SHAPE =
#SERIES_ANALYSIS_CLIMO_MEAN_TIME_INTERP_METHOD =
#SERIES_ANALYSIS_CLIMO_MEAN_MATCH_MONTH =
#SERIES_ANALYSIS_CLIMO_MEAN_DAY_INTERVAL =
#SERIES_ANALYSIS_CLIMO_MEAN_HOUR_INTERVAL =
#SERIES_ANALYSIS_CLIMO_MEAN_FILE_TYPE =

#SERIES_ANALYSIS_CLIMO_STDEV_FILE_NAME =
#SERIES_ANALYSIS_CLIMO_STDEV_FIELD =
#SERIES_ANALYSIS_CLIMO_STDEV_REGRID_METHOD =
#SERIES_ANALYSIS_CLIMO_STDEV_REGRID_WIDTH =
#SERIES_ANALYSIS_CLIMO_STDEV_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_CLIMO_STDEV_REGRID_SHAPE =
#SERIES_ANALYSIS_CLIMO_STDEV_TIME_INTERP_METHOD =
#SERIES_ANALYSIS_CLIMO_STDEV_MATCH_MONTH =
#SERIES_ANALYSIS_CLIMO_STDEV_DAY_INTERVAL =
#SERIES_ANALYSIS_CLIMO_STDEV_HOUR_INTERVAL =
#SERIES_ANALYSIS_CLIMO_STDEV_FILE_TYPE =

#SERIES_ANALYSIS_FCST_CLIMO_MEAN_FILE_NAME =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_FIELD =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_REGRID_METHOD =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_REGRID_WIDTH =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_REGRID_SHAPE =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_TIME_INTERP_METHOD =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_DAY_INTERVAL =
#SERIES_ANALYSIS_FCST_CLIMO_MEAN_HOUR_INTERVAL =

#SERIES_ANALYSIS_FCST_CLIMO_STDEV_FILE_NAME =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_FIELD =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_REGRID_METHOD =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_REGRID_WIDTH =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_REGRID_SHAPE =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_TIME_INTERP_METHOD =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_DAY_INTERVAL =
#SERIES_ANALYSIS_FCST_CLIMO_STDEV_HOUR_INTERVAL =

#SERIES_ANALYSIS_OBS_CLIMO_MEAN_FILE_NAME =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_FIELD =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_REGRID_METHOD =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_REGRID_WIDTH =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_REGRID_SHAPE =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_TIME_INTERP_METHOD =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_DAY_INTERVAL =
#SERIES_ANALYSIS_OBS_CLIMO_MEAN_HOUR_INTERVAL =

#SERIES_ANALYSIS_OBS_CLIMO_STDEV_FILE_NAME =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_FIELD =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_REGRID_METHOD =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_REGRID_WIDTH =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_REGRID_VLD_THRESH =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_REGRID_SHAPE =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_TIME_INTERP_METHOD =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_DAY_INTERVAL =
#SERIES_ANALYSIS_OBS_CLIMO_STDEV_HOUR_INTERVAL =

#SERIES_ANALYSIS_CLIMO_CDF_BINS =
#SERIES_ANALYSIS_CLIMO_CDF_CENTER_BINS =
#SERIES_ANALYSIS_CLIMO_CDF_DIRECT_PROB =

#SERIES_ANALYSIS_HSS_EC_VALUE =

#FCST_SERIES_ANALYSIS_PROB_THRESH =

SERIES_ANALYSIS_OUTPUT_STATS_FHO = F_RATE, O_RATE
SERIES_ANALYSIS_OUTPUT_STATS_CTC = ALL
SERIES_ANALYSIS_OUTPUT_STATS_CTS = CSI, GSS
SERIES_ANALYSIS_OUTPUT_STATS_MCTC = ALL
SERIES_ANALYSIS_OUTPUT_STATS_MCTS = ACC, ACC_NCL, ACC_NCU
SERIES_ANALYSIS_OUTPUT_STATS_CNT = TOTAL, ME, ME_NCL, ME_NCU
SERIES_ANALYSIS_OUTPUT_STATS_SL1L2 = ALL
#SERIES_ANALYSIS_OUTPUT_STATS_SAL1L2 =
#SERIES_ANALYSIS_OUTPUT_STATS_PCT =
#SERIES_ANALYSIS_OUTPUT_STATS_PSTD =
#SERIES_ANALYSIS_OUTPUT_STATS_PJC =
#SERIES_ANALYSIS_OUTPUT_STATS_PRC =

#SERIES_ANALYSIS_MASK_GRID =
#SERIES_ANALYSIS_MASK_POLY =


###
# SeriesAnalysis Plotting
###

SERIES_ANALYSIS_GENERATE_PLOTS = no

PLOT_DATA_PLANE_TITLE =

SERIES_ANALYSIS_GENERATE_ANIMATIONS = no

#SERIES_ANALYSIS_TIME_OFFSET_WARNING =

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 SeriesAnalysis MET Configuration section of the User’s Guide for more information on the environment variables used in the file below:

////////////////////////////////////////////////////////////////////////////////
//
// Series-Analysis configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////

//
// Output model name to be written
//
//model =
${METPLUS_MODEL}

//
// Output description to be written
//
//desc =
${METPLUS_DESC}

//
// Output observation type to be written
//
//obtype =
${METPLUS_OBTYPE}

////////////////////////////////////////////////////////////////////////////////

//
// Verification grid
// May be set separately in each "field" entry
//
//regrid = {
${METPLUS_REGRID_DICT}

////////////////////////////////////////////////////////////////////////////////

censor_thresh = [];
censor_val    = [];
//cat_thresh =
${METPLUS_CAT_THRESH}
cnt_thresh    = [ NA ];
cnt_logic     = UNION;

//
// Forecast and observation fields to be verified
//
fcst = {
   ${METPLUS_FCST_FILE_TYPE}
   ${METPLUS_FCST_CAT_THRESH}
   //field = [
   ${METPLUS_FCST_FIELD}
   ${METPLUS_FCST_CLIMO_MEAN_DICT}
   ${METPLUS_FCST_CLIMO_STDEV_DICT}
}
obs = {
   ${METPLUS_OBS_FILE_TYPE}
   ${METPLUS_OBS_CAT_THRESH}
   //field = [
   ${METPLUS_OBS_FIELD}
   ${METPLUS_OBS_CLIMO_MEAN_DICT}
   ${METPLUS_OBS_CLIMO_STDEV_DICT}
}

////////////////////////////////////////////////////////////////////////////////

//
// Climatology data
//
//climo_mean = {
${METPLUS_CLIMO_MEAN_DICT}


//climo_stdev = {
${METPLUS_CLIMO_STDEV_DICT}

//climo_cdf = {
${METPLUS_CLIMO_CDF_DICT}

////////////////////////////////////////////////////////////////////////////////

//
// Confidence interval settings
//
ci_alpha  = [ 0.05 ];

boot = {
   interval = PCTILE;
   rep_prop = 1.0;
   n_rep    = 0;
   rng      = "mt19937";
   seed     = "";
}

////////////////////////////////////////////////////////////////////////////////

//
// Verification masking regions
//
//mask = {
${METPLUS_MASK_DICT}

////////////////////////////////////////////////////////////////////////////////

//
// Gradient statistics
// May be set separately in each "obs.field" entry
//
//gradient = {
${METPLUS_GRADIENT_DICT}

//
// Number of grid points to be processed concurrently.  Set smaller to use
// less memory but increase the number of passes through the data.
//
//block_size =
${METPLUS_BLOCK_SIZE}

//
// Ratio of valid matched pairs to compute statistics for a grid point
//
//vld_thresh =
${METPLUS_VLD_THRESH}

////////////////////////////////////////////////////////////////////////////////

//
// Statistical output types
//
//output_stats = {
${METPLUS_OUTPUT_STATS_DICT}

////////////////////////////////////////////////////////////////////////////////

//hss_ec_value =
${METPLUS_HSS_EC_VALUE}
rank_corr_flag = FALSE;

tmp_dir = "${MET_TMP_DIR}";

//version        = "V10.0";

////////////////////////////////////////////////////////////////////////////////

${METPLUS_TIME_OFFSET_WARNING}
${METPLUS_MET_CONFIG_OVERRIDES}

Running METplus

Pass the use case configuration file to the run_metplus.py script along with any user-specific system configuration files if desired:

run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/SeriesAnalysis/SeriesAnalysis_aggr.conf /path/to/user_system.conf

See Running METplus for more information.

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 series_analysis (relative to OUTPUT_BASE) and will contain the following file:

  • series_analysis_AGGR_CMD_LINE_APCP_06_2012040900_to_2012041000.nc

Keywords

Note

  • SeriesAnalysisUseCase

  • DiagnosticsUseCase

  • RuntimeFreqUseCase

  • GRIBFileUseCase

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

#

Gallery generated by Sphinx-Gallery