4. Python Wrappers

This chapter provides a description of each supported Python wrapper in METplus Wrappers. A wrapper is generally a Python script that encapsulates the behavior of a corresponding MET tool. Each of these sections can be added to the PROCESS_LIST configuration list variable. The METplus Configuration section of each wrapper section below lists the METplus Wrappers configuration variables that are specific to that wrapper organized by config file section. You can find more information about each item in the METplus Configuration Glossary. The MET Configuration section of each wrapper (if applicable) displays the wrapped MET configuration file that utilizes environment variables to override settings. These sections also contain a list of environment variables that are referenced in the wrapped MET configuration files and a table to show which METplus configuration variables are used to set them and which MET configuration variables they override.

4.1. ASCII2NC

4.1.1. Description

Used to configure the MET tool ASCII2NC

4.1.2. METplus Configuration

4.1.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/Ascii2NcConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// Default ascii2nc configuration file
//
////////////////////////////////////////////////////////////////////////////////

//
// The parameters listed below are used to summarize the ASCII data read in
//

//
// Time periods for the summarization
// obs_var (string array) is added and works like grib_code (int array)
// when the obs name is given instead of grib_code
//
${METPLUS_TIME_SUMMARY_DICT}

//
// Mapping of input little_r report types to output message types
//
message_type_map = [
   { key = "FM-12 SYNOP";  val = "ADPSFC"; },
   { key = "FM-13 SHIP";   val = "SFCSHP"; },
   { key = "FM-15 METAR";  val = "ADPSFC"; },
   { key = "FM-18 BUOY";   val = "SFCSHP"; },
   { key = "FM-281 QSCAT"; val = "ASCATW"; },
   { key = "FM-32 PILOT";  val = "ADPUPA"; },
   { key = "FM-35 TEMP";   val = "ADPUPA"; },
   { key = "FM-88 SATOB";  val = "SATWND"; },
   { key = "FM-97 ACARS";  val = "AIRCFT"; }
];

//
// Indicate a version number for the contents of this configuration file.
// The value should generally not be modified.
//
//version = "V10.0";

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_TIME_SUMMARY_DICT}

METplus Config(s)

MET Config File

ASCII2NC_TIME_SUMMARY_FLAG

time_summary.flag

ASCII2NC_TIME_SUMMARY_RAW_DATA

time_summary.raw_data

ASCII2NC_TIME_SUMMARY_BEG

time_summary.beg

ASCII2NC_TIME_SUMMARY_END

time_summary.end

ASCII2NC_TIME_SUMMARY_STEP

time_summary.step

ASCII2NC_TIME_SUMMARY_WIDTH

time_summary.width

ASCII2NC_TIME_SUMMARY_GRIB_CODES

time_summary.grib_code

ASCII2NC_TIME_SUMMARY_VAR_NAMES

time_summary.obs_var

ASCII2NC_TIME_SUMMARY_TYPES

time_summary.type

ASCII2NC_TIME_SUMMARY_VALID_FREQ

time_summary.vld_freq

ASCII2NC_TIME_SUMMARY_VALID_THRESH

time_summary.vld_thresh

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

ASCII2NC_MET_CONFIG_OVERRIDES

n/a

4.2. CyclonePlotter

4.2.1. Description

This wrapper does not have a corresponding MET tool but instead wraps the logic necessary to create plots of cyclone tracks. Currently only the output from the MET tc-pairs tool can be plotted.

4.2.2. METplus Configuration

4.3. EnsembleStat

4.3.1. Description

Used to configure the MET tool ensemble_stat.

4.3.2. METplus Configuration

ENS_VAR<n>_NAME (optional)

4.3.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/EnsembleStatConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// Ensemble-Stat configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////

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

//
// Output description to be written
// May be set separately in each "obs.field" entry
//
${METPLUS_DESC}

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

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

//
// Verification grid
//
${METPLUS_REGRID_DICT}

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

//
// May be set separately in each "field" entry
//
${METPLUS_CENSOR_THRESH}
${METPLUS_CENSOR_VAL}
cat_thresh    = [];
nc_var_str    = "";

//
// Ensemble product fields to be processed
//
ens = {

   ${METPLUS_ENS_FILE_TYPE}

   ${METPLUS_ENS_THRESH}
   ${METPLUS_ENS_VLD_THRESH}
   ${METPLUS_ENS_OBS_THRESH}

   ${METPLUS_ENS_FIELD}
}

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

//
// Neighborhood ensemble probabilities
//
${METPLUS_NBRHD_PROB_DICT}

//
// NMEP smoothing methods
//
${METPLUS_NMEP_SMOOTH_DICT}

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

//
// Forecast and observation fields to be verified
//

fcst = {

   ${METPLUS_FCST_FILE_TYPE}

   ${METPLUS_FCST_FIELD}
}

obs = {

   ${METPLUS_OBS_FILE_TYPE}
 
   ${METPLUS_OBS_FIELD}
}

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

//
// Point observation filtering options
// May be set separately in each "obs.field" entry
//

${METPLUS_MESSAGE_TYPE}
sid_exc        = [];
obs_thresh     = [ NA ];
obs_quality    = [];
${METPLUS_DUPLICATE_FLAG}
obs_summary    = NONE;
obs_perc_value = 50;
${METPLUS_SKIP_CONST}

//
// Observation error options
// Set dist_type to NONE to use the observation error table instead
// May be set separately in each "obs.field" entry
//
obs_error = {
   ${METPLUS_OBS_ERROR_FLAG}
   dist_type        = NONE;
   dist_parm        = [];
   inst_bias_scale  = 1.0;
   inst_bias_offset = 0.0;
   min              = NA;      // Valid range of data
   max              = NA;
}

//
// Mapping of message type group name to comma-separated list of values.
//
message_type_group_map = [
   { key = "SURFACE"; val = "ADPSFC,SFCSHP,MSONET";               },
   { key = "ANYAIR";  val = "AIRCAR,AIRCFT";                      },
   { key = "ANYSFC";  val = "ADPSFC,SFCSHP,ADPUPA,PROFLR,MSONET"; },
   { key = "ONLYSF";  val = "ADPSFC,SFCSHP";                      }
];

//
// Ensemble bin sizes
// May be set separately in each "obs.field" entry
//
${METPLUS_ENS_SSVAR_BIN_SIZE}
${METPLUS_ENS_PHIST_BIN_SIZE}

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

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


//climo_stdev = {
${METPLUS_CLIMO_STDEV_DICT}



//
// May be set separately in each "obs.field" entry
//
${METPLUS_CLIMO_CDF_DICT}

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

//
// Point observation time window
//
${METPLUS_OBS_WINDOW_DICT}

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

//
// Verification masking regions
//
mask = {
   ${METPLUS_MASK_GRID}
   ${METPLUS_MASK_POLY}
   sid   = [];
   llpnt = [];
}

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

//
// Confidence interval settings
//
${METPLUS_CI_ALPHA}

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

//
// Interpolation methods
//
${METPLUS_INTERP_DICT}

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

//
// Statistical output types
//
${METPLUS_OUTPUT_FLAG_DICT}

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

//
// Ensemble product output types
//
${METPLUS_ENSEMBLE_FLAG_DICT}

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

//
// Random number generator
//
rng = {
   type = "mt19937";
   seed = "1";
}

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

grid_weight_flag = NONE;
${METPLUS_OUTPUT_PREFIX}
//version          = "V9.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC or ENSEMBLE_STAT_DESC

desc

${METPLUS_OBTYPE}

METplus Config(s)

MET Config File

OBTYPE

obtype

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_REGRID_SHAPE

regrid.shape

ENSEMBLE_STAT_REGRID_METHOD

regrid.method

ENSEMBLE_STAT_REGRID_WIDTH

regrid.width

ENSEMBLE_STAT_REGRID_VLD_THRESH

regrid.vld_thresh

ENSEMBLE_STAT_REGRID_TO_GRID

regrid.to_grid

${METPLUS_CENSOR_THRESH}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_CENSOR_THRESH

censor_thresh

${METPLUS_CENSOR_VAL}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_CENSOR_VAL

censor_val

${METPLUS_ENS_FILE_TYPE}

METplus Config(s)

MET Config File

ENS_ENSEMBLE_STAT_INPUT_DATATYPE

ens.file_type

${METPLUS_ENS_THRESH}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_ENS_THRESH

ens.ens_thresh

${METPLUS_ENS_VLD_THRESH}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_ENS_VLD_THRESH

ens.vld_thresh

${METPLUS_ENS_OBS_THRESH}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_ENS_OBS_THRESH

ens.obs_thresh

${METPLUS_ENS_FIELD}

METplus Config(s)

MET Config File

ENS_VAR<n>_NAME

ens.field.name

ENS_VAR<n>_LEVELS

ens.field.level

ENS_VAR<n>_THRESH

ens.field.cat_thresh

ENS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_NBRHD_PROB_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_NBRHD_PROB_WIDTH

nbrhd_prob.width

ENSEMBLE_STAT_NBRHD_PROB_SHAPE

nbrhd_prob.shape

ENSEMBLE_STAT_NBRHD_PROB_VLD_THRESH

nbrhd_prob.vld_thresh

${METPLUS_NMEP_SMOOTH_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_NMEP_SMOOTH_VLD_THRESH

nmep_smooth.vld_thresh

ENSEMBLE_STAT_NMEP_SMOOTH_SHAPE

nmep_smooth.shape

ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_DX

nmep_smooth.gaussian_dx

ENSEMBLE_STAT_NMEP_SMOOTH_GAUSSIAN_RADIUS

nmep_smooth.gaussian_radius

ENSEMBLE_STAT_NMEP_SMOOTH_METHOD

nmep_smooth.type.method

ENSEMBLE_STAT_NMEP_SMOOTH_WIDTH

nmep_smooth.type.width

${METPLUS_FCST_FILE_TYPE}

METplus Config(s)

MET Config File

FCST_ENSEMBLE_STAT_INPUT_DATATYPE

fcst.file_type

${METPLUS_FCST_FIELD}

METplus Config(s)

MET Config File

FCST_VAR<n>_NAME

fcst.field.name

FCST_VAR<n>_LEVELS

fcst.field.level

FCST_VAR<n>_THRESH

fcst.field.cat_thresh

FCST_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_OBS_FILE_TYPE}

METplus Config(s)

MET Config File

OBS_ENSEMBLE_STAT_INPUT_GRID_DATATYPE -or- OBS_ENSEMBLE_STAT_INPUT_POINT_DATATYPE

obs.file_type

${METPLUS_OBS_FIELD}

METplus Config(s)

MET Config File

OBS_VAR<n>_NAME

fcst.field.name

OBS_VAR<n>_LEVELS

fcst.field.level

OBS_VAR<n>_THRESH

fcst.field.cat_thresh

OBS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the observation field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_MESSAGE_TYPE}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_MESSAGE_TYPE

message_type

${METPLUS_DUPLICATE_FLAG}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_DUPLICATE_FLAG

duplicate_flag

${METPLUS_SKIP_CONST}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_SKIP_CONST

skip_const

${METPLUS_OBS_ERROR_FLAG}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_OBS_ERROR_FLAG

obs_error.flag

${METPLUS_ENS_SSVAR_BIN_SIZE}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_ENS_SSVAR_BIN_SIZE

ens_ssvar_bin_size

${METPLUS_ENS_PHIST_BIN_SIZE}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_ENS_PHIST_BIN_SIZE

ens_phist_bin_size

${METPLUS_CLIMO_MEAN_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_CLIMO_MEAN_FILE_NAME

climo_mean.file_name

ENSEMBLE_STAT_CLIMO_MEAN_FIELD

climo_mean.field

ENSEMBLE_STAT_CLIMO_MEAN_REGRID_METHOD

climo_mean.regrid.method

ENSEMBLE_STAT_CLIMO_MEAN_REGRID_WIDTH

climo_mean.regrid.width

ENSEMBLE_STAT_CLIMO_MEAN_REGRID_VLD_THRESH

climo_mean.regrid.vld_thresh

ENSEMBLE_STAT_CLIMO_MEAN_REGRID_SHAPE

climo_mean.regrid.shape

ENSEMBLE_STAT_CLIMO_MEAN_TIME_INTERP_METHOD

climo_mean.time_interp_method

ENSEMBLE_STAT_CLIMO_MEAN_MATCH_MONTH

climo_mean.match_month

ENSEMBLE_STAT_CLIMO_MEAN_DAY_INTERVAL

climo_mean.day_interval

ENSEMBLE_STAT_CLIMO_MEAN_HOUR_INTERVAL

climo_mean.hour_interval

${METPLUS_CLIMO_STDEV_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_CLIMO_STDEV_FILE_NAME

climo_stdev.file_name

ENSEMBLE_STAT_CLIMO_STDEV_FIELD

climo_stdev.field

ENSEMBLE_STAT_CLIMO_STDEV_REGRID_METHOD

climo_stdev.regrid.method

ENSEMBLE_STAT_CLIMO_STDEV_REGRID_WIDTH

climo_stdev.regrid.width

ENSEMBLE_STAT_CLIMO_STDEV_REGRID_VLD_THRESH

climo_stdev.regrid.vld_thresh

ENSEMBLE_STAT_CLIMO_STDEV_REGRID_SHAPE

climo_stdev.regrid.shape

ENSEMBLE_STAT_CLIMO_STDEV_TIME_INTERP_METHOD

climo_stdev.time_interp_method

ENSEMBLE_STAT_CLIMO_STDEV_MATCH_MONTH

climo_stdev.match_month

ENSEMBLE_STAT_CLIMO_STDEV_DAY_INTERVAL

climo_stdev.day_interval

ENSEMBLE_STAT_CLIMO_STDEV_HOUR_INTERVAL

climo_stdev.hour_interval

${METPLUS_CLIMO_CDF_DICT}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_OBS_WINDOW_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_CLIMO_CDF_BINS

climo_cdv.cdf_bins

ENSEMBLE_STAT_CLIMO_CDF_CENTER_BINS

climo_cdv.center_bins

ENSEMBLE_STAT_CLIMO_CDF_WRITE_BINS

climo_cdv.write_bins

${METPLUS_MASK_GRID}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_MASK_GRID

mask.grid

${METPLUS_MASK_POLY}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_MASK_POLY

mask.poly

${METPLUS_CI_ALPHA}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_CI_ALPHA

ci_alpha

${METPLUS_INTERP_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_INTERP_FIELD

interp.field

ENSEMBLE_STAT_INTERP_VLD_THRESH

interp.vld_thresh

ENSEMBLE_STAT_INTERP_SHAPE

interp.shape

ENSEMBLE_STAT_INTERP_METHOD

interp.type.method

ENSEMBLE_STAT_INTERP_WIDTH

interp.type.width

${METPLUS_OUTPUT_FLAG_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_OUTPUT_FLAG_ECNT

output_flag.ecnt

ENSEMBLE_STAT_OUTPUT_FLAG_RPS

output_flag.rps

ENSEMBLE_STAT_OUTPUT_FLAG_RHIST

output_flag.rhist

ENSEMBLE_STAT_OUTPUT_FLAG_PHIST

output_flag.phist

ENSEMBLE_STAT_OUTPUT_FLAG_ORANK

output_flag.orank

ENSEMBLE_STAT_OUTPUT_FLAG_SSVAR

output_flag.ssvar

ENSEMBLE_STAT_OUTPUT_FLAG_RELP

output_flag.relp

${METPLUS_ENSEMBLE_FLAG_DICT}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_ENSEMBLE_FLAG_LATLON

ensemble_flag.latlon

ENSEMBLE_STAT_ENSEMBLE_FLAG_MEAN

ensemble_flag.mean

ENSEMBLE_STAT_ENSEMBLE_FLAG_STDEV

ensemble_flag.stdev

ENSEMBLE_STAT_ENSEMBLE_FLAG_MINUS

ensemble_flag.minus

ENSEMBLE_STAT_ENSEMBLE_FLAG_PLUS

ensemble_flag.plus

ENSEMBLE_STAT_ENSEMBLE_FLAG_MIN

ensemble_flag.min

ENSEMBLE_STAT_ENSEMBLE_FLAG_MAX

ensemble_flag.max

ENSEMBLE_STAT_ENSEMBLE_FLAG_RANGE

ensemble_flag.range

ENSEMBLE_STAT_ENSEMBLE_FLAG_VLD_COUNT

ensemble_flag.vld_count

ENSEMBLE_STAT_ENSEMBLE_FLAG_FREQUENCY

ensemble_flag.frequency

ENSEMBLE_STAT_ENSEMBLE_FLAG_NEP

ensemble_flag.nep

ENSEMBLE_STAT_ENSEMBLE_FLAG_NMEP

ensemble_flag.nmep

ENSEMBLE_STAT_ENSEMBLE_FLAG_RANK

ensemble_flag.rank

ENSEMBLE_STAT_ENSEMBLE_FLAG_WEIGHT

ensemble_flag.weight

${METPLUS_OUTPUT_PREFIX}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_OUTPUT_PREFIX

output_prefix

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

ENSEMBLE_STAT_MET_CONFIG_OVERRIDES

n/a

4.4. Example

4.4.1. Description

Used to demonstrate how the METplus wrappers handle looping and building commands.

4.4.2. Configuration

4.5. ExtractTiles

4.5.1. Description

The ExtractTiles wrapper is used to regrid and extract subregions from paired tropical cyclone tracks that are created by the tc_pairs_wrapper. Unlike the other wrappers, the extract_tiles_wrapper does not correspond to a specific MET tool. It invokes the tc_stat_wrapper, which in turn calls the MET tc_stat tool to determine the lat/lon positions of the paired track data. This information is then used to create tiles of subregions. The ExtractTiles wrapper creates a 2n degree x 2m degree grid/tile with each storm located at the center.

4.5.2. METplus Configuration

The following should be set in the METplus configuration file to define the dimensions and density of the tiles comprising the subregion:

4.6. GempakToCF

4.6.1. Description

Used to configure the utility GempakToCF.

4.6.2. METplus Configuration

Warning

DEPRECATED:

4.7. GenVxMask

4.7.1. Description

Used to configure the MET tool GenVxMask to define and generate masking regions.

4.7.2. Configuration

4.8. GridDiag

4.8.1. Description

Used to configure the MET tool grid_diag.

4.8.2. METplus Configuration

4.8.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/GridDiagConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// 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}

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC or GRID_DIAG_DESC

desc

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

GRID_DIAG_REGRID_SHAPE

regrid.shape

GRID_DIAG_REGRID_METHOD

regrid.method

GRID_DIAG_REGRID_WIDTH

regrid.width

GRID_DIAG_REGRID_VLD_THRESH

regrid.vld_thresh

GRID_DIAG_REGRID_TO_GRID

regrid.to_grid

${METPLUS_CENSOR_THRESH}

METplus Config(s)

MET Config File

GRID_DIAG_CENSOR_THRESH

censor_thresh

${METPLUS_CENSOR_VAL}

METplus Config(s)

MET Config File

GRID_DIAG_CENSOR_VAL

censor_val

${METPLUS_DATA_DICT}

METplus Config(s)

MET Config File

BOTH_VAR<n>_NAME

data.field.name

BOTH_VAR<n>_LEVELS

data.field.level

BOTH_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_MASK_DICT}

METplus Config(s)

MET Config File

GRID_DIAG_MASK_GRID

mask.grid

GRID_DIAG_MASK_POLY

mask.poly

Note

Since the default value in the MET config file for ‘grid’ is grid = [ “FULL” ];, setting GRID_DIAG_MASK_GRID to an empty string will result in a value of grid = []; in the MET config file.

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

GRID_DIAG_MET_CONFIG_OVERRIDES

n/a

4.9. GridStat

4.9.1. Description

Used to configure the MET tool grid_stat.

4.9.2. METplus Configuration


4.9.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/GridStatConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// Grid-Stat 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
// May be set separately in each "obs.field" entry
//
// desc =
${METPLUS_DESC}

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

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

//
// Verification grid
//
// regrid = {
${METPLUS_REGRID_DICT}

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

censor_thresh    = [];
censor_val       = [];
cat_thresh  	 = [];
cnt_thresh  	 = [ NA ];
cnt_logic   	 = UNION;
wind_thresh 	 = [ NA ];
wind_logic  	 = UNION;
eclv_points      = 0.05;
nc_pairs_var_suffix = "";
//nc_pairs_var_name =
${METPLUS_NC_PAIRS_VAR_NAME}
rank_corr_flag   = FALSE;

//
// Forecast and observation fields to be verified
//
fcst = {
  ${METPLUS_FCST_FILE_TYPE}
  ${METPLUS_FCST_FIELD}
}
obs = {
  ${METPLUS_OBS_FILE_TYPE}
  ${METPLUS_OBS_FIELD}
}

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

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


//climo_stdev = {
${METPLUS_CLIMO_STDEV_DICT}

//
// May be set separately in each "obs.field" entry
//
//climo_cdf = {
${METPLUS_CLIMO_CDF_DICT}

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

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

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

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

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

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

//
// Data smoothing methods
//
//interp = {
${METPLUS_INTERP_DICT}

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

//
// Neighborhood methods
//
nbrhd = {
   field      = BOTH;
   // shape =
   ${METPLUS_NBRHD_SHAPE}
   // width =
   ${METPLUS_NBRHD_WIDTH}
   // cov_thresh =
   ${METPLUS_NBRHD_COV_THRESH}
   vld_thresh = 1.0;
}

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

//
// Fourier decomposition
// May be set separately in each "obs.field" entry
//
fourier = {
   wave_1d_beg = [];
   wave_1d_end = [];
}

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

//
// Gradient statistics
// May be set separately in each "obs.field" entry
//
gradient = {
   dx = [ 1 ];
   dy = [ 1 ];
}

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

//
// Distance Map statistics
// May be set separately in each "obs.field" entry
//
distance_map = {
   baddeley_p        = 2;
   baddeley_max_dist = NA;
   fom_alpha         = 0.1;
   zhu_weight        = 0.5;
}

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

//
// Statistical output types
//
//output_flag = {
${METPLUS_OUTPUT_FLAG_DICT}

//
// NetCDF matched pairs output file
// May be set separately in each "obs.field" entry
//
// nc_pairs_flag = {
${METPLUS_NC_PAIRS_FLAG_DICT}

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

//grid_weight_flag =
${METPLUS_GRID_WEIGHT_FLAG}
tmp_dir          = "/tmp";
// output_prefix =
${METPLUS_OUTPUT_PREFIX}

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC or GRID_STAT_DESC

desc

${METPLUS_OBTYPE}

METplus Config(s)

MET Config File

OBTYPE

obtype

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

GRID_STAT_REGRID_SHAPE

regrid.shape

GRID_STAT_REGRID_METHOD

regrid.method

GRID_STAT_REGRID_WIDTH

regrid.width

GRID_STAT_REGRID_VLD_THRESH

regrid.vld_thresh

GRID_STAT_REGRID_TO_GRID

regrid.to_grid

${METPLUS_FCST_FIELD}

METplus Config(s)

MET Config File

FCST_VAR<n>_NAME

fcst.field.name

FCST_VAR<n>_LEVELS

fcst.field.level

FCST_VAR<n>_THRESH

fcst.field.cat_thresh

FCST_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_FCST_FILE_TYPE}

METplus Config(s)

MET Config File

FCST_GRID_STAT_FILE_TYPE

fcst.file_type

${METPLUS_OBS_FIELD}

METplus Config(s)

MET Config File

OBS_VAR<n>_NAME

fcst.field.name

OBS_VAR<n>_LEVELS

fcst.field.level

OBS_VAR<n>_THRESH

fcst.field.cat_thresh

OBS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the observation field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_OBS_FILE_TYPE}

METplus Config(s)

MET Config File

OBS_GRID_STAT_FILE_TYPE

obs.file_type

${METPLUS_CLIMO_MEAN_DICT}

METplus Config(s)

MET Config File

GRID_STAT_CLIMO_MEAN_FILE_NAME

climo_mean.file_name

GRID_STAT_CLIMO_MEAN_FIELD

climo_mean.field

GRID_STAT_CLIMO_MEAN_REGRID_METHOD

climo_mean.regrid.method

GRID_STAT_CLIMO_MEAN_REGRID_WIDTH

climo_mean.regrid.width

GRID_STAT_CLIMO_MEAN_REGRID_VLD_THRESH

climo_mean.regrid.vld_thresh

GRID_STAT_CLIMO_MEAN_REGRID_SHAPE

climo_mean.regrid.shape

GRID_STAT_CLIMO_MEAN_TIME_INTERP_METHOD

climo_mean.time_interp_method

GRID_STAT_CLIMO_MEAN_MATCH_MONTH

climo_mean.match_month

GRID_STAT_CLIMO_MEAN_DAY_INTERVAL

climo_mean.day_interval

GRID_STAT_CLIMO_MEAN_HOUR_INTERVAL

climo_mean.hour_interval

${METPLUS_CLIMO_STDEV_DICT}

METplus Config(s)

MET Config File

GRID_STAT_CLIMO_STDEV_FILE_NAME

climo_stdev.file_name

GRID_STAT_CLIMO_STDEV_FIELD

climo_stdev.field

GRID_STAT_CLIMO_STDEV_REGRID_METHOD

climo_stdev.regrid.method

GRID_STAT_CLIMO_STDEV_REGRID_WIDTH

climo_stdev.regrid.width

GRID_STAT_CLIMO_STDEV_REGRID_VLD_THRESH

climo_stdev.regrid.vld_thresh

GRID_STAT_CLIMO_STDEV_REGRID_SHAPE

climo_stdev.regrid.shape

GRID_STAT_CLIMO_STDEV_TIME_INTERP_METHOD

climo_stdev.time_interp_method

GRID_STAT_CLIMO_STDEV_MATCH_MONTH

climo_stdev.match_month

GRID_STAT_CLIMO_STDEV_DAY_INTERVAL

climo_stdev.day_interval

GRID_STAT_CLIMO_STDEV_HOUR_INTERVAL

climo_stdev.hour_interval

${METPLUS_MASK_DICT}

METplus Config(s)

MET Config File

GRID_STAT_MASK_GRID

mask.grid

GRID_STAT_MASK_POLY

mask.poly

Note

Since the default value in the MET config file for ‘grid’ is grid = [ “FULL” ];, setting GRID_STAT_MASK_GRID to an empty string will result in a value of grid = []; in the MET config file.

${METPLUS_NBRHD_SHAPE}

METplus Config(s)

MET Config File

GRID_STAT_NEIGHBORHOOD_SHAPE

nbrhd.shape

${METPLUS_NBRHD_WIDTH}

METplus Config(s)

MET Config File

GRID_STAT_NEIGHBORHOOD_WIDTH

nbrhd.width

${METPLUS_NBRHD_COV_THRESH}

METplus Config(s)

MET Config File

GRID_STAT_NEIGHBORHOOD_COV_THRESH

nbrhd.cov_thresh

${METPLUS_OUTPUT_PREFIX}

METplus Config(s)

MET Config File

GRID_STAT_OUTPUT_PREFIX

output_prefix

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

GRID_STAT_MET_CONFIG_OVERRIDES

n/a

${METPLUS_CLIMO_CDF_DICT}

METplus Config(s)

MET Config File

GRID_STAT_CLIMO_CDF_BINS

climo_cdf.cdf_bins

GRID_STAT_CLIMO_CDF_CENTER_BINS

climo_cdf.center_bins

GRID_STAT_CLIMO_CDF_WRITE_BINS

climo_cdf.write_bins

${METPLUS_OUTPUT_FLAG_DICT}

METplus Config(s)

MET Config File

GRID_STAT_OUTPUT_FLAG_FHO

output_flag.fho

GRID_STAT_OUTPUT_FLAG_CTC

output_flag.ctc

GRID_STAT_OUTPUT_FLAG_CTS

output_flag.cts

GRID_STAT_OUTPUT_FLAG_MCTC

output_flag.mctc

GRID_STAT_OUTPUT_FLAG_MCTS

output_flag.mcts

GRID_STAT_OUTPUT_FLAG_CNT

output_flag.cnt

GRID_STAT_OUTPUT_FLAG_SL1L2

output_flag.sl1l2

GRID_STAT_OUTPUT_FLAG_SAL1L2

output_flag.sal1l2

GRID_STAT_OUTPUT_FLAG_VL1L2

output_flag.vl1l2

GRID_STAT_OUTPUT_FLAG_VAL1L2

output_flag.val1l2

GRID_STAT_OUTPUT_FLAG_VCNT

output_flag.vcnt

GRID_STAT_OUTPUT_FLAG_PCT

output_flag.pct

GRID_STAT_OUTPUT_FLAG_PSTD

output_flag.pstd

GRID_STAT_OUTPUT_FLAG_PJC

output_flag.pjc

GRID_STAT_OUTPUT_FLAG_PRC

output_flag.prc

GRID_STAT_OUTPUT_FLAG_ECLV

output_flag.eclv

GRID_STAT_OUTPUT_FLAG_NBRCTC

output_flag.nbrctc

GRID_STAT_OUTPUT_FLAG_NBRCTS

output_flag.nbrcts

GRID_STAT_OUTPUT_FLAG_NBRCNT

output_flag.nbrcnt

GRID_STAT_OUTPUT_FLAG_GRAD

output_flag.grad

GRID_STAT_OUTPUT_FLAG_DMAP

output_flag.dmap

${METPLUS_NC_PAIRS_FLAG_DICT}

METplus Config(s)

MET Config File

GRID_STAT_NC_PAIRS_FLAG_LATLON

nc_pairs_flag.latlon

GRID_STAT_NC_PAIRS_FLAG_RAW

nc_pairs_flag.raw

GRID_STAT_NC_PAIRS_FLAG_DIFF

nc_pairs_flag.diff

GRID_STAT_NC_PAIRS_FLAG_CLIMO

nc_pairs_flag.climo

GRID_STAT_NC_PAIRS_FLAG_CLIMO_CDP

nc_pairs_flag.climo_cdp

GRID_STAT_NC_PAIRS_FLAG_WEIGHT

nc_pairs_flag.weight

GRID_STAT_NC_PAIRS_FLAG_NBRHD

nc_pairs_flag.nbrhd

GRID_STAT_NC_PAIRS_FLAG_FOURIER

nc_pairs_flag.fourier

GRID_STAT_NC_PAIRS_FLAG_GRADIENT

nc_pairs_flag.gradient

GRID_STAT_NC_PAIRS_FLAG_DISTANCE_MAP

nc_pairs_flag.distance_map

GRID_STAT_NC_PAIRS_FLAG_APPLY_MASK

nc_pairs_flag.apply_mask

${METPLUS_INTERP_DICT}

METplus Config(s)

MET Config File

GRID_STAT_INTERP_FIELD

interp.field

GRID_STAT_INTERP_VLD_THRESH

interp.vld_thresh

GRID_STAT_INTERP_SHAPE

interp.shape

GRID_STAT_INTERP_TYPE_METHOD

interp.type.method

GRID_STAT_INTERP_TYPE_WIDTH

interp.type.width

${METPLUS_NC_PAIRS_VAR_NAME}

METplus Config(s)

MET Config File

GRID_STAT_NC_PAIRS_VAR_NAME

nc_pairs_var_name

${METPLUS_GRID_WEIGHT_FLAG}

METplus Config(s)

MET Config File

GRID_STAT_GRID_WEIGHT_FLAG

grid_weight_flag

4.10. MakePlots

4.10.1. Description

The MakePlots wrapper creates various statistical plots using python scripts for the various METplus Wrappers use cases. This can only be run following StatAnalysis wrapper when LOOP_ORDER = processes. To run MakePlots wrapper, include MakePlots in PROCESS_LIST.

4.10.2. METplus Configuration

The following values must be defined in the METplus Wrappers configuration file:

The following values are optional in the METplus Wrappers configuration file:

4.11. METdbLoad

4.11.1. Description

Used to call the met_db_load.py script from dtcenter/METdatadb to load MET output into a METviewer database.

4.11.2. METplus Configuration

4.11.3. XML Configuration

Below is the XML template configuration file used for this wrapper. The wrapper substitutes values from the METplus configuration file into this configuration file. While it may appear that environment variables are used in the XML template file, they are not actually environment variables. The wrapper searches for these strings and substitutes the values as appropriate.

<load_spec>
  <connection>
    <host>${METPLUS_MV_HOST}</host>
    <database>${METPLUS_MV_DATABASE}</database>
    <user>${METPLUS_MV_USER}</user>
    <password>${METPLUS_MV_PASSWORD}</password>
  </connection>

  <verbose>${METPLUS_MV_VERBOSE}</verbose>
  <insert_size>${METPLUS_MV_INSERT_SIZE}</insert_size>
  <mode_header_db_check>${METPLUS_MV_MODE_HEADER_DB_CHECK}</mode_header_db_check>
  <drop_indexes>${METPLUS_MV_DROP_INDEXES}</drop_indexes>
  <apply_indexes>${METPLUS_MV_APPLY_INDEXES}</apply_indexes>
  <group>${METPLUS_MV_GROUP}</group>
  <load_stat>${METPLUS_MV_LOAD_STAT}</load_stat>
  <load_mode>${METPLUS_MV_LOAD_MODE}</load_mode>
  <load_mtd>${METPLUS_MV_LOAD_MTD}</load_mtd>
  <load_mpr>${METPLUS_MV_LOAD_MPR}</load_mpr>

  <folder_tmpl>{dirs}</folder_tmpl>
  <load_val>
    <field name="dirs">
      ${METPLUS_INPUT_PATHS}
    </field>
  </load_val>
</load_spec>

${METPLUS_MV_HOST}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_HOST

<load_spec><connection><host>

${METPLUS_MV_DATABASE}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_DATABASE

<load_spec><connection><database>

${METPLUS_MV_USER}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_USER

<load_spec><connection><user>

${METPLUS_MV_PASSWORD}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_PASSWORD

<load_spec><connection><password>

${METPLUS_MV_VERBOSE}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_VERBOSE

<load_spec><verbose>

${METPLUS_MV_INSERT_SIZE}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_INSERT_SIZE

<load_spec><insert_size>

${METPLUS_MV_MODE_HEADER_DB_CHECK}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_MODE_HEADER_DB_CHECK

<load_spec><mode_header_db_check>

${METPLUS_MV_DROP_INDEXES}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_DROP_INDEXES

<load_spec><drop_indexes>

${METPLUS_MV_APPLY_INDEXES}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_APPLY_INDEXES

<load_spec><apply_indexes>

${METPLUS_MV_GROUP}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_GROUP

<load_spec><group>

${METPLUS_MV_LOAD_STAT}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_LOAD_STAT

<load_spec><load_stat>

${METPLUS_MV_LOAD_MODE}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_LOAD_MODE

<load_spec><load_mode>

${METPLUS_MV_LOAD_MTD}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_LOAD_MTD

<load_spec><load_mtd>

${METPLUS_MV_LOAD_MPR}

METplus Config(s)

XML Config File

MET_DB_LOAD_MV_LOAD_MPR

<load_spec><load_mpr>

${METPLUS_INPUT_PATHS}

METplus Config(s)

XML Config File

MET_DB_LOAD_INPUT_TEMPLATE

<load_val><field name=”dirs”><val>

4.12. MODE

4.12.1. Description

Used to configure the MET Method for Object-based Diagnostic Evaluation tool mode.

4.12.2. METplus Configuration


Warning

DEPRECATED:

4.12.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/MODEConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// MODE configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////

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

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

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

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

//
// Verification grid
//
${METPLUS_REGRID_DICT}

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

//
// Approximate grid resolution (km)
//
// grid_res =
${METPLUS_GRID_RES}

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

//
// Run all permutations of radius and threshold
//
${METPLUS_QUILT}

//
// Forecast and observation fields to be verified
//
fcst = {
   ${METPLUS_FCST_FIELD}

   ${METPLUS_FCST_CENSOR_THRESH}
   ${METPLUS_FCST_CENSOR_VAL}
   ${METPLUS_FCST_CONV_RADIUS}
   ${METPLUS_FCST_CONV_THRESH}
   ${METPLUS_FCST_VLD_THRESH}
   ${METPLUS_FCST_FILTER_ATTR_NAME}
   ${METPLUS_FCST_FILTER_ATTR_THRESH}
   ${METPLUS_FCST_MERGE_THRESH}
   ${METPLUS_FCST_MERGE_FLAG}
}

obs = {
   ${METPLUS_OBS_FIELD}

   ${METPLUS_OBS_CENSOR_THRESH}
   ${METPLUS_OBS_CENSOR_VAL}
   ${METPLUS_OBS_CONV_RADIUS}
   ${METPLUS_OBS_CONV_THRESH}
   ${METPLUS_OBS_VLD_THRESH}
   ${METPLUS_OBS_FILTER_ATTR_NAME}
   ${METPLUS_OBS_FILTER_ATTR_THRESH}
   ${METPLUS_OBS_MERGE_THRESH}
   ${METPLUS_OBS_MERGE_FLAG}
}

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

//
// Handle missing data
//
mask_missing_flag = BOTH;

//
// Match objects between the forecast and observation fields
//
//match_flag =
${METPLUS_MATCH_FLAG}

//
// Maximum centroid distance for objects to be compared
//
//max_centroid_dist =
${METPLUS_MAX_CENTROID_DIST}

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

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

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

//
// Fuzzy engine weights
//
//weight = {
${METPLUS_WEIGHT_DICT}

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

//
// Fuzzy engine interest functions
//
interest_function = {

   ${METPLUS_INTEREST_FUNCTION_CENTROID_DIST}

   ${METPLUS_INTEREST_FUNCTION_BOUNDARY_DIST}

   ${METPLUS_INTEREST_FUNCTION_CONVEX_HULL_DIST}

   angle_diff = (
      (  0.0, 1.0 )
      ( 30.0, 1.0 )
      ( 90.0, 0.0 )
   );

   aspect_diff = (
      (  0.00, 1.0 )
      (  0.10, 1.0 )
      (  0.75, 0.0 )
   );

   corner   = 0.8;
   ratio_if = (
      (    0.0, 0.0 )
      ( corner, 1.0 )
      (    1.0, 1.0 )
   );

   area_ratio = ratio_if;

   int_area_ratio = (
      ( 0.00, 0.00 )
      ( 0.10, 0.50 )
      ( 0.25, 1.00 )
      ( 1.00, 1.00 )
   );

   curvature_ratio = ratio_if;

   complexity_ratio = ratio_if;

   inten_perc_ratio = ratio_if;
}

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

//
// Total interest threshold for determining matches
//
//total_interest_thresh =
${METPLUS_TOTAL_INTEREST_THRESH}

//
// Interest threshold for printing output pair information
//
print_interest_thresh = 0.0;

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

//
// Plotting information
//
met_data_dir = "MET_BASE";

fcst_raw_plot = {
   color_table      = "MET_BASE/colortables/met_default.ctable";
   plot_min         = 0.0;
   plot_max         = 0.0;
   colorbar_spacing = 1;
}

obs_raw_plot = {
   color_table      = "MET_BASE/colortables/met_default.ctable";
   plot_min         = 0.0;
   plot_max         = 0.0;
   colorbar_spacing = 1;
}

object_plot = {
   color_table      = "MET_BASE/colortables/mode_obj.ctable";
}

//
// Boolean for plotting on the region of valid data within the domain
//
plot_valid_flag = FALSE;

//
// Plot polyline edges using great circle arcs instead of straight lines
//
plot_gcarc_flag = FALSE;

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

//
// NetCDF matched pairs, PostScript, and contingency table output files
//
ps_plot_flag    = TRUE;

//nc_pairs_flag = {
${METPLUS_NC_PAIRS_FLAG_DICT}

ct_stats_flag   = TRUE;

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

shift_right = 0;   //  grid squares

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

${METPLUS_OUTPUT_PREFIX}
//version        = "V10.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

MODE_DESC

desc

${METPLUS_OBTYPE}

METplus Config(s)

MET Config File

OBTYPE

obtype

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

MODE_REGRID_SHAPE

regrid.shape

MODE_REGRID_METHOD

regrid.method

MODE_REGRID_WIDTH

regrid.width

MODE_REGRID_VLD_THRESH

regrid.vld_thresh

MODE_REGRID_TO_GRID

regrid.to_grid

${METPLUS_GRID_RES}

METplus Config(s)

MET Config File

MODE_GRID_RES

grid_res

${METPLUS_QUILT}

METplus Config(s)

MET Config File

MODE_QUILT

quilt

${METPLUS_FCST_FIELD}

METplus Config(s)

MET Config File

FCST_VAR<n>_NAME

fcst.field.name

FCST_VAR<n>_LEVELS

fcst.field.level

FCST_VAR<n>_THRESH

fcst.field.cat_thresh

FCST_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_FCST_CONV_RADIUS}

METplus Config(s)

MET Config File

MODE_FCST_CONV_RADIUS

fcst.conv_radius

${METPLUS_FCST_CONV_THRESH}

METplus Config(s)

MET Config File

MODE_FCST_CONV_THRESH

fcst.conv_thresh

${METPLUS_FCST_MERGE_THRESH}

METplus Config(s)

MET Config File

MODE_FCST_MERGE_THRESH

fcst.merge_thresh

${METPLUS_FCST_MERGE_FLAG}

METplus Config(s)

MET Config File

MODE_FCST_MERGE_FLAG

fcst.merge_flag

${METPLUS_OBS_FIELD}

METplus Config(s)

MET Config File

OBS_VAR<n>_NAME

fcst.field.name

OBS_VAR<n>_LEVELS

fcst.field.level

OBS_VAR<n>_THRESH

fcst.field.cat_thresh

OBS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the observation field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_OBS_CONV_RADIUS}

METplus Config(s)

MET Config File

OBS_MODE_CONV_RADIUS

obs.conv_radius

${METPLUS_OBS_CONV_THRESH}

METplus Config(s)

MET Config File

OBS_MODE_CONV_THRESH

obs.conv_thresh

${METPLUS_OBS_MERGE_THRESH}

METplus Config(s)

MET Config File

OBS_MODE_MERGE_THRESH

obs.merge_thresh

${METPLUS_OBS_MERGE_FLAG}

METplus Config(s)

MET Config File

OBS_MODE_MERGE_FLAG

obs.merge_flag

${METPLUS_MASK_POLY}

METplus Config(s)

MET Config File

MODE_MASK_POLY

mask.poly

${METPLUS_OUTPUT_PREFIX}

METplus Config(s)

MET Config File

MODE_OUTPUT_PREFIX

output_prefix

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

MODE_MET_CONFIG_OVERRIDES

n/a

${METPLUS_FCST_FILTER_ATTR_NAME}

METplus Config(s)

MET Config File

MODE_FCST_FILTER_ATTR_NAME

fcst.filter_attr_name

${METPLUS_FCST_FILTER_ATTR_THRESH}

METplus Config(s)

MET Config File

MODE_FCST_FILTER_ATTR_THRESH

fcst.filter_attr_thresh

${METPLUS_FCST_CENSOR_THRESH}

METplus Config(s)

MET Config File

MODE_FCST_CENSOR_THRESH

fcst.censor_thresh

${METPLUS_FCST_CENSOR_VAL}

METplus Config(s)

MET Config File

MODE_FCST_CENSOR_VAL

fcst.censor_val

${METPLUS_FCST_VLD_THRESH}

METplus Config(s)

MET Config File

MODE_FCST_VLD_THRESH

fcst.vld_thresh

${METPLUS_OBS_FILTER_ATTR_NAME}

METplus Config(s)

MET Config File

MODE_OBS_FILTER_ATTR_NAME

obs.filter_attr_name

${METPLUS_OBS_FILTER_ATTR_THRESH}

METplus Config(s)

MET Config File

MODE_OBS_FILTER_ATTR_THRESH

obs.filter_attr_thresh

${METPLUS_OBS_CENSOR_THRESH}

METplus Config(s)

MET Config File

MODE_OBS_CENSOR_THRESH

obs.censor_thresh

${METPLUS_OBS_CENSOR_VAL}

METplus Config(s)

MET Config File

MODE_OBS_CENSOR_VAL

obs.censor_val

${METPLUS_OBS_VLD_THRESH}

METplus Config(s)

MET Config File

MODE_OBS_VLD_THRESH

obs.vld_thresh

${METPLUS_MASK_DICT}

METplus Config(s)

MET Config File

MODE_MASK_GRID

mask.grid

MODE_MASK_GRID_FLAG

mask.grid_flag

MODE_MASK_POLY

mask.poly

MODE_MASK_POLY_FLAG

mask.poly_flag

${METPLUS_MATCH_FLAG}

METplus Config(s)

MET Config File

MODE_MATCH_FLAG

match_flag

${METPLUS_WEIGHT_DICT}

METplus Config(s)

MET Config File

MODE_WEIGHT_CENTROID_DIST

weight.centroid_dist

MODE_WEIGHT_BOUNDARY_DIST

weight.boundary_dist

MODE_WEIGHT_CONVEX_HULL_DIST

weight.convex_hull_dist

MODE_WEIGHT_ANGLE_DIFF

weight.angle_diff

MODE_WEIGHT_ASPECT_DIFF

weight.aspect_diff

MODE_WEIGHT_AREA_RATIO

weight.area_ratio

MODE_WEIGHT_INT_AREA_RATIO

weight.int_area_ratio

MODE_WEIGHT_CURVATURE_RATIO

weight.curvature_ratio

MODE_WEIGHT_COMPLEXITY_RATIO

weight.complexity_ratio

MODE_WEIGHT_INTEN_PERC_RATIO

weight.inten_perc_ratio

MODE_WEIGHT_INTEN_PERC_VALUE

weight.inten_perc_value

${METPLUS_NC_PAIRS_FLAG_DICT}

METplus Config(s)

MET Config File

MODE_NC_PAIRS_FLAG_LATLON

nc_pairs_flag.latlon

MODE_NC_PAIRS_FLAG_RAW

nc_pairs_flag.raw

MODE_NC_PAIRS_FLAG_OBJECT_RAW

nc_pairs_flag.object_raw

MODE_NC_PAIRS_FLAG_OBJECT_ID

nc_pairs_flag.object_id

MODE_NC_PAIRS_FLAG_CLUSTER_ID

nc_pairs_flag.cluster_id

MODE_NC_PAIRS_FLAG_POLYLINES

nc_pairs_flag.polylines

${METPLUS_MAX_CENTROID_DIST}

METplus Config(s)

MET Config File

MODE_MAX_CENTROID_DIST

max_centroid_dist

${METPLUS_INTEREST_FUNCTION_CENTROID_DIST}

METplus Config(s)

MET Config File

MODE_INTEREST_FUNCTION_CENTROID_DIST

interest_function.centroid_dist

${METPLUS_INTEREST_FUNCTION_BOUNDARY_DIST}

METplus Config(s)

MET Config File

MODE_INTEREST_FUNCTION_BOUNDARY_DIST

interest_function.boundary_dist

${METPLUS_INTEREST_FUNCTION_CONVEX_HULL_DIST}

METplus Config(s)

MET Config File

MODE_INTEREST_FUNCTION_CONVEX_HULL_DIST

interest_function.convex_hull_dist

${METPLUS_TOTAL_INTEREST_THRESH}

METplus Config(s)

MET Config File

MODE_TOTAL_INTEREST_THRESH

total_interest_thresh

4.13. MTD

4.13.1. Description

Used to configure the MET MODE Time Domain tool mtd. This tools follows objects through time and can also be used to track objects.

4.13.2. METplus Configuration

4.13.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/MTDConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// MODE Time Domain configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////

   //
   // Output model name to be written
   //

${METPLUS_MODEL}

   //
   // Output description to be written
   //

${METPLUS_DESC}

   //
   // Output observation type to be written
   //

${METPLUS_OBTYPE}

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

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

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

   //
   // Approximate grid resolution (km)
   //

grid_res = 4;

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

   //
   // Forecast and observation fields to be verified
   //

fcst = {

   ${METPLUS_FCST_FILE_TYPE}

   ${METPLUS_FCST_FIELD}

   censor_thresh     = [];
   censor_val        = [];
   conv_time_window  = { beg = -1; end = 1; };
   ${METPLUS_FCST_CONV_RADIUS}
   ${METPLUS_FCST_CONV_THRESH}

}

obs = {

   ${METPLUS_OBS_FILE_TYPE}

   ${METPLUS_OBS_FIELD}

   censor_thresh     = [];
   censor_val        = [];
   conv_time_window  = { beg = -1; end = 1; };
   ${METPLUS_OBS_CONV_RADIUS}
   ${METPLUS_OBS_CONV_THRESH}
}

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

   //
   // Intensity percentile value to be written
   //

inten_perc_value = 99;

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

   //
   //  Throw away 3D objects with volumes smaller than this
   //
${METPLUS_MIN_VOLUME}


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

   //
   // Fuzzy engine weights
   //

weight = {

   space_centroid_dist  = 1.0;

   time_centroid_delta  = 1.0;

   speed_delta          = 1.0;

   direction_diff       = 1.0;

   volume_ratio         = 1.0;

   axis_angle_diff      = 1.0;

   start_time_delta     = 1.0;

   end_time_delta       = 1.0;

}

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

   //
   // Fuzzy engine interest functions
   //

interest_function = {

   space_centroid_dist = (

      (   0.0, 1.0 )
      (  50.0, 0.5 )
      ( 100.0, 0.0 )

   );

   time_centroid_delta = (

      ( -3.0, 0.0 )
      ( -2.0, 0.5 )
      ( -1.0, 0.8 )
      (  0.0, 1.0 )
      (  1.0, 0.8 )
      (  2.0, 0.5 )
      (  3.0, 0.0 )

   );

   speed_delta = (

      ( -10.0, 0.0 )
      (  -5.0, 0.5 )
      (   0.0, 1.0 )
      (   5.0, 0.5 )
      (  10.0, 0.0 )

   );

   direction_diff = (

      (   0.0, 1.0 )
      (  90.0, 0.0 )
      ( 180.0, 0.0 )

   );

   volume_ratio = (

      (  0.0, 0.0 )
      (  0.5, 0.5 )
      (  1.0, 1.0 )
      (  1.5, 0.5 )
      (  2.0, 0.0 )

   );

   axis_angle_diff = (

      (  0.0, 1.0 )
      ( 30.0, 1.0 )
      ( 90.0, 0.0 )

   );

   start_time_delta = (

      ( -5.0, 0.0 )
      ( -3.0, 0.5 )
      (  0.0, 1.0 )
      (  3.0, 0.5 )
      (  5.0, 0.0 )

   );

   end_time_delta = (

      ( -5.0, 0.0 )
      ( -3.0, 0.5 )
      (  0.0, 1.0 )
      (  3.0, 0.5 )
      (  5.0, 0.0 )

   );

}   //  interest functions


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

   //
   // Total interest threshold for determining matches
   //

total_interest_thresh = 0.7;


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

   //
   // Output flags
   //

nc_output = {

   latlon       = true;
   raw          = true;
   object_id    = true;
   cluster_id   = true;

}

txt_output = {

   attributes_2d   = true;
   attributes_3d   = true;

}


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

${METPLUS_OUTPUT_PREFIX}
//version        = "V9.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

MTD_DESC

desc

${METPLUS_OBTYPE}

METplus Config(s)

MET Config File

OBTYPE

obtype

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

MTD_REGRID_SHAPE

regrid.shape

MTD_REGRID_METHOD

regrid.method

MTD_REGRID_WIDTH

regrid.width

MTD_REGRID_VLD_THRESH

regrid.vld_thresh

MTD_REGRID_TO_GRID

regrid.to_grid

${METPLUS_FCST_FILE_TYPE}

METplus Config(s)

MET Config File

FCST_MTD_INPUT_DATATYPE

fcst.file_type

${METPLUS_FCST_FIELD}

METplus Config(s)

MET Config File

FCST_VAR<n>_NAME

fcst.field.name

FCST_VAR<n>_LEVELS

fcst.field.level

FCST_VAR<n>_THRESH

fcst.field.cat_thresh

FCST_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_FCST_CONV_RADIUS}

METplus Config(s)

MET Config File

MTD_FCST_CONV_RADIUS

fcst.conv_radius

${METPLUS_FCST_CONV_THRESH}

METplus Config(s)

MET Config File

MTD_FCST_CONV_THRESH

fcst.conv_thresh

${METPLUS_OBS_FILE_TYPE}

METplus Config(s)

MET Config File

OBS_MTD_INPUT_DATATYPE

obs.file_type

${METPLUS_OBS_FIELD}

METplus Config(s)

MET Config File

OBS_VAR<n>_NAME

fcst.field.name

OBS_VAR<n>_LEVELS

fcst.field.level

OBS_VAR<n>_THRESH

fcst.field.cat_thresh

OBS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the observation field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_OBS_CONV_RADIUS}

METplus Config(s)

MET Config File

MTD_OBS_CONV_RADIUS

obs.conv_radius

${METPLUS_OBS_CONV_THRESH}

METplus Config(s)

MET Config File

MTD_OBS_CONV_THRESH

obs.conv_thresh

${METPLUS_MIN_VOLUME}

METplus Config(s)

MET Config File

MTD_MIN_VOLUME

min_volume

${METPLUS_OUTPUT_PREFIX}

METplus Config(s)

MET Config File

MTD_OUTPUT_PREFIX

output_prefix

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

MTD_MET_CONFIG_OVERRIDES

n/a

4.14. PB2NC

4.14.1. Description

The PB2NC wrapper is a Python script that encapsulates the behavior of the MET pb2nc tool to convert prepBUFR files into netCDF.

4.14.2. METplus Configuration

4.14.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/PB2NCConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// PB2NC configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////

//
// PrepBufr message type
//
${METPLUS_MESSAGE_TYPE}

//
// Mapping of message type group name to comma-separated list of values
// Derive PRMSL only for SURFACE message types
//
message_type_group_map = [
   { key = "SURFACE"; val = "ADPSFC,SFCSHP,MSONET";               },
   { key = "ANYAIR";  val = "AIRCAR,AIRCFT";                      },
   { key = "ANYSFC";  val = "ADPSFC,SFCSHP,ADPUPA,PROFLR,MSONET"; },
   { key = "ONLYSF";  val = "ADPSFC,SFCSHP";                      }
];

//
// Mapping of input PrepBufr message types to output message types
//
message_type_map = [];

//
// PrepBufr station ID
//
${METPLUS_STATION_ID}


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

//
// Observation time window
//
${METPLUS_OBS_WINDOW_DICT}

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

//
// Observation retention regions
//
${METPLUS_MASK_DICT}

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

//
// Observing location elevation
//
elevation_range = {
   beg =  -1000;
   end = 100000;
}

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

//
// Observation types
//
//pb_report_type =
${METPLUS_PB_REPORT_TYPE}

in_report_type  = [];

instrument_type = [];

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

//
// Vertical levels to retain
//
//level_range = {
${METPLUS_LEVEL_RANGE_DICT}

//level_category =
${METPLUS_LEVEL_CATEGORY}

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

//
// BUFR variable names to retain or derive.
// If emtpy, process all available variables.
//
${METPLUS_OBS_BUFR_VAR}

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

//
// Mapping of BUFR variable name to GRIB name. The default map is defined at
// obs_prepbufr_map. This replaces/expends the default map.
//
obs_bufr_map = [];

// This map is for PREPBUFR. It will be added into obs_bufr_map.
// Please do not override this map.
obs_prefbufr_map = [
   { key = "POB";     val = "PRES";  },
   { key = "QOB";     val = "SPFH";  },
   { key = "TOB";     val = "TMP";   },
   { key = "ZOB";     val = "HGT";   },
   { key = "UOB";     val = "UGRD";  },
   { key = "VOB";     val = "VGRD";  },
   { key = "D_DPT";   val = "DPT";   },
   { key = "D_WDIR";  val = "WDIR";  },
   { key = "D_WIND";  val = "WIND";  },
   { key = "D_RH";    val = "RH";    },
   { key = "D_MIXR";  val = "MIXR";  },
   { key = "D_PRMSL"; val = "PRMSL"; },
   { key = "D_PBL";   val = "PBL";   },
   { key = "D_CAPE";  val = "CAPE";  }
];


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

//quality_mark_thresh =
${METPLUS_QUALITY_MARK_THRESH}

event_stack_flag    = TOP;

////////////////////////////////////////////////////////////////////////////////
//
// Time periods for the summarization
//
${METPLUS_TIME_SUMMARY_DICT}

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

tmp_dir = "/tmp";
//version = "V9.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MESSAGE_TYPE}

METplus Config(s)

MET Config File

PB2NC_MESSAGE_TYPE

message_type

${METPLUS_STATION_ID}

METplus Config(s)

MET Config File

PB2NC_STATION_ID

station_id

${METPLUS_OBS_WINDOW_DICT}

METplus Config(s)

MET Config File

PB2NC_OBS_WINDOW_BEGIN

obs_window.beg

PB2NC_OBS_WINDOW_END

obs_window.end

${METPLUS_MASK_DICT}

METplus Config(s)

MET Config File

PB2NC_MASK_GRID

mask.grid

PB2NC_MASK_POLY

mask.poly

Note

Since the default value in the MET config file for ‘grid’ is grid = [ “FULL” ];, setting GRID_STAT_MASK_GRID to an empty string will result in a value of grid = []; in the MET config file.

${METPLUS_OBS_BUFR_VAR}

METplus Config(s)

MET Config File

PB2NC_OBS_BUFR_VAR_LIST

obs_bufr_var

${METPLUS_TIME_SUMMARY_DICT}

METplus Config(s)

MET Config File

PB2NC_TIME_SUMMARY_FLAG

time_summary.flag

PB2NC_TIME_SUMMARY_RAW_DATA

time_summary.raw_data

PB2NC_TIME_SUMMARY_BEG

time_summary.beg

PB2NC_TIME_SUMMARY_END

time_summary.end

PB2NC_TIME_SUMMARY_STEP

time_summary.step

PB2NC_TIME_SUMMARY_WIDTH

time_summary.width

PB2NC_TIME_SUMMARY_GRIB_CODES

time_summary.grib_code

PB2NC_TIME_SUMMARY_VAR_NAMES

time_summary.obs_var

PB2NC_TIME_SUMMARY_TYPES

time_summary.type

PB2NC_TIME_SUMMARY_VALID_FREQ

time_summary.vld_freq

PB2NC_TIME_SUMMARY_VALID_THRESH

time_summary.vld_thresh

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

PB2NC_MET_CONFIG_OVERRIDES

n/a

${METPLUS_PB_REPORT_TYPE}

METplus Config(s)

MET Config File

PB2NC_PB_REPORT_TYPE

pb_report_type

${METPLUS_LEVEL_RANGE_DICT}

METplus Config(s)

MET Config File

PB2NC_LEVEL_RANGE_BEG

level_range.beg

PB2NC_LEVEL_RANGE_END

level_range.end

${METPLUS_LEVEL_CATEGORY}

METplus Config(s)

MET Config File

PB2NC_LEVEL_CATEGORY

level_category

${METPLUS_QUALITY_MARK_THRESH}

METplus Config(s)

MET Config File

PB2NC_QUALITY_MARK_THRESH

quality_mark_thresh

4.15. PCPCombine

4.15.1. Description

The PCPCombine wrapper is a Python script that encapsulates the MET PCPCombine tool. It provides the infrastructure to combine or extract from files to build desired accumulations.

4.15.2. METplus Configuration


4.16. PlotDataPlane

4.16.1. Description

The PlotDataPlane wrapper is a Python script that encapsulates the MET plot_data_plane tool. It provides the infrastructure to read in any input that MET can read and plot them. This tool is often used to verify that the data is mapped to the correct grid location.

4.16.2. Configuration

4.17. Point2Grid

4.17.1. Description

The Point2Grid wrapper is a Python script that encapsulates the MET point2grid tool. It provides the infrastructure to read in point observations and place them on a grid

4.17.2. METplus Configuration

4.18. PointStat

4.18.1. Description

The PointStat wrapper is a Python script that encapsulates the MET point_stat tool. It provides the infrastructure to read in gridded model data and netCDF point observation data to perform grid-to-point (grid-to-obs) verification.

4.18.2. Configuration


4.18.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/PointStatConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// Point-Stat 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
// May be set separately in each "obs.field" entry
//
// desc =
${METPLUS_DESC}

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

//
// Verification grid
//
// regrid = {
${METPLUS_REGRID_DICT}

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

//
// May be set separately in each "field" entry
//
censor_thresh = [];
censor_val    = [];
cat_thresh    = [ NA ];
cnt_thresh    = [ NA ];
cnt_logic     = UNION;
wind_thresh   = [ NA ];
wind_logic    = UNION;
eclv_points   = 0.05;
rank_corr_flag = FALSE;

//
// Forecast and observation fields to be verified
//
fcst = {
  ${METPLUS_FCST_FIELD}
}

obs = {
  ${METPLUS_OBS_FIELD}
}
////////////////////////////////////////////////////////////////////////////////

//
// Point observation filtering options
// May be set separately in each "obs.field" entry
//
// message_type =
${METPLUS_MESSAGE_TYPE}
sid_exc        = [];
//obs_quality =
${METPLUS_OBS_QUALITY}
duplicate_flag = NONE;
obs_summary    = NONE;
obs_perc_value = 50;

//
// Mapping of message type group name to comma-separated list of values.
//
message_type_group_map = [
   { key = "SURFACE"; val = "ADPSFC,SFCSHP,MSONET";               },
   { key = "ANYAIR";  val = "AIRCAR,AIRCFT";                      },
   { key = "ANYSFC";  val = "ADPSFC,SFCSHP,ADPUPA,PROFLR,MSONET"; },
   { key = "ONLYSF";  val = "ADPSFC,SFCSHP";                      },
   { key = "LANDSF";  val = "ADPSFC,MSONET";                      },
   { key = "WATERSF"; val = "SFCSHP";                             }
];

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

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


//climo_stdev = {
${METPLUS_CLIMO_STDEV_DICT}

//
// May be set separately in each "obs.field" entry
//
//climo_cdf = {
${METPLUS_CLIMO_CDF_DICT}

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

//
// Point observation time window
//
// obs_window = {
${METPLUS_OBS_WINDOW_DICT}

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

//
// Verification masking regions
//
mask = {
   ${METPLUS_MASK_GRID}
   ${METPLUS_MASK_POLY}
   ${METPLUS_MASK_SID}
   llpnt = [];
}

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

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

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

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

//
// Interpolation methods
//
//interp = {
${METPLUS_INTERP_DICT}

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

//
// HiRA verification method
//
hira = {
   flag       = FALSE;
   width      = [ 2, 3, 4, 5 ];
   vld_thresh = 1.0;
   cov_thresh = [ ==0.25 ];
   shape      = SQUARE;
}

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

//
// Statistical output types
//
//output_flag = {
${METPLUS_OUTPUT_FLAG_DICT}

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

tmp_dir        = "/tmp";
// output_prefix =
${METPLUS_OUTPUT_PREFIX}
//version        = "V10.0.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC -or- POINT_STAT_DESC

desc

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

POINT_STAT_REGRID_SHAPE

regrid.shape

POINT_STAT_REGRID_METHOD

regrid.method

POINT_STAT_REGRID_WIDTH

regrid.width

POINT_STAT_REGRID_VLD_THRESH

regrid.vld_thresh

POINT_STAT_REGRID_TO_GRID

regrid.to_grid

${METPLUS_FCST_FIELD}

METplus Config(s)

MET Config File

FCST_VAR<n>_NAME

fcst.field.name

FCST_VAR<n>_LEVELS

fcst.field.level

FCST_VAR<n>_THRESH

fcst.field.cat_thresh

FCST_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_OBS_FIELD}

METplus Config(s)

MET Config File

OBS_VAR<n>_NAME

fcst.field.name

OBS_VAR<n>_LEVELS

fcst.field.level

OBS_VAR<n>_THRESH

fcst.field.cat_thresh

OBS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the observation field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_MESSAGE_TYPE}

METplus Config(s)

MET Config File

POINT_STAT_MESSAGE_TYPE

message_type

${METPLUS_CLIMO_MEAN_DICT}

METplus Config(s)

MET Config File

POINT_STAT_CLIMO_MEAN_FILE_NAME

climo_mean.file_name

POINT_STAT_CLIMO_MEAN_FIELD

climo_mean.field

POINT_STAT_CLIMO_MEAN_REGRID_METHOD

climo_mean.regrid.method

POINT_STAT_CLIMO_MEAN_REGRID_WIDTH

climo_mean.regrid.width

POINT_STAT_CLIMO_MEAN_REGRID_VLD_THRESH

climo_mean.regrid.vld_thresh

POINT_STAT_CLIMO_MEAN_REGRID_SHAPE

climo_mean.regrid.shape

POINT_STAT_CLIMO_MEAN_TIME_INTERP_METHOD

climo_mean.time_interp_method

POINT_STAT_CLIMO_MEAN_MATCH_MONTH

climo_mean.match_month

POINT_STAT_CLIMO_MEAN_DAY_INTERVAL

climo_mean.day_interval

POINT_STAT_CLIMO_MEAN_HOUR_INTERVAL

climo_mean.hour_interval

${METPLUS_CLIMO_STDEV_DICT}

METplus Config(s)

MET Config File

POINT_STAT_CLIMO_STDEV_FILE_NAME

climo_stdev.file_name

POINT_STAT_CLIMO_STDEV_FIELD

climo_stdev.field

POINT_STAT_CLIMO_STDEV_REGRID_METHOD

climo_stdev.regrid.method

POINT_STAT_CLIMO_STDEV_REGRID_WIDTH

climo_stdev.regrid.width

POINT_STAT_CLIMO_STDEV_REGRID_VLD_THRESH

climo_stdev.regrid.vld_thresh

POINT_STAT_CLIMO_STDEV_REGRID_SHAPE

climo_stdev.regrid.shape

POINT_STAT_CLIMO_STDEV_TIME_INTERP_METHOD

climo_stdev.time_interp_method

POINT_STAT_CLIMO_STDEV_MATCH_MONTH

climo_stdev.match_month

POINT_STAT_CLIMO_STDEV_DAY_INTERVAL

climo_stdev.day_interval

POINT_STAT_CLIMO_STDEV_HOUR_INTERVAL

climo_stdev.hour_interval

${METPLUS_OBS_WINDOW_DICT}

METplus Config(s)

MET Config File

OBS_WINDOW_BEGIN

obs_window.beg

OBS_WINDOW_END

obs_window.end

${METPLUS_MASK_GRID}

METplus Config(s)

MET Config File

POINT_STAT_MASK_GRID

mask.grid

${METPLUS_MASK_POLY}

METplus Config(s)

MET Config File

POINT_STAT_MASK_POLY

mask.poly

${METPLUS_MASK_SID}

METplus Config(s)

MET Config File

POINT_STAT_MASK_SID

mask.sid

${METPLUS_OUTPUT_PREFIX}

METplus Config(s)

MET Config File

POINT_STAT_OUTPUT_PREFIX

output_prefix

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

POINT_STAT_MET_CONFIG_OVERRIDES

n/a

${METPLUS_CLIMO_CDF_DICT}

METplus Config(s)

MET Config File

POINT_STAT_CLIMO_CDF_BINS

climo_cdf.cdf_bins

POINT_STAT_CLIMO_CDF_CENTER_BINS

climo_cdf.center_bins

POINT_STAT_CLIMO_CDF_WRITE_BINS

climo_cdf.write_bins

${METPLUS_OBS_QUALITY}

METplus Config(s)

MET Config File

POINT_STAT_OBS_QUALITY

obs_quality

${METPLUS_OUTPUT_FLAG_DICT}

METplus Config(s)

MET Config File

POINT_STAT_OUTPUT_FLAG_FHO

output_flag.fho

POINT_STAT_OUTPUT_FLAG_CTC

output_flag.ctc

POINT_STAT_OUTPUT_FLAG_CTS

output_flag.cts

POINT_STAT_OUTPUT_FLAG_MCTC

output_flag.mctc

POINT_STAT_OUTPUT_FLAG_MCTS

output_flag.mcts

POINT_STAT_OUTPUT_FLAG_CNT

output_flag.cnt

POINT_STAT_OUTPUT_FLAG_SL1L2

output_flag.sl1l2

POINT_STAT_OUTPUT_FLAG_SAL1L2

output_flag.sal1l2

POINT_STAT_OUTPUT_FLAG_VL1L2

output_flag.vl1l2

POINT_STAT_OUTPUT_FLAG_VAL1L2

output_flag.val1l2

POINT_STAT_OUTPUT_FLAG_VCNT

output_flag.vcnt

POINT_STAT_OUTPUT_FLAG_PCT

output_flag.pct

POINT_STAT_OUTPUT_FLAG_PSTD

output_flag.pstd

POINT_STAT_OUTPUT_FLAG_PJC

output_flag.pjc

POINT_STAT_OUTPUT_FLAG_PRC

output_flag.prc

POINT_STAT_OUTPUT_FLAG_ECNT

output_flag.ecnt

POINT_STAT_OUTPUT_FLAG_RPS

output_flag.rps

POINT_STAT_OUTPUT_FLAG_ECLV

output_flag.eclv

POINT_STAT_OUTPUT_FLAG_MPR

output_flag.mpr

${METPLUS_INTERP_DICT}

METplus Config(s)

MET Config File

POINT_STAT_INTERP_VLD_THRESH

interp.vld_thresh

POINT_STAT_INTERP_SHAPE

interp.shape

POINT_STAT_INTERP_TYPE_METHOD

interp.type.method

POINT_STAT_INTERP_TYPE_WIDTH

interp.type.width

4.19. PyEmbedIngest

4.19.1. Description

Used to configure the PyEmbedIngest wrapper that runs RegridDataPlane to convert data using python embedding scripts into NetCDF so it can be read by the MET tools.

4.19.2. METplus Configuration

4.20. RegridDataPlane

4.20.1. Description

Used to configure the MET tool regrid_data_plane which can be used to change projections of a grid with user configurable interpolation choices. It can also be used to convert GRIB1 and GRIB2 files into netcdf files if desired.

4.20.2. METplus Configuration

Warning

DEPRECATED:

4.21. SeriesAnalysis

4.21.1. Description

The SeriesAnalysis wrapper is used to find files and build a command that calls the MET tool SeriesAnalysis. It can be configured to process ranges of inputs, i.e. once for all files, once for each forecast lead (using , once for a group of forecast leads, once for each initialization time, etc. with the SERIES_ANALYSIS_RUNTIME_FREQ variable. Optionally, a .tcst file generated by TCStat can be provided to allow filtering by storm ID (see SERIES_ANALYSIS_RUN_ONCE_PER_STORM_ID). Images of the output data can also optionally be generated as well as animated gif images (See SERIES_ANALYSIS_GENERATE_PLOTS and SERIES_ANALYSIS_GENERATE_ANIMATIONS)

4.21.2. METplus Configuration

LEAD_SEQ_<n> (Optional)

4.21.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/SeriesAnalysisConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

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

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

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

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

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

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

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

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

//
// Forecast and observation fields to be verified
//
fcst = {
   ${METPLUS_FCST_FILE_TYPE}
   ${METPLUS_FCST_FIELD}
}
obs = {
   ${METPLUS_OBS_FILE_TYPE}
   ${METPLUS_OBS_FIELD}
}

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

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


//climo_stdev = {
${METPLUS_CLIMO_STDEV_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 = {
   grid = "";
   poly = "";
}

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

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

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

//
// Statistical output types
//
output_stats = {
   fho    = [];
   ctc    = [];
   ${METPLUS_CTS_LIST}
   mctc   = [];
   mcts   = [];
   ${METPLUS_STAT_LIST}
   sl1l2  = [];
   sal1l2 = [];
   pct    = [];
   pstd   = [];
   pjc    = [];
   prc    = [];
}

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

rank_corr_flag = FALSE;
tmp_dir        = "/tmp";
//version        = "V10.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC -or- SERIES_ANALYSIS_DESC

desc

${METPLUS_OBTYPE}

METplus Config(s)

MET Config File

OBTYPE

obtype

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_REGRID_SHAPE

regrid.shape

SERIES_ANALYSIS_REGRID_METHOD

regrid.method

SERIES_ANALYSIS_REGRID_WIDTH

regrid.width

SERIES_ANALYSIS_REGRID_VLD_THRESH

regrid.vld_thresh

SERIES_ANALYSIS_REGRID_TO_GRID

regrid.to_grid

${METPLUS_CAT_THRESH}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_CAT_THRESH

cat_thresh

${METPLUS_FCST_FILE_TYPE}

METplus Config(s)

MET Config File

FCST_SERIES_ANALYSIS_INPUT_DATATYPE

fcst.file_type

${METPLUS_FCST_FIELD}

METplus Config(s)

MET Config File

FCST_VAR<n>_NAME

fcst.field.name

FCST_VAR<n>_LEVELS

fcst.field.level

FCST_VAR<n>_THRESH

fcst.field.cat_thresh

FCST_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the forecast field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_OBS_FILE_TYPE}

METplus Config(s)

MET Config File

OBS_SERIES_ANALYSIS_INPUT_DATATYPE

obs.file_type

${METPLUS_OBS_FIELD}

METplus Config(s)

MET Config File

OBS_VAR<n>_NAME

fcst.field.name

OBS_VAR<n>_LEVELS

fcst.field.level

OBS_VAR<n>_THRESH

fcst.field.cat_thresh

OBS_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the observation field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_CLIMO_MEAN_DICT}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_CLIMO_MEAN_FILE_NAME

climo_mean.file_name

SERIES_ANALYSIS_CLIMO_MEAN_FIELD

climo_mean.field

SERIES_ANALYSIS_CLIMO_MEAN_REGRID_METHOD

climo_mean.regrid.method

SERIES_ANALYSIS_CLIMO_MEAN_REGRID_WIDTH

climo_mean.regrid.width

SERIES_ANALYSIS_CLIMO_MEAN_REGRID_VLD_THRESH

climo_mean.regrid.vld_thresh

SERIES_ANALYSIS_CLIMO_MEAN_REGRID_SHAPE

climo_mean.regrid.shape

SERIES_ANALYSIS_CLIMO_MEAN_TIME_INTERP_METHOD

climo_mean.time_interp_method

SERIES_ANALYSIS_CLIMO_MEAN_MATCH_MONTH

climo_mean.match_month

SERIES_ANALYSIS_CLIMO_MEAN_DAY_INTERVAL

climo_mean.day_interval

SERIES_ANALYSIS_CLIMO_MEAN_HOUR_INTERVAL

climo_mean.hour_interval

${METPLUS_CLIMO_STDEV_DICT}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_CLIMO_STDEV_FILE_NAME

climo_stdev.file_name

SERIES_ANALYSIS_CLIMO_STDEV_FIELD

climo_stdev.field

SERIES_ANALYSIS_CLIMO_STDEV_REGRID_METHOD

climo_stdev.regrid.method

SERIES_ANALYSIS_CLIMO_STDEV_REGRID_WIDTH

climo_stdev.regrid.width

SERIES_ANALYSIS_CLIMO_STDEV_REGRID_VLD_THRESH

climo_stdev.regrid.vld_thresh

SERIES_ANALYSIS_CLIMO_STDEV_REGRID_SHAPE

climo_stdev.regrid.shape

SERIES_ANALYSIS_CLIMO_STDEV_TIME_INTERP_METHOD

climo_stdev.time_interp_method

SERIES_ANALYSIS_CLIMO_STDEV_MATCH_MONTH

climo_stdev.match_month

SERIES_ANALYSIS_CLIMO_STDEV_DAY_INTERVAL

climo_stdev.day_interval

SERIES_ANALYSIS_CLIMO_STDEV_HOUR_INTERVAL

climo_stdev.hour_interval

${METPLUS_BLOCK_SIZE}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_BLOCK_SIZE

block_size

${METPLUS_VLD_THRESH}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_VLD_THRESH

vld_thresh

${METPLUS_CTS_LIST}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_CTS_LIST

output_stats.cts

${METPLUS_STAT_LIST}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_STAT_LIST

output_stats.cnt

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

SERIES_ANALYSIS_MET_CONFIG_OVERRIDES

n/a

4.22. SeriesByInit

4.22.1. Description

Warning

This tool has been DEPRECATED. Please use SeriesAnalysis wrapper

4.23. SeriesByLead

4.23.1. Description

Warning

This tool has been DEPRECATED. Please use SeriesAnalysis wrapper

4.24. StatAnalysis

4.24.1. Description

The StatAnalysis wrapper encapsulates the behavior of the MET stat_analysis tool. It provides the infrastructure to summarize and filter the MET .stat files. StatAnalysis wrapper can be run in two different methods. First is to look at the STAT lines for a single date, to use this method set LOOP_ORDER = times. Second is to look at the STAT lines over a span of dates, to use this method set LOOP_ORDER = processes. To run StatAnalysis wrapper, include StatAnalysis in PROCESS_LIST.

4.24.2. METplus Configuration

The following values must be defined in the METplus Wrappers configuration file for running with LOOP_ORDER = times:

The following values are optional in the METplus Wrappers configuration file for running with LOOP_ORDER = times:

The following values must be defined in the METplus Wrappers configuration file for running with LOOP_ORDER = processes:

The following values are optional in the METplus Wrappers configuration file for running with LOOP_ORDER = processes:

4.24.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/STATAnalysisConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

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

//
// Filtering input STAT lines by the contents of each column
//
${METPLUS_MODEL}
${METPLUS_DESC}

${METPLUS_FCST_LEAD}
${METPLUS_OBS_LEAD}

${METPLUS_FCST_VALID_BEG}
${METPLUS_FCST_VALID_END}
${METPLUS_FCST_VALID_HOUR}

${METPLUS_OBS_VALID_BEG}
${METPLUS_OBS_VALID_END}
${METPLUS_OBS_VALID_HOUR}

${METPLUS_FCST_INIT_BEG}
${METPLUS_FCST_INIT_END}
${METPLUS_FCST_INIT_HOUR}

${METPLUS_OBS_INIT_BEG}
${METPLUS_OBS_INIT_END}
${METPLUS_OBS_INIT_HOUR}

${METPLUS_FCST_VAR}
${METPLUS_OBS_VAR}

${METPLUS_FCST_UNITS}
${METPLUS_OBS_UNITS}

${METPLUS_FCST_LEVEL}
${METPLUS_OBS_LEVEL}

${METPLUS_OBTYPE}

${METPLUS_VX_MASK}

${METPLUS_INTERP_MTHD}

${METPLUS_INTERP_PNTS}

${METPLUS_FCST_THRESH}
${METPLUS_OBS_THRESH}
${METPLUS_COV_THRESH}

${METPLUS_ALPHA}

${METPLUS_LINE_TYPE}

column = [];

weight = [];

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

//
// Array of STAT-Analysis jobs to be performed on the filtered data
//
${METPLUS_JOBS}

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

//
// Confidence interval settings
//
out_alpha = 0.05;

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

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

//
// WMO mean computation logic
//
wmo_sqrt_stats   = [ "CNT:FSTDEV",  "CNT:OSTDEV",  "CNT:ESTDEV",
                     "CNT:RMSE",    "CNT:RMSFA",   "CNT:RMSOA",
                     "VCNT:FS_RMS", "VCNT:OS_RMS", "VCNT:RMSVE",
                     "VCNT:FSTDEV", "VCNT:OSTDEV" ];

wmo_fisher_stats = [ "CNT:PR_CORR", "CNT:SP_CORR",
                     "CNT:KT_CORR", "CNT:ANOM_CORR" ];

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

rank_corr_flag = FALSE;
vif_flag       = FALSE;
tmp_dir        = "/tmp";
//version        = "V10.0";

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC_LIST

desc

${METPLUS_FCST_LEAD}

METplus Config(s)

MET Config File

FCST_LEAD_LIST

fcst_lead

${METPLUS_OBS_LEAD}

METplus Config(s)

MET Config File

OBS_LEAD_LIST

obs_lead

${METPLUS_FCST_VALID_BEG}

METplus Config(s)

MET Config File

FCST_VALID_HOUR_LIST and VALID_BEG

fcst_valid_beg

${METPLUS_FCST_VALID_END}

METplus Config(s)

MET Config File

FCST_VALID_HOUR_LIST and VALID_END

fcst_valid_end

${METPLUS_FCST_VALID_HOUR}

METplus Config(s)

MET Config File

FCST_VALID_HOUR_LIST

fcst_valid_hour

${METPLUS_OBS_VALID_BEG}

METplus Config(s)

MET Config File

OBS_VALID_HOUR_LIST and VALID_BEG

obs_valid_beg

${METPLUS_OBS_VALID_END}

METplus Config(s)

MET Config File

OBS_VALID_HOUR_LIST and VALID_END

obs_valid_end

${METPLUS_OBS_VALID_HOUR}

METplus Config(s)

MET Config File

OBS_VALID_HOUR_LIST

obs_valid_hour

${METPLUS_FCST_INIT_BEG}

METplus Config(s)

MET Config File

FCST_INIT_HOUR_LIST and INIT_BEG

fcst_init_beg

${METPLUS_FCST_INIT_END}

METplus Config(s)

MET Config File

FCST_INIT_HOUR_LIST and INIT_END

fcst_init_end

${METPLUS_FCST_INIT_HOUR}

METplus Config(s)

MET Config File

FCST_INIT_HOUR_LIST

fcst_init_hour

${METPLUS_OBS_INIT_BEG}

METplus Config(s)

MET Config File

OBS_INIT_HOUR_LIST and INIT_BEG

obs_init_beg

${METPLUS_OBS_INIT_END}

METplus Config(s)

MET Config File

OBS_INIT_HOUR_LIST and INIT_END

obs_init_end

${METPLUS_OBS_INIT_HOUR}

METplus Config(s)

MET Config File

OBS_INIT_HOUR_LIST

obs_init_hour

${METPLUS_FCST_VAR}

METplus Config(s)

MET Config File

FCST_VAR_LIST

fcst_var

${METPLUS_OBS_VAR}

METplus Config(s)

MET Config File

OBS_VAR_LIST

obs_var

${METPLUS_FCST_UNITS}

METplus Config(s)

MET Config File

FCST_UNITS_LIST

fcst_units

${METPLUS_OBS_UNITS}

METplus Config(s)

MET Config File

OBS_UNITS_LIST

obs_units

${METPLUS_FCST_LEVEL}

METplus Config(s)

MET Config File

FCST_LEVEL_LIST

fcst_lev

${METPLUS_OBS_LEVEL}

METplus Config(s)

MET Config File

OBS_LEVEL_LIST

obs_lev

${METPLUS_OBTYPE}

METplus Config(s)

MET Config File

MODEL<n>_OBTYPE

obtype

${METPLUS_VX_MASK}

METplus Config(s)

MET Config File

VX_MASK_LIST

vx_mask

${METPLUS_INTERP_MTHD}

METplus Config(s)

MET Config File

INTERP_MTHD_LIST

interp_mthd

${METPLUS_INTERP_PNTS}

METplus Config(s)

MET Config File

INTERP_PNTS_LIST

interp_pnts

${METPLUS_FCST_THRESH}

METplus Config(s)

MET Config File

FCST_THRESH_LIST

fcst_thresh

${METPLUS_OBS_THRESH}

METplus Config(s)

MET Config File

OBS_THRESH_LIST

obs_thresh

${METPLUS_COV_THRESH}

METplus Config(s)

MET Config File

COV_THRESH_LIST

cov_thresh

${METPLUS_ALPHA}

METplus Config(s)

MET Config File

ALPHA_LIST

alpha

${METPLUS_LINE_TYPE}

METplus Config(s)

MET Config File

LINE_TYPE_LIST

line_type

${METPLUS_JOBS}

METplus Config(s)

MET Config File

STAT_ANALYSIS_JOB_NAME

jobs

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

STAT_ANALYSIS_MET_CONFIG_OVERRIDES

n/a

4.25. TCGen

4.25.1. Description

The TCGen wrapper encapsulates the behavior of the MET tc_gen tool. The wrapper accepts track (Adeck or Bdeck) data and Genesis data.

4.25.2. METplus Configuration

4.25.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/TCGenConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// TC-Gen configuration file.
//
// For additional information, see the MET_BASE/config/README_TC file.
//
////////////////////////////////////////////////////////////////////////////////

//
// ATCF file format reference:
//   http://www.nrlmry.navy.mil/atcf_web/docs/database/new/abrdeck.html
//

////////////////////////////////////////////////////////////////////////////////
//
// Genesis event definition criteria.
//
////////////////////////////////////////////////////////////////////////////////

//
// Model initialization frequency in hours, starting at 0.
//
// init_freq =
${METPLUS_INIT_FREQ}

//
// Valid hour frequency to be analyzed in hours, starting at 0
//
// valid_freq =
${METPLUS_VALID_FREQ}

//
// Forecast hours to be searched for genesis events
//
// fcst_hr_window =
${METPLUS_FCST_HR_WINDOW_DICT}

//
// Minimum track duration for genesis event in hours.
//
// min_duration =
${METPLUS_MIN_DURATION}

//
// Forecast genesis event criteria.  Defined as tracks reaching the specified
// intensity category, maximum wind speed threshold, and minimum sea-level
// pressure threshold.  The forecast genesis time is the valid time of the first
// track point where all of these criteria are met.
//
// fcst_genesis =
${METPLUS_FCST_GENESIS_DICT}

//
// BEST track genesis event criteria.  Defined as tracks reaching the specified
// intensity category, maximum wind speed threshold, and minimum sea-level
// pressure threshold.  The BEST track genesis time is the valid time of the
// first track point where all of these criteria are met.
//
// best_genesis =
${METPLUS_BEST_GENESIS_DICT}

//
// Operational track technique name
//
// oper_technique =
${METPLUS_OPER_TECHNIQUE}

////////////////////////////////////////////////////////////////////////////////
//
// Track filtering options
// May be specified separately in each filter array entry.
//
////////////////////////////////////////////////////////////////////////////////

//
// Array of dictionaries containing the track filtering options
// If empty, a single filter is defined using the top-level settings.
//
// filter =
${METPLUS_FILTER}

//
// Description written to output DESC column
//
// desc =
${METPLUS_DESC}

//
// Forecast ATCF ID's
// If empty, all ATCF ID's found will be processed.
// Statistics will be generated separately for each ATCF ID.
//
// model =
${METPLUS_MODEL}

//
// BEST and operational track storm identifiers
//
// storm_id =
${METPLUS_STORM_ID}

//
// BEST and operational track storm names
//
// storm_name =
${METPLUS_STORM_NAME}

//
// Forecast and operational initialization times to include or exclude
//
// init_beg =
${METPLUS_INIT_BEG}

// init_end =
${METPLUS_INIT_END}

// init_inc =
${METPLUS_INIT_INC}

// init_exc =
${METPLUS_INIT_EXC}

//
// Forecast, BEST, and operational valid time window
//
// valid_beg =
${METPLUS_VALID_BEG}

// valid_end =
${METPLUS_VALID_END}

//
// Forecast and operational initialization hours
//
// init_hour =
${METPLUS_INIT_HOUR}

//
// Forecast and operational lead times in hours
//
// lead =
${METPLUS_LEAD}

//
// Spatial masking region (path to gridded data file or polyline file)
//
// vx_mask =
${METPLUS_VX_MASK}

//
// Spatial masking of hurricane basin names from the basin_file
//
// basin_mask =
${METPLUS_BASIN_MASK}

//
// Distance to land threshold
//
//dland_thresh =
${METPLUS_DLAND_THRESH}

////////////////////////////////////////////////////////////////////////////////
//
// Matching and scoring options
// May be specified separately in each filter array entry.
//
////////////////////////////////////////////////////////////////////////////////

//
// Genesis matching logic. Compare the forecast genesis point to all points in
// the Best track (TRUE) or the single Best track genesis point (FALSE).
//
//genesis_match_point_to_track =
${METPLUS_GENESIS_MATCH_POINT_TO_TRACK}

//
// Radius in km to search for a matching genesis event
//
// genesis_match_radius =
${METPLUS_GENESIS_MATCH_RADIUS}

//
// Time window in hours, relative to the model genesis time, to search for a
// matching Best track point
//
//genesis_match_window = {
${METPLUS_GENESIS_MATCH_WINDOW_DICT}

//
// Radius in km for a development scoring method hit
//
// dev_hit_radius =
${METPLUS_DEV_HIT_RADIUS}

//
// Time window in hours for a development scoring method hit
//
// dev_hit_window =
${METPLUS_DEV_HIT_WINDOW_DICT}

// Time window in hours for the Best track genesis minus model initialization
// time difference for an operational scoring method hit
//
//ops_hit_window = {
${METPLUS_OPS_HIT_WINDOW_DICT}

//
// Discard genesis forecasts for initializations at or after the matching
// BEST track genesis time
//
// discard_init_post_genesis_flag =
${METPLUS_DISCARD_INIT_POST_GENESIS_FLAG}

//
// Scoring methods to be applied
//
//dev_method_flag =
${METPLUS_DEV_METHOD_FLAG}

// ops_method_flag =
${METPLUS_OPS_METHOD_FLAG}

////////////////////////////////////////////////////////////////////////////////
//
// Output options
// May be specified separately in each filter array entry.
//
////////////////////////////////////////////////////////////////////////////////

//
// Confidence interval alpha value
//
// ci_alpha =
${METPLUS_CI_ALPHA}

//
// Statistical output types
//
// output_flag =
${METPLUS_OUTPUT_FLAG_DICT}

//
// NetCDF genesis pair counts
//
// nc_pairs_flag =
${METPLUS_NC_PAIRS_FLAG_DICT}

//
// Specify which track points should be counted by thresholding the track point
// valid time minus genesis time difference.
//
// valid_minus_genesis_diff_thresh =
${METPLUS_VALID_MINUS_GENESIS_DIFF_THRESH}

//
// Count unique BEST track genesis event locations (TRUE) versus counting the
// location for all pairs (FALSE).
//
// best_unique_flag =
${METPLUS_BEST_UNIQUE_FLAG}

////////////////////////////////////////////////////////////////////////////////
//
// Global settings
// May only be specified once.
//
////////////////////////////////////////////////////////////////////////////////

//
// Specify the NetCDF output of the gen_dland tool containing a gridded
// representation of the minimum distance to land.
//
// dland_file =
${METPLUS_DLAND_FILE}

//
// Specify the NetCDF file containing a gridded representation of the
// global basins.
//
// basin_file =
${METPLUS_BASIN_FILE}

//
// NetCDF genesis pairs grid
//
// nc_pairs_grid =
${METPLUS_NC_PAIRS_GRID}

//
// Indicate a version number for the contents of this configuration file.
// The value should generally not be modified.
//
//version = "V10.0.0";

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_INIT_FREQ}

METplus Config(s)

MET Config File

TC_GEN_INIT_FREQ

init_freq

${METPLUS_VALID_FREQ}

METplus Config(s)

MET Config File

TC_GEN_VALID_FREQ

valid_freq

${METPLUS_FCST_HR_WINDOW_DICT}

METplus Config(s)

MET Config File

TC_GEN_FCST_HR_WINDOW_BEGIN

fcst_hr_window.beg

TC_GEN_FCST_HR_WINDOW_END

fcst_hr_window.end

${METPLUS_MIN_DURATION}

METplus Config(s)

MET Config File

TC_GEN_MIN_DURATION

min_duration

${METPLUS_FCST_GENESIS_DICT}

METplus Config(s)

MET Config File

TC_GEN_FCST_GENESIS_VMAX_THRESH

fcst_genesis.vmax_thresh

TC_GEN_FCST_GENESIS_MSLP_THRESH

fcst_genesis.mslp_thresh

${METPLUS_BEST_GENESIS_DICT}

METplus Config(s)

MET Config File

TC_GEN_BEST_GENESIS_TECHNIQUE

best_genesis.technique

TC_GEN_BEST_GENESIS_CATEGORY

best_genesis.category

TC_GEN_BEST_GENESIS_VMAX_THRESH

best_genesis.vmax_thresh

TC_GEN_BEST_GENESIS_MSLP_THRESH

best_genesis.mslp_thresh

${METPLUS_OPER_TECHNIQUE}

METplus Config(s)

MET Config File

TC_GEN_OPER_TECHNIQUE

oper_technique

${METPLUS_FILTER}

METplus Config(s)

MET Config File

TC_GEN_FILTER_<n>

filter

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC -or- TC_GEN_DESC

desc

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_STORM_ID}

METplus Config(s)

MET Config File

TC_GEN_STORM_ID

storm_id

${METPLUS_STORM_NAME}

METplus Config(s)

MET Config File

TC_GEN_STORM_NAME

storm_name

${METPLUS_INIT_BEG}

METplus Config(s)

MET Config File

TC_GEN_INIT_BEG

init_beg

${METPLUS_INIT_END}

METplus Config(s)

MET Config File

TC_GEN_INIT_END

init_end

${METPLUS_INIT_INC}

METplus Config(s)

MET Config File

TC_GEN_INIT_INC

init_inc

${METPLUS_INIT_EXC}

METplus Config(s)

MET Config File

TC_GEN_INIT_EXC

init_exc

${METPLUS_VALID_BEG}

METplus Config(s)

MET Config File

TC_GEN_VALID_BEG

valid_beg

${METPLUS_VALID_END}

METplus Config(s)

MET Config File

TC_GEN_VALID_END

valid_end

${METPLUS_INIT_HOUR}

METplus Config(s)

MET Config File

TC_GEN_INIT_HOUR

init_hour

${METPLUS_LEAD}

METplus Config(s)

MET Config File

LEAD_SEQ

lead

${METPLUS_VX_MASK}

METplus Config(s)

MET Config File

TC_GEN_VX_MASK

vx_mask

${METPLUS_BASIN_MASK}

METplus Config(s)

MET Config File

TC_GEN_BASIN_MASK

basin_mask

${METPLUS_DLAND_THRESH}

METplus Config(s)

MET Config File

TC_GEN_DLAND_THRESH

dland_thresh

${METPLUS_DEV_HIT_WINDOW_DICT}

METplus Config(s)

MET Config File

TC_GEN_DEV_HIT_WINDOW_BEGIN

dev_hit_window.beg

TC_GEN_DEV_HIT_WINDOW_END

dev_hit_window.end

${METPLUS_GENESIS_MATCH_RADIUS}

METplus Config(s)

MET Config File

TC_GEN_GENESIS_MATCH_RADIUS

genesis_match_radius

${METPLUS_GENESIS_MATCH_POINT_TO_TRACK}

METplus Config(s)

MET Config File

TC_GEN_GENESIS_MATCH_POINT_TO_TRACK

genesis_match_point_to_track

${METPLUS_GENESIS_MATCH_WINDOW_DICT}

METplus Config(s)

MET Config File

TC_GEN_GENESIS_MATCH_WINDOW_BEG

genesis_match_window.beg

TC_GEN_GENESIS_MATCH_WINDOW_END

genesis_match_window.end

${METPLUS_DEV_HIT_RADIUS}

METplus Config(s)

MET Config File

TC_GEN_DEV_HIT_RADIUS

dev_hit_radius

${METPLUS_OPS_HIT_WINDOW_DICT}

METplus Config(s)

MET Config File

TC_GEN_OPS_HIT_WINDOW_BEG

ops_hit_window.beg

TC_GEN_OPS_HIT_WINDOW_END

ops_hit_window.end

${METPLUS_DISCARD_INIT_POST_GENESIS_FLAG}

METplus Config(s)

MET Config File

TC_GEN_DISCARD_INIT_POST_GENESIS_FLAG

discard_init_post_genesis_flag

${METPLUS_DEV_METHOD_FLAG}

METplus Config(s)

MET Config File

TC_GEN_DEV_METHOD_FLAG

dev_method_flag

${METPLUS_OPS_METHOD_FLAG}

METplus Config(s)

MET Config File

TC_GEN_OPS_METHOD_FLAG

ops_method_flag

${METPLUS_CI_ALPHA}

METplus Config(s)

MET Config File

TC_GEN_CI_ALPHA

ci_alpha

${METPLUS_OUTPUT_FLAG_DICT}

METplus Config(s)

MET Config File

TC_GEN_OUTPUT_FLAG_FHO

output_flag.fho

TC_GEN_OUTPUT_FLAG_CTC

output_flag.ctc

TC_GEN_OUTPUT_FLAG_CTS

output_flag.cts

TC_GEN_OUTPUT_FLAG_GENMPR

output_flag.genmpr

${METPLUS_NC_PAIRS_FLAG_DICT}

METplus Config(s)

MET Config File

TC_GEN_NC_PAIRS_FLAG_LATLON

nc_pairs_flag.latlon

TC_GEN_NC_PAIRS_FLAG_FCST_GENESIS

nc_pairs_flag.fcst_genesis

TC_GEN_NC_PAIRS_FLAG_FCST_TRACKS

nc_pairs_flag.fcst_tracks

TC_GEN_NC_PAIRS_FLAG_FCST_FY_OY

nc_pairs_flag.fcst_fy_oy

TC_GEN_NC_PAIRS_FLAG_FCST_FY_ON

nc_pairs_flag.fcst_fy_on

TC_GEN_NC_PAIRS_FLAG_BEST_GENESIS

nc_pairs_flag.best_genesis

TC_GEN_NC_PAIRS_FLAG_BEST_TRACKS

nc_pairs_flag.best_tracks

TC_GEN_NC_PAIRS_FLAG_BEST_FY_OY

nc_pairs_flag.best_fy_oy

TC_GEN_NC_PAIRS_FLAG_BEST_FN_OY

nc_pairs_flag.best_fn_oy

${METPLUS_VALID_MINUS_GENESIS_DIFF_THRESH}

METplus Config(s)

MET Config File

TC_GEN_VALID_MINUS_GENESIS_DIFF_THRESH

valid_minus_genesis_diff_thresh

${METPLUS_BEST_UNIQUE_FLAG}

METplus Config(s)

MET Config File

TC_GEN_BEST_UNIQUE_FLAG

best_unique_flag

${METPLUS_DLAND_FILE}

METplus Config(s)

MET Config File

TC_GEN_DLAND_FILE

dland_file

${METPLUS_BASIN_FILE}

METplus Config(s)

MET Config File

TC_GEN_BASIN_FILE

basin_file

${METPLUS_NC_PAIRS_GRID}

METplus Config(s)

MET Config File

TC_GEN_NC_PAIRS_GRID

nc_pairs_grid

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

TC_GEN_MET_CONFIG_OVERRIDES

n/a

4.26. TCMPRPlotter

4.26.1. Description

The TCMPRPlotter wrapper is a Python script that wraps the R script plot_tcmpr.R. This script is useful for plotting the calculated statistics for the output from the MET-TC tools. This script, and other R scripts are included in the MET installation. Please refer to the MET User’s Guide for usage information.

4.26.2. METplus Configuration

The following are TCMPR flags, if set to ‘no’, then don’t set flag, if set to ‘yes’, then set the flag

4.27. TCPairs

4.27.1. Description

The TCPairs wrapper encapsulates the behavior of the MET tc_pairs tool. The wrapper accepts Adeck and Bdeck (Best track) cyclone track data in extra tropical cyclone format (such as the data used by sample data provided in the METplus tutorial), or ATCF formatted track data. If data is in an extra tropical cyclone (non-ATCF) format, the data is reformatted into an ATCF format that is recognized by MET.

4.27.2. METplus Configuration

4.27.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/TCPairsConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// Default TCPairs configuration file
//
////////////////////////////////////////////////////////////////////////////////

//
// ATCF file format reference:
//   http://www.nrlmry.navy.mil/atcf_web/docs/database/new/abrdeck.html
//

//
// Models
//
${METPLUS_MODEL}

//
// Description
//
${METPLUS_DESC}

//
// Storm identifiers
//
${METPLUS_STORM_ID}

//
// Basins
//
${METPLUS_BASIN}

//
// Cyclone numbers
//
${METPLUS_CYCLONE}

//
// Storm names
//
${METPLUS_STORM_NAME}

//
// Model initialization time windows to include or exclude
//
${METPLUS_INIT_BEG}
${METPLUS_INIT_END}
${METPLUS_INIT_INCLUDE}
${METPLUS_INIT_EXCLUDE}

//
// Valid model time window
//
${METPLUS_VALID_BEG}
${METPLUS_VALID_END}

//
// Model initialization hours
//
init_hour = [];

//
// Required lead time in hours
//
lead_req = [];

//
// lat/lon polylines defining masking regions
//
init_mask  = "";
valid_mask = "";

//
// Specify if the code should check for duplicate ATCF lines
//
check_dup = FALSE;

//
// Specify special processing to be performed for interpolated models.
// Set to NONE, FILL, or REPLACE.
//
interp12 = REPLACE;

//
// Specify how consensus forecasts should be defined
//
consensus = [];

//
// Forecast lag times
//
lag_time = [];

//
// CLIPER/SHIFOR baseline forecasts to be derived from the BEST
// and operational (CARQ) tracks.
//
best_technique = [ "BEST" ];
best_baseline  = [];
oper_technique = [ "CARQ" ];
oper_baseline  = [];

//
// Specify the datasets to be searched for analysis tracks (NONE, ADECK, BDECK,
// or BOTH).
//
anly_track = BDECK;

//
// Specify if only those track points common to both the ADECK and BDECK
// tracks be written out.
//
match_points = TRUE;

//
// Specify the NetCDF output of the gen_dland tool containing a gridded
// representation of the minimum distance to land.
//
${METPLUS_DLAND_FILE}

//
// Specify watch/warning information:
//   - Input watch/warning filename
//   - Watch/warning time offset in seconds
//
watch_warn = {
   file_name   = "MET_BASE/tc_data/wwpts_us.txt";
   time_offset = -14400;
}

//
// Indicate a version number for the contents of this configuration file.
// The value should generally not be modified.
//
//version = "V9.0";

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_DESC}

METplus Config(s)

MET Config File

DESC -or- TC_PAIRS_DESC

desc

${METPLUS_STORM_ID}

METplus Config(s)

MET Config File

TC_PAIRS_STORM_ID

storm_id

${METPLUS_BASIN}

METplus Config(s)

MET Config File

TC_PAIRS_BASIN

basin

${METPLUS_CYCLONE}

METplus Config(s)

MET Config File

TC_PAIRS_CYCLONE

cyclone

${METPLUS_STORM_NAME}

METplus Config(s)

MET Config File

TC_PAIRS_STORM_NAME

storm_name

${METPLUS_INIT_BEG}

METplus Config(s)

MET Config File

TC_PAIRS_INIT_BEG

init_beg

${METPLUS_INIT_END}

METplus Config(s)

MET Config File

TC_PAIRS_INIT_END

init_end

${METPLUS_INIT_INCLUDE}

METplus Config(s)

MET Config File

TC_PAIRS_INIT_INCLUDE

init_inc

${METPLUS_INIT_EXCLUDE}

METplus Config(s)

MET Config File

TC_PAIRS_INIT_EXCLUDE

init_exc

${METPLUS_VALID_BEG}

METplus Config(s)

MET Config File

TC_PAIRS_VALID_BEG

valid_beg

${METPLUS_VALID_END}

METplus Config(s)

MET Config File

TC_PAIRS_VALID_END

valid_end

${METPLUS_DLAND_FILE}

METplus Config(s)

MET Config File

TC_PAIRS_DLAND_FILE

dland_file

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

TC_PAIRS_MET_CONFIG_OVERRIDES

n/a

4.28. TCRMW

4.28.1. Description

Used to configure the MET tool TC-RMW.

4.28.2. METplus Configuration

4.28.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/TCRMWConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

////////////////////////////////////////////////////////////////////////////////
//
// TC-RMW configuration file.
//
// For additional information, see the MET_BASE/config/README_TC file.
//
////////////////////////////////////////////////////////////////////////////////

// The following environment variables set the text if the corresponding
// variables at defined in the METplus config. If not, they are set to
// and empty string, which will cause MET to use the value defined in the
// default configuration file.

${METPLUS_MODEL}

${METPLUS_STORM_ID}
${METPLUS_BASIN}
${METPLUS_CYCLONE}
${METPLUS_INIT_INCLUDE}

${METPLUS_VALID_BEG}
${METPLUS_VALID_END}
${METPLUS_VALID_INCLUDE_LIST}
${METPLUS_VALID_EXCLUDE_LIST}

${METPLUS_VALID_HOUR_LIST}
${METPLUS_LEAD_LIST}

//
// May be set separately in each "field" entry
//
censor_thresh = [];
censor_val    = [];

//
// Data fields
//
data = {
   ${METPLUS_DATA_FILE_TYPE}

   ${METPLUS_DATA_FIELD}
}

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

//
// Regridding options
//
${METPLUS_REGRID_DICT}

//
// Range-Azimuth grid parameters 
//
// The following environmnet variables set the text if the corresponding
// variables at defined in the METplus config. If not, they are set to
// and empty string, which will cause MET to use the value defined in the
// default configuration file.

${METPLUS_N_RANGE}
${METPLUS_N_AZIMUTH}
${METPLUS_MAX_RANGE_KM}
${METPLUS_DELTA_RANGE_KM}
${METPLUS_RMW_SCALE}

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

//version = "V10.0";

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

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_MODEL}

METplus Config(s)

MET Config File

MODEL

model

${METPLUS_STORM_ID}

METplus Config(s)

MET Config File

TC_RMW_STORM_ID

storm_id

${METPLUS_BASIN}

METplus Config(s)

MET Config File

TC_RMW_BASIN

basin

${METPLUS_CYCLONE}

METplus Config(s)

MET Config File

TC_RMW_CYCLONE

cyclone

${METPLUS_INIT_INCLUDE}

METplus Config(s)

MET Config File

TC_RMW_INIT_INCLUDE

init_inc

${METPLUS_VALID_BEG}

METplus Config(s)

MET Config File

TC_RMW_VALID_BEG

valid_beg

${METPLUS_VALID_END}

METplus Config(s)

MET Config File

TC_RMW_VALID_END

valid_end

${METPLUS_VALID_INCLUDE_LIST}

METplus Config(s)

MET Config File

TC_RMW_VALID_INCLUDE_LIST

valid_inc

${METPLUS_VALID_EXCLUDE_LIST}

METplus Config(s)

MET Config File

TC_RMW_VALID_EXCLUDE_LIST

valid_exc

${METPLUS_VALID_HOUR_LIST}

METplus Config(s)

MET Config File

TC_RMW_VALID_HOUR_LIST

valid_hour

${METPLUS_LEAD_LIST}

METplus Config(s)

MET Config File

LEAD_SEQ

lead

${METPLUS_DATA_FILE_TYPE}

METplus Config(s)

MET Config File

TC_RMW_INPUT_DATATYPE

data.file_type

${METPLUS_DATA_FIELD}

METplus Config(s)

MET Config File

BOTH_VAR<n>_NAME

data.field.name

BOTH_VAR<n>_LEVELS

data.field.level

BOTH_VAR<n>_OPTIONS

n/a

Note

For more information on controlling the field attributes in METplus, please see the Field Info section of the User’s Guide.

${METPLUS_REGRID_DICT}

METplus Config(s)

MET Config File

TC_RMW_REGRID_SHAPE

regrid.shape

TC_RMW_REGRID_METHOD

regrid.method

TC_RMW_REGRID_WIDTH

regrid.width

TC_RMW_REGRID_VLD_THRESH

regrid.vld_thresh

${METPLUS_N_RANGE}

METplus Config(s)

MET Config File

TC_RMW_N_RANGE

n_range

${METPLUS_N_AZIMUTH}

METplus Config(s)

MET Config File

TC_RMW_N_AZIMUTH

n_azimuth

${METPLUS_MAX_RANGE_KM}

METplus Config(s)

MET Config File

TC_RMW_MAX_RANGE_KM

max_range_km

${METPLUS_DELTA_RANGE_KM}

METplus Config(s)

MET Config File

TC_RMW_DELTA_RANGE_KM

delta_range_km

${METPLUS_RMW_SCALE}

METplus Config(s)

MET Config File

TC_RMW_SCALE

rmw_scale

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

TC_RMW_MET_CONFIG_OVERRIDES

n/a

4.29. TCStat

4.29.1. Description

Used to configure the MET tool tc_stat.

4.29.2. METplus Configuration

4.29.3. MET Configuration

Below is the wrapped MET configuration file used for this wrapper. Environment variables are used to control entries in this configuration file. The default value for each environment variable is obtained from (except where noted below):

MET_INSTALL_DIR/share/met/config/TCStatConfig_default

Below the file contents are descriptions of each environment variable referenced in this file and the corresponding METplus configuration item used to set the value of the environment variable. For detailed examples showing how METplus sets the values of these environment variables, see How METplus controls MET config file settings.

///////////////////////////////////////////////////////////////////////////////
//
// Default TCStat configuration file
//
////////////////////////////////////////////////////////////////////////////////

//
// The parameters listed below are used to filter the TC-STAT data down to the
// desired subset of lines over which statistics are to be computed.  Only
// those lines which meet ALL of the criteria specified will be retained.
//
// The settings that are common to all jobs may be specified once at the top
// level.  If no selection is listed for a parameter, that parameter will not
// be used for filtering.  If multiple selections are listed for a parameter,
// the analyses will be performed on their union.
//

//
// Stratify by the AMODEL or BMODEL columns.
//
${METPLUS_AMODEL}
${METPLUS_BMODEL}

//
// Stratify by the DESC column.
//
${METPLUS_DESC}

//
// Stratify by the STORM_ID column.
//
${METPLUS_STORM_ID}

//
// Stratify by the BASIN column.
// May add using the "-basin" job command option.
//
${METPLUS_BASIN}

//
// Stratify by the CYCLONE column.
// May add using the "-cyclone" job command option.
//
${METPLUS_CYCLONE}

//
// Stratify by the STORM_NAME column.
// May add using the "-storm_name" job command option.
//
${METPLUS_STORM_NAME}

//
// Stratify by the INIT times.
// Model initialization time windows to include or exclude
// May modify using the "-init_beg", "-init_end", "-init_inc",
// and "-init_exc" job command options.
//
${METPLUS_INIT_BEG}
${METPLUS_INIT_END}
${METPLUS_INIT_INCLUDE}
${METPLUS_INIT_EXCLUDE}

//
// Stratify by the VALID times.
//
${METPLUS_VALID_BEG}
${METPLUS_VALID_END}
${METPLUS_VALID_INCLUDE}
${METPLUS_VALID_EXCLUDE}

//
// Stratify by the initialization and valid hours and lead time.
//
${METPLUS_INIT_HOUR}
${METPLUS_VALID_HOUR}
${METPLUS_LEAD}

//
// Select tracks which contain all required lead times.
//
${METPLUS_LEAD_REQ}

//
// Stratify by the INIT_MASK and VALID_MASK columns.
//
${METPLUS_INIT_MASK}
${METPLUS_VALID_MASK}

//
// Stratify by checking the watch/warning status for each track point
// common to both the ADECK and BDECK tracks.  If the watch/warning status
// of any of the track points appears in the list, retain the entire track.
//
${METPLUS_TRACK_WATCH_WARN}

//
// Stratify by applying thresholds to numeric data columns.
//
${METPLUS_COLUMN_THRESH_NAME}
${METPLUS_COLUMN_THRESH_VAL}

//
// Stratify by performing string matching on non-numeric data columns.
//
${METPLUS_COLUMN_STR_NAME}
${METPLUS_COLUMN_STR_VAL}

//
// Stratify by excluding strings in non-numeric data columns.
//
//column_str_exc_name =
${METPLUS_COLUMN_STR_EXC_NAME}

//column_str_exc_val =
${METPLUS_COLUMN_STR_EXC_VAL}

//
// Similar to the column_thresh options above
//
${METPLUS_INIT_THRESH_NAME}
${METPLUS_INIT_THRESH_VAL}

//
// Similar to the column_str options above
//
${METPLUS_INIT_STR_NAME}
${METPLUS_INIT_STR_VAL}

//
// Similar to the column_str_exc options above
//
//init_str_exc_name =
${METPLUS_INIT_STR_EXC_NAME}

//init_str_exc_val =
${METPLUS_INIT_STR_EXC_VAL}

//
// Stratify by the ADECK and BDECK distances to land.
//
${METPLUS_WATER_ONLY}

//
// Specify whether only those track points occurring near landfall should be
// retained, and define the landfall retention window in HH[MMSS] format
// around the landfall time.
//
${METPLUS_LANDFALL}
${METPLUS_LANDFALL_BEG}
${METPLUS_LANDFALL_END}

//
// Specify whether only those track points common to both the ADECK and BDECK
// tracks should be retained.  May modify using the "-match_points" job command
// option.
//
${METPLUS_MATCH_POINTS}

//
// Array of TCStat analysis jobs to be performed on the filtered data
//
${METPLUS_JOBS}

${METPLUS_MET_CONFIG_OVERRIDES}

${METPLUS_AMODEL}

METplus Config(s)

MET Config File

TC_STAT_AMODEL

amodel

${METPLUS_BMODEL}

METplus Config(s)

MET Config File

TC_STAT_BMODEL

bmodel

${METPLUS_DESC}

METplus Config(s)

MET Config File

TC_STAT_DESC

desc

${METPLUS_STORM_ID}

METplus Config(s)

MET Config File

TC_STAT_STORM_ID

storm_id

${METPLUS_BASIN}

METplus Config(s)

MET Config File

TC_STAT_BASIN

basin

${METPLUS_CYCLONE}

METplus Config(s)

MET Config File

TC_STAT_CYCLONE

cyclone

${METPLUS_STORM_NAME}

METplus Config(s)

MET Config File

TC_STAT_STORM_NAME

storm_name

${METPLUS_INIT_BEG}

METplus Config(s)

MET Config File

TC_STAT_INIT_BEG

init_beg

${METPLUS_INIT_END}

METplus Config(s)

MET Config File

TC_STAT_INIT_END

init_end

${METPLUS_INIT_INCLUDE}

METplus Config(s)

MET Config File

TC_STAT_INIT_INCLUDE

init_inc

${METPLUS_INIT_EXCLUDE}

METplus Config(s)

MET Config File

TC_STAT_INIT_EXCLUDE

init_exc

${METPLUS_VALID_BEG}

METplus Config(s)

MET Config File

TC_STAT_VALID_BEG

valid_beg

${METPLUS_VALID_END}

METplus Config(s)

MET Config File

TC_STAT_VALID_END

valid_end

${METPLUS_VALID_INCLUDE}

METplus Config(s)

MET Config File

TC_STAT_VALID_INCLUDE

valid_inc

${METPLUS_VALID_EXCLUDE}

METplus Config(s)

MET Config File

TC_STAT_VALID_EXCLUDE

valid_exc

${METPLUS_INIT_HOUR}

METplus Config(s)

MET Config File

TC_STAT_INIT_HOUR

init_hour

${METPLUS_VALID_HOUR}

METplus Config(s)

MET Config File

TC_STAT_VALID_HOUR

valid_hour

${METPLUS_LEAD}

METplus Config(s)

MET Config File

TC_STAT_LEAD

lead

${METPLUS_LEAD_REQ}

METplus Config(s)

MET Config File

TC_STAT_LEAD_REQ

lead_req

${METPLUS_INIT_MASK}

METplus Config(s)

MET Config File

TC_STAT_INIT_MASK

init_mask

${METPLUS_VALID_MASK}

METplus Config(s)

MET Config File

TC_STAT_VALID_MASK

valid_mask

${METPLUS_TRACK_WATCH_WARN}

METplus Config(s)

MET Config File

TC_STAT_TRACK_WATCH_WARN

track_watch_warn

${METPLUS_COLUMN_THRESH_NAME}

METplus Config(s)

MET Config File

TC_STAT_COLUMN_THRESH_NAME

column_thresh_name

${METPLUS_COLUMN_THRESH_VAL}

METplus Config(s)

MET Config File

TC_STAT_COLUMN_THRESH_VAL

column_thresh_val

${METPLUS_COLUMN_STR_NAME}

METplus Config(s)

MET Config File

TC_STAT_COLUMN_STR_NAME

column_str_name

${METPLUS_COLUMN_STR_VAL}

METplus Config(s)

MET Config File

TC_STAT_COLUMN_STR_VAL

column_str_val

${METPLUS_COLUMN_STR_EXC_NAME}

METplus Config(s)

MET Config File

TC_STAT_COLUMN_STR_EXC_NAME

column_str_exc_name

${METPLUS_COLUMN_STR_EXC_VAL}

METplus Config(s)

MET Config File

TC_STAT_COLUMN_STR_EXC_VAL

column_str_exc_val

${METPLUS_INIT_THRESH_NAME}

METplus Config(s)

MET Config File

TC_STAT_INIT_THRESH_NAME

init_thresh_name

${METPLUS_INIT_THRESH_VAL}

METplus Config(s)

MET Config File

TC_STAT_INIT_THRESH_VAL

init_thresh_val

${METPLUS_INIT_STR_NAME}

METplus Config(s)

MET Config File

TC_STAT_INIT_STR_NAME

init_str_name

${METPLUS_INIT_STR_VAL}

METplus Config(s)

MET Config File

TC_STAT_INIT_STR_VAL

init_str_val

${METPLUS_INIT_STR_EXC_NAME}

METplus Config(s)

MET Config File

TC_STAT_INIT_STR_EXC_NAME

init_str_exc_name

${METPLUS_INIT_STR_EXC_VAL}

METplus Config(s)

MET Config File

TC_STAT_INIT_STR_EXC_VAL

init_str_exc_val

${METPLUS_WATER_ONLY}

METplus Config(s)

MET Config File

TC_STAT_WATER_ONLY

water_only

${METPLUS_LANDFALL}

METplus Config(s)

MET Config File

TC_STAT_LANDFALL

landfall

${METPLUS_LANDFALL_BEG}

METplus Config(s)

MET Config File

TC_STAT_LANDFALL_BEG

landfall_beg

${METPLUS_LANDFALL_END}

METplus Config(s)

MET Config File

TC_STAT_LANDFALL_END

landfall_end

${METPLUS_MATCH_POINTS}

METplus Config(s)

MET Config File

TC_STAT_MATCH_POINTS

match_points

${METPLUS_JOBS}

METplus Config(s)

MET Config File

TC_STAT_JOBS_LIST

jobs

${METPLUS_MET_CONFIG_OVERRIDES}

METplus Config(s)

MET Config File

TC_STAT_MET_CONFIG_OVERRIDES

n/a

4.30. UserScript

4.30.1. Description

Used to generate user-defined commands to run in the process list. Commands can be run once, run once for each runtime (init/valid/lead combination) or once for init, valid, or lead only. The command to run is specified with the USER_SCRIPT_COMMAND variable. The command should include a script or executable and any desired arguments. The variable support filename template substitution to send information like the current initialization or forecast lead time. See Runtime Frequency for more information on how the value of USER_SCRIPT_RUNTIME_FREQ can control how the commands are called.

4.30.2. METplus Configuration