Per #1788, add new unit tests to exercise recent ss_index changes and…

… update the Stat-Analysis documentation.
dtcenter · Aug 27, 2021 · 5110125 · 5110125
1 parent dc0fa3e
commit 5110125
Show file tree

Hide file tree

Showing 3 changed files with 146 additions and 3 deletions.
diff --git a/met/docs/Users_Guide/stat-analysis.rst b/met/docs/Users_Guide/stat-analysis.rst
@@ -512,10 +512,11 @@ ___________________
 
 .. code-block:: none
 
-  column = [];
-  weight = [];
+  column        = [];
+  weight        = [];
+  ss_index_name = "SS_INDEX";
 
-The column and weight fields are used to define a skill score index. The computation of a single value will be computed from each column and weight value specified. The GO Index is a specific example of a skill score index. 
+The column, weight, and ss_index_name entries are used to define a skill score index. The column and weight arrays can either be set to a constant value of length one or specify a separate value for each term of the index. The ss_index_name entry is a string which defines the output name for the current skill score index configuration.
 
 ___________________
 

diff --git a/test/config/STATAnalysisConfig_SFC_SS_Index b/test/config/STATAnalysisConfig_SFC_SS_Index
@@ -0,0 +1,105 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+// STAT-Analysis configuration file used to compute a Custom Skill Score Index.
+//
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Filtering input STAT lines by the contents of each column
+//
+model = [ "AFWAv3.4_Noahv3.3", "AFWAv3.4_Noahv2.7.1" ];
+
+fcst_lead = [ "12", "24", "36", "48",
+              "12", "24", "36", "48",
+              "12", "24", "36", "48",
+              "12", "24", "36", "48"
+            ];
+obs_lead  = [];
+
+fcst_valid_beg  = "";
+fcst_valid_end  = "";
+fcst_valid_inc  = [];
+fcst_valid_exc  = [];
+fcst_valid_hour = [];
+
+obs_valid_beg   = "";
+obs_valid_end   = "";
+obs_valid_inc   = [];
+obs_valid_exc   = [];
+obs_valid_hour  = [];
+
+fcst_init_beg   = "";
+fcst_init_end   = "";
+fcst_init_inc   = [];
+fcst_init_exc   = [];
+fcst_init_hour  = [];
+
+obs_init_beg    = "";
+obs_init_end    = "";
+obs_init_inc    = [];
+obs_init_exc    = [];
+obs_init_hour   = [];
+
+fcst_var = [ "WIND",  "WIND",  "WIND",  "WIND",
+             "DPT",   "DPT",   "DPT",   "DPT",
+             "TMP",   "TMP",   "TMP",   "TMP",
+             "PRMSL", "PRMSL", "PRMSL", "PRMSL"
+           ];
+obs_var  = [];
+
+fcst_lev = [ "Z10", "Z10", "Z10", "Z10",
+             "Z2",  "Z2",  "Z2",  "Z2",
+             "Z2",  "Z2",  "Z2",  "Z2",
+             "Z0",  "Z0",  "Z0",  "Z0"
+           ];
+obs_lev  = [];
+
+obtype = [];
+
+vx_mask = [];
+
+interp_mthd = [];
+
+interp_pnts = [];
+
+fcst_thresh = [];
+obs_thresh  = [];
+cov_thresh  = [];
+
+alpha = [];
+
+line_type = [ "SL1L2" ];
+
+column    = [ "RMSE" ];
+
+weight    = [ 4.0, 3.0, 2.0, 1.0,
+              4.0, 3.0, 2.0, 1.0,
+              4.0, 3.0, 2.0, 1.0,
+              4.0, 3.0, 2.0, 1.0
+            ];
+
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Confidence interval settings
+//
+out_alpha = 0.05;
+
+boot = {
+   interval = PCTILE;
+   rep_prop = 1.0;
+   n_rep    = 0;
+   rng      = "mt19937";
+   seed     = "";
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+ss_index_name  = "SFC_SS_INDEX";
+hss_ec_value   = NA;
+rank_corr_flag = FALSE;
+vif_flag       = FALSE;
+tmp_dir        = "/tmp";
+version        = "V10.1.0";
+
+////////////////////////////////////////////////////////////////////////////////
diff --git a/test/xml/unit_ref_config.xml b/test/xml/unit_ref_config.xml
@@ -953,4 +953,41 @@
     </output>
   </test>
 
+  <!--                                                                  -->
+  <!-- Run STAT-Analysis GO Index and write .stat output                -->
+  <!--                                                                  -->
+
+  <test name="stat_analysis_GO_Index_out_stat">
+    <exec>&MET_BIN;/stat_analysis</exec>
+    <param> \
+      -lookin &OUTPUT_DIR;/ref_config/point_stat/AFWAv3.4_Noahv3.3/ \
+      -lookin &OUTPUT_DIR;/ref_config/point_stat/AFWAv3.4_Noahv2.7.1/ \
+      -job go_index \
+      -by FCST_INIT_BEG,VX_MASK,OBTYPE -set_hdr DESC Noahv3.3_vs_v2.7.1 \
+      -model AFWAv3.4_Noahv3.3,AFWAv3.4_Noahv2.7.1 \
+      -out_stat &OUTPUT_DIR;/ref_config/stat_analysis/go_index_by_option.stat
+    </param>
+    <output>
+      <stat>&OUTPUT_DIR;/ref_config/stat_analysis/go_index_by_option.stat</stat>
+    </output>
+  </test>
+
+  <!--                                                                  -->
+  <!-- Run a custom STAT-Analysis SS Index job and write .stat output   -->
+  <!--                                                                  -->
+
+  <test name="stat_analysis_SFC_SS_Index_out">
+    <exec>&MET_BIN;/stat_analysis</exec>
+    <param> \
+      -lookin &OUTPUT_DIR;/ref_config/point_stat/AFWAv3.4_Noahv3.3/ \
+      -lookin &OUTPUT_DIR;/ref_config/point_stat/AFWAv3.4_Noahv2.7.1/ \
+      -job ss_index -config &CONFIG_DIR;/STATAnalysisConfig_SFC_SS_Index \
+      -by FCST_INIT_BEG,VX_MASK,OBTYPE \
+      -out_stat &OUTPUT_DIR;/ref_config/stat_analysis/sfc_ss_index_by_option.stat
+    </param>
+    <output>
+      <stat>&OUTPUT_DIR;/ref_config/stat_analysis/sfc_ss_index_by_option.stat</stat>
+    </output>
+  </test>
+
 </met_test>