Note
Click here to download the full example code
5.2.10.2. Grid-Stat: Analysis validation
GridStat_fcstGloTEC _obsGloTEC_vx7.conf
Overview
This use case illustrates the use of grid_stat tool for the space weather domain. It compares Total Electron Content for a GloTEC model run initialized with COSMIC-1 radio occultation (RO) data to a GloTEC model run without such data.
In this use case, the forecast is considered to be the run without COSMIC-1 RO data. The observations are considered to be the run with COSMIC-1 RO data.
This use case runs grid_stat for the first two forecast times of a space weather event known as the St. Patrick’s Day Storm (Mar 17, 2015).
Novel aspects of this use case:
This is the first example use case to run grid_stat on a space weather model (GloTEC)
Example of how to run with NetCDF input data which do not strictly conform to the Climate Forecasts (CF) conventions
Example of using masks covering latitudinal bands of interest to the space weather community: equatorial region, mid-latitude region, and polar region
Example of masking using the values of a quality flag which vary at each time step and grid point
Scientific Objective
Compare gridded forecast data from a run of the GloTEC model that includes assimilation of COSMIC-1 radio occultation (RO) observations to gridded forecast data from a GloTEC model run that does not include COSMIC-1 RO data.
Datasets
METplus Use Case Contact
METplus Components
This use case utilizes the METplus GridStat wrapper to search for files that are valid at a given run time and generate a command to run the MET tool grid_stat if all required files are found.
METplus Workflow
GridStat is the only tool called in this example. It processes the following run times:
METplus Configuration
METplus first loads all of the configuration files found in parm/metplus_config, then it loads any configuration files passed to METplus via the command line with the -c option, i.e. -c parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf
# GridStat METplus Configuration for the glotec_vs_glotec space weather use case:
# GloTEC initialized with and without COSMIC-1 RO data (id: vx7)
#
# Author: Jonathan Vigh (NCAR/RAL/JNTP)
#
# Description: This use case illustrates the use of grid_stat tool for the space weather domain.
# It compares Total Electron Content for a GloTEC model run initialized with COSMIC-1
# radio occultation (RO) data to a GloTEC model run without such data.
#
# In this use case, the forecast is considered to be the run without COSMIC-1 RO data.
# The observations are considered to be the run with COSMIC-1 RO data.
#
# This use case runs grid_stat for all of the forecast times for one day for a
# space weather event known as the St. Patricks Day Storm (Mar 17, 2015).
#
# Novel aspects of this use case:
# - First example use case to run grid_stat on a space weather model (GloTEC)
# - Example of how to run with NetCDF input data which do not strictly conform to the
# Climate Forecasts (CF) conventions
# - Example of using masks covering latitudinal bands of interest to the space weather community:
# equatorial region, mid-latitude region, and polar region
# - Example of masking using the value of a quality flag at each time step and grid point
#
#
# section heading for [config] variables - all items below this line and
# before the next section heading correspond to the [config] section
[config]
# Masking poly for GridStat
MODEL_FILE={FCST_GRID_STAT_INPUT_DIR}/{FCST_GRID_STAT_INPUT_TEMPLATE}
MODEL_LEVEL=({valid?fmt=%Y%m%d_%H%M%S},*,*)
MASK_DIR={INPUT_BASE}/model_applications/space_weather/glotec_vs_glotec/masks
GRID_STAT_MASK_POLY = {MODEL_FILE} {name = "quality_flag"; level = "{MODEL_LEVEL}"; file_type=NETCDF_NCCF;} ==0, {MODEL_FILE} {name = "quality_flag"; level = "{MODEL_LEVEL}"; file_type=NETCDF_NCCF;} ==1, {MODEL_FILE} {name = "quality_flag"; level = "{MODEL_LEVEL}"; file_type=NETCDF_NCCF;} ==2, {MODEL_FILE} {name = "quality_flag"; level = "{MODEL_LEVEL}"; file_type=NETCDF_NCCF;} ==3, {MODEL_FILE} {name = "quality_flag"; level = "{MODEL_LEVEL}"; file_type=NETCDF_NCCF;} ==4, {MODEL_FILE} {name = "quality_flag"; level = "{MODEL_LEVEL}"; file_type=NETCDF_NCCF;} ==5, {MASK_DIR}/EQUATORIAL.nc, {MASK_DIR}/MIDLATITUDE.nc, {MASK_DIR}/POLAR.nc
# List of applications to run - only GridStat for this case
PROCESS_LIST = GridStat
# time looping - options are INIT, VALID, RETRO, and REALTIME
# If set to INIT or RETRO:
# INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
# If set to VALID or REALTIME:
# VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
LOOP_BY = VALID
# Format of VALID_BEG and VALID_END using % items
# %Y = 4 digit year, %m = 2 digit month, %d = 2 digit day, etc.
# see www.strftime.org for more information
# %Y%m%d%H expands to YYYYMMDDHH
VALID_TIME_FMT = %Y%m%d%H%M
# Start time for METplus run - must match VALID_TIME_FMT
VALID_BEG = 201503170005
# End time for METplus run - must match VALID_TIME_FMT
VALID_END = 201503170015
# Just run the first two time points for this use case example
# replace with 201503172355 process the entire day
# Increment between METplus runs (in seconds if no units are specified)
# Must be >= 60 seconds
VALID_INCREMENT = 600
# List of forecast leads to process for each run time (init or valid)
LEAD_SEQ = 0
# The above configuration will loop by valid time in increments of
# VALID_INCREMENT from VALID_BEG to VALID_END. Since LEAD_SEQ is set to 0,
# it will not loop over any forecast lead times.
# This will run:
# Valid: 2015-03-17_0005Z Forecast lead: 0
# to 2015-03-17_0055Z Forecast lead: 0
# Order of loops to process data - Options are times, processes
# Not relevant if only one item is in the PROCESS_LIST
# times = run all wrappers in the PROCESS_LIST for a single run time, then
# increment the run time and run all wrappers again until all times have
# been evaluated.
# processes = run the first wrapper in the PROCESS_LIST for all times
# specified, then repeat for the next item in the PROCESS_LIST until all
# wrappers have been run
LOOP_ORDER = times
# Verbosity of MET output - overrides LOG_VERBOSITY for GridStat only
#LOG_GRID_STAT_VERBOSITY = 2
# Location of MET config file to pass to the GridStat
GRID_STAT_CONFIG_FILE = {PARM_BASE}/met_config/GridStatConfig_wrapped
# Override MET config file settings for this use case
GRID_STAT_MET_CONFIG_OVERRIDES = file_type = NETCDF_NCCF;
GRID_STAT_OUTPUT_FLAG_CTC = STAT
GRID_STAT_OUTPUT_FLAG_CTS = STAT
GRID_STAT_OUTPUT_FLAG_MCTC = STAT
GRID_STAT_OUTPUT_FLAG_MCTS = STAT
GRID_STAT_OUTPUT_FLAG_CNT = STAT
GRID_STAT_OUTPUT_FLAG_SL1L2 = STAT
GRID_STAT_NC_PAIRS_FLAG_CLIMO = FALSE
GRID_STAT_NC_PAIRS_FLAG_APPLY_MASK = FALSE
# Name to identify model (forecast) data in output
MODEL = GloTEC_without_cosmic
# Name to identify observation data in output (used in output file path)
OBTYPE = GloTEC_with_cosmic
# List of variables to compare in GridStat - FCST_VAR1 variables correspond
# to OBS_VAR1 variables
# Name of forecast variable 1
BOTH_VAR1_NAME = TEC
# List of levels to evaluate for forecast variable 1
# NOTE: this uses the new capability in METplus v3.0 to specify levels with valid time
# Previously, a user would have had to provide a list, such as:
# FCST_VAR1_LEVELS = "(20150317_000500,*,*)", "(20150317_001500,*,*)", "( 20150317_002500,*,*)", "( 20150317_003500,*,*)", "( 20150317_004500,*,*)"
BOTH_VAR1_LEVELS = "({valid?fmt=%Y%m%d_%H%M%S},*,*)"
# NOTE that if the values do not match exactly, one can specify a time offset, as follows:
#FCST_VAR1_LEVELS = "({valid?fmt=%Y%m%d_%H%M%S?shift=5M},*,*)"
# List of thresholds to evaluate for each name/level combination for
# forecast variable 1
# Not used for this example
#FCST_VAR1_THRESH = gt10.0, gt20.0, gt30.0, gt40.0
# Name of observation variable 1 (this is specified in the GridStat.conf file)
# Not used for this example
#OBS_VAR1_NAME = APCP_03
# List of levels to evaluate for observation variable 1
# (*,*) is NetCDF notation - must include quotes around these values!
# must be the same lenght as FCST_VAR1_LEVELS
# Not used for this example
#OBS_VAR1_LEVELS = "(*,*)"
# List of thresholds to evaluate for each name/level combination for
# forecast variable 1 - must be the same length as FCST_VAR1_THRESH
# Not used for this example
#OBS_VAR1_THRESH = gt10.0, gt20.0, gt30.0, gt40.0
# Time relative to valid time (in seconds) to allow files to be considered
# valid. Set both BEGIN and END to 0 to require the exact time in the filename
# Not used in this example.
FCST_GRID_STAT_FILE_WINDOW_BEGIN = 0
FCST_GRID_STAT_FILE_WINDOW_END = 0
OBS_GRID_STAT_FILE_WINDOW_BEGIN = 0
OBS_GRID_STAT_FILE_WINDOW_END = 0
# MET GridStat neighborhood values
# See the MET User's Guide GridStat section for more information
# width value passed to nbrhd dictionary in the MET config file
GRID_STAT_NEIGHBORHOOD_WIDTH = 1
# shape value passed to nbrhd dictionary in the MET config file
GRID_STAT_NEIGHBORHOOD_SHAPE = SQUARE
# Set to true to run GridStat separately for each field specified
# Set to false to create one run of GridStat per run time that
# includes all fields specified.
# Not used for this example
GRID_STAT_ONCE_PER_FIELD = False
# Set to true if forecast data is probabilistic
FCST_IS_PROB = false
# Only used if FCST_IS_PROB is true - sets probabilistic threshold
# Not used for this example
FCST_GRID_STAT_PROB_THRESH = ==0.1
# Set to true if observation data is probabilistic
# Only used if configuring forecast data as the 'OBS' input
OBS_IS_PROB = false
# Only used if OBS_IS_PROB is true - sets probabilistic threshold
# Not used for this example
OBS_GRID_STAT_PROB_THRESH = ==0.1
# Output prefix set in grid_stat config file
GRID_STAT_OUTPUT_PREFIX={MODEL}-vx7_{CURRENT_OBS_NAME}_vs_{OBTYPE}
GRID_STAT_DESC = vx7
# End of [config] section and start of [dir] section
[dir]
# directory containing forecast input to GridStat
FCST_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/space_weather/glotec_vs_glotec/GLO_20190422_without_cosmic
# directory containing observation input to GridStat
OBS_GRID_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/space_weather/glotec_vs_glotec/GLO_20190422_with_cosmic
# directory containing climatology input to GridStat
# Not used in this example
GRID_STAT_CLIMO_MEAN_INPUT_DIR =
# directory to write output from GridStat
GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/space_weather/glotec_vs_glotec
# End of [dir] section and start of [filename_templates] section
[filename_templates]
# Template to look for forecast input to GridStat relative to FCST_GRID_STAT_INPUT_DIR
FCST_GRID_STAT_INPUT_TEMPLATE = GloTEC_TEC_{valid?fmt=%Y_%m_%d}.nc
# Template to look for observation input to GridStat relative to OBS_GRID_STAT_INPUT_DIR
OBS_GRID_STAT_INPUT_TEMPLATE = GloTEC_TEC_{valid?fmt=%Y_%m_%d}_cosmic.nc
# Optional subdirectories relative to GRID_STAT_OUTPUT_DIR to write output from GridStat
GRID_STAT_OUTPUT_TEMPLATE = {valid?fmt=%Y_%m_%d}
# Template to look for climatology input to GridStat relative to GRID_STAT_CLIMO_MEAN_INPUT_DIR
# Not used in this example
GRID_STAT_CLIMO_MEAN_INPUT_TEMPLATE =
# Used to specify one or more verification mask files for GridStat
# Not used for this example
GRID_STAT_VERIFICATION_MASK_TEMPLATE =
MET Configuration
METplus sets environment variables based on user settings in the METplus configuration file. See How METplus controls MET config file settings for more details.
YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!
If there is a setting in the MET configuration file that is currently not supported by METplus you’d like to control, please refer to: Overriding Unsupported MET config file settings
Note
See the GridStat MET Configuration section of the User’s Guide for more information on the environment variables used in the file below:
////////////////////////////////////////////////////////////////////////////////
//
// 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}
Running METplus
This use case can be run two ways:
Passing in GridStat_fcstGloTEC_obsGloTEC_vx7.conf then a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config, then passing in GridStat_fcstGloTEC_obsGloTEC_vx7.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/space_weather/GridStat_fcstGloTEC_obsGloTEC_vx7.conf
The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
INPUT_BASE - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases
OUTPUT_BASE - Path where METplus output will be written. This must be in a location where you have write permissions
MET_INSTALL_DIR - Path to location where MET is installed locally
Example User Configuration File:
[dir]
INPUT_BASE = /path/to/sample/input/data
OUTPUT_BASE = /path/to/output/dir
MET_INSTALL_DIR = /path/to/met-X.Y
NOTE: All of these items must be found under the [dir] section.
Expected Output
A successful run will output the following both to the screen and to the logfile:
INFO: METplus has successfully finished running.
Refer to the value set for OUTPUT_BASE to find where the output data was generated. Output for this use case will be found in space_weather/glotec_vs_glotec/output_data/2015_03_17 (relative to OUTPUT_BASE) and will contain the following files:
grid_stat_GloTEC_without_cosmic-vx7_TEC_vs_GloTEC_with_cosmic_000000L_20150317_000500V_pairs.nc
grid_stat_GloTEC_without_cosmic-vx7_TEC_vs_GloTEC_with_cosmic_000000L_20150317_001500V_pairs.nc
grid_stat_GloTEC_without_cosmic-vx7_TEC_vs_GloTEC_with_cosmic_000000L_20150317_000500V.stat
grid_stat_GloTEC_without_cosmic-vx7_TEC_vs_GloTEC_with_cosmic_000000L_20150317_001500V.stat
Keywords
Note
GridStatToolUseCase, SpaceWeatherAppUseCase, NOAASWPCOrgUseCase, CustomStringLoopingUseCase, MaskingFeatureUseCase, ValidationUseCase
Total running time of the script: ( 0 minutes 0.000 seconds)