Feature 1943 gridstat seeps

data/config/GridStatConfig_default

@@ -234,6 +234,7 @@ output_flag = {
    nbrcnt = NONE;
    grad   = NONE;
    dmap   = NONE;
+   seeps  = NONE;
 }
 
 //
@@ -246,6 +247,7 @@ nc_pairs_flag = {
    diff         = TRUE;
    climo        = TRUE;
    climo_cdp    = FALSE;
+   seeps        = FALSE;
    weight       = FALSE;
    nbrhd        = FALSE;
    fourier      = FALSE;
@@ -254,6 +256,11 @@ nc_pairs_flag = {
    apply_mask   = TRUE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
+
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;

data/config/PointStatConfig_default

@@ -290,6 +290,10 @@ output_flag = {
    seeps_mpr = NONE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
 ////////////////////////////////////////////////////////////////////////////////
 
 tmp_dir        = "/tmp";

docs/Users_Guide/config_options.rst

@@ -1456,6 +1456,14 @@ In this way, the number of bins impacts the resolution of the climatological
 probabilities. These derived probability values are used to compute the
 climatological Brier Score and Brier Skill Score.
 
+
+The "seeps_p1_thresh" option controls the threshold of p1 (probability of being dry) values.
+
+.. code-block:: none
+
+  seeps_p1_thresh = >=0.1&&<=0.85;
+
+
 mask_missing_flag
 ^^^^^^^^^^^^^^^^^
 

docs/Users_Guide/grid-stat.rst

@@ -362,6 +362,7 @@ _____________________
      nbrcnt = BOTH;
      grad   = BOTH;
      dmap   = BOTH;
+     seeps  = NONE;
   }
 
 
@@ -410,9 +411,14 @@ The **output_flag** array controls the type of output that the Grid-Stat tool ge
 
 21. **DMAP** for Distance Map Statistics
 
+22. **SEEPS** for SEEPS (Stable Equitable Error in Probability Space) score. It's described in :numref:`table_PS_format_info_SEEPS`. The SEEPS score of matched pair data is saved into the NetCDF.
+
 
 Note that the first two line types are easily derived from one another. The user is free to choose which measure is most desired. The output line types are described in more detail in :numref:`grid_stat-output`.
 
+The SEEPS climo file is not distributed with MET tools because of the file size. It should be configured by using the environment variable, MET_SEEPS_GRID_CLIMO_NAME.
+
+
 _____________________
 
 .. code-block:: none

docs/Users_Guide/point-stat.rst

@@ -487,6 +487,8 @@ Note that writing out matched pair data (MPR lines) for a large number of cases
 
 If all line types corresponding to a particular verification method are set to NONE, the computation of those statistics will be skipped in the code and thus make the Point-Stat tool run more efficiently. For example, if FHO, CTC, and CTS are all set to NONE, the Point-Stat tool will skip the categorical verification step.
 
+The default SEEPS climo file exists at MET_BASE/share/met/climo/seeps/PPT24_seepsweights.nc. It can be overridden by using the environment variable, MET_SEEPS_POINT_CLIMO_NAME.
+
 .. _point_stat-output:
 
 point_stat output

docs/Users_Guide/stat-analysis.rst

@@ -40,12 +40,12 @@ The **-derive** job command option can be used to perform the derivation of stat
 Aggregated values from multiple STAT lines
 ------------------------------------------
 
-The Stat-Analysis "aggregate" job aggregates values from multiple STAT lines of the same type. The user may specify the specific line type of interest and any other relevant search criteria. The Stat-Analysis tool then creates sums of each of the values in all lines matching the search criteria. The aggregated data are output as the same line type as the user specified. The STAT line types which may be aggregated in this way are the contingency table (FHO, CTC, PCT, MCTC, NBRCTC), partial sums (SL1L2, SAL1L2, VL1L2, and VAL1L2), and other (ISC, ECNT, RPS, RHIST, PHIST, RELP, NBRCNT, SSVAR, and GRAD) line types.
+The Stat-Analysis "aggregate" job aggregates values from multiple STAT lines of the same type. The user may specify the specific line type of interest and any other relevant search criteria. The Stat-Analysis tool then creates sums of each of the values in all lines matching the search criteria. The aggregated data are output as the same line type as the user specified. The STAT line types which may be aggregated in this way are the contingency table (FHO, CTC, PCT, MCTC, NBRCTC), partial sums (SL1L2, SAL1L2, VL1L2, and VAL1L2), and other (ISC, ECNT, RPS, RHIST, PHIST, RELP, NBRCNT, SSVAR, GRAD, and SEEPS) line types.
 
 Aggregate STAT lines and produce aggregated statistics
 ------------------------------------------------------
 
-The Stat-Analysis "aggregate-stat" job aggregates multiple STAT lines of the same type together and produces relevant statistics from the aggregated line. This may be done in the same manner listed above in :numref:`StA_Aggregated-values-from`. However, rather than writing out the aggregated STAT line itself, the relevant statistics generated from that aggregated line are provided in the output. Specifically, if a contingency table line type (FHO, CTC, PCT, MCTC, or NBRCTC) has been aggregated, contingency table statistics (CTS, ECLV, PSTD, MCTS, or NBRCTS) line types can be computed. If a partial sums line type (SL1L2 or SAL1L2) has been aggregated, the continuous statistics (CNT) line type can be computed. If a vector partial sums line type (VL1L2 or VAL1L2) has been aggregated, the vector continuous statistics (VCNT) line type can be computed. For ensembles, the ORANK line type can be accumulated into ECNT, RPS, RHIST, PHIST, RELP, or SSVAR output. If the matched pair line type (MPR) has been aggregated, may output line types (FHO, CTC, CTS, CNT, MCTC, MCTS, SL1L2, SAL1L2, VL1L2, VCNT, WDIR, PCT, PSTD, PJC, PRC, or ECLV) can be computed. Multiple output line types may be specified for each "aggregate-stat" job, as long as each output is derivable from the input.
+The Stat-Analysis "aggregate-stat" job aggregates multiple STAT lines of the same type together and produces relevant statistics from the aggregated line. This may be done in the same manner listed above in :numref:`StA_Aggregated-values-from`. However, rather than writing out the aggregated STAT line itself, the relevant statistics generated from that aggregated line are provided in the output. Specifically, if a contingency table line type (FHO, CTC, PCT, MCTC, or NBRCTC) has been aggregated, contingency table statistics (CTS, ECLV, PSTD, MCTS, or NBRCTS) line types can be computed. If a partial sums line type (SL1L2 or SAL1L2) has been aggregated, the continuous statistics (CNT) line type can be computed. If a vector partial sums line type (VL1L2 or VAL1L2) has been aggregated, the vector continuous statistics (VCNT) line type can be computed. For ensembles, the ORANK line type can be accumulated into ECNT, RPS, RHIST, PHIST, RELP, or SSVAR output. If a SEEPS matched pair line type (SEEPS_MPR) has been aggregated, the aggregated SEEPS line type (SEEPS) can be computed. If the matched pair line type (MPR) has been aggregated, may output line types (FHO, CTC, CTS, CNT, MCTC, MCTS, SL1L2, SAL1L2, VL1L2, VCNT, WDIR, PCT, PSTD, PJC, PRC, or ECLV) can be computed. Multiple output line types may be specified for each "aggregate-stat" job, as long as each output is derivable from the input.
 
 When aggregating the matched pair line type (MPR), additional required job command options are determined by the requested output line type(s). For example, the "-out_thresh" (or "-out_fcst_thresh" and  "-out_obs_thresh" options) are required to compute contingnecy table counts (FHO, CTC) or statistics (CTS). Those same job command options can also specify filtering thresholds when computing continuous partial sums (SL1L2, SAL1L2) or statistics (CNT). Output is written for each threshold specified.
 

internal/test_unit/config/GridStatConfig_APCP_regrid

@@ -180,6 +180,7 @@ output_flag = {
    nbrcnt = NONE;
    grad   = NONE;
    dmap   = NONE;
+   seeps  = NONE;
 }
 
 //
@@ -199,6 +200,11 @@ nc_pairs_flag = {
    apply_mask   = TRUE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
+
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;

internal/test_unit/config/GridStatConfig_GRIB_lvl_typ_val

@@ -277,6 +277,7 @@ output_flag = {
    nbrcnt = NONE;
    grad   = NONE;
    dmap   = NONE;
+   seeps  = NONE;
 };
 
 //
@@ -296,6 +297,11 @@ nc_pairs_flag = {
    apply_mask   = FALSE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
+
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;

internal/test_unit/config/GridStatConfig_GRIB_set_attr

@@ -209,6 +209,7 @@ output_flag = {
    nbrcnt = NONE;
    grad   = NONE;
    dmap   = NONE;
+   seeps  = NONE;
 };
 
 //
@@ -228,6 +229,11 @@ nc_pairs_flag = {
    apply_mask   = FALSE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
+
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;

internal/test_unit/config/GridStatConfig_GTG_latlon

@@ -188,6 +188,7 @@ output_flag = {
    nbrcnt = NONE;
    grad   = NONE;
    dmap   = NONE;
+   seeps  = NONE;
 }
 
 //
@@ -207,6 +208,11 @@ nc_pairs_flag = {
    apply_mask   = TRUE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
+
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;

internal/test_unit/config/GridStatConfig_GTG_lc

@@ -188,6 +188,7 @@ output_flag = {
    nbrcnt = NONE;
    grad   = NONE;
    dmap   = NONE;
+   seeps  = NONE;
 }
 
 //
@@ -207,6 +208,11 @@ nc_pairs_flag = {
    apply_mask   = TRUE;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Threshold for SEEPS p1 (Probability of being dry)
+
+seeps_p1_thresh = NA;
+
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;