Per #1908, ci-run-unit more changes to Ensemble-Stat. Rename ensemble…

…_flag to nc_orank_flag and update its contents. Also make it configurable separetly for each vx task. Also update the User's Guide with this info.
dtcenter · Sep 19, 2022 · 7254cdc · 7254cdc
1 parent 660effe
commit 7254cdc
Show file tree

Hide file tree

Showing 17 changed files with 207 additions and 133 deletions.
diff --git a/data/config/EnsembleStatConfig_default b/data/config/EnsembleStatConfig_default
@@ -215,6 +215,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = NONE;
@@ -235,13 +236,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/docs/Users_Guide/ensemble-stat.rst b/docs/Users_Guide/ensemble-stat.rst
@@ -345,27 +345,33 @@ The **output_flag** array controls the type of output that is generated. Each fl
 _____________________
 
 .. code-block:: none
-		
-  ensemble_flag = {
+
+  nc_orank_flag = {
      latlon    = TRUE;
-     weight    = FALSE;
+     mean      = TRUE;
+     raw       = TRUE;
      rank      = TRUE;
+     pit       = TRUE;
      vld_count = TRUE;
-     mean      = TRUE;
+     weight    = FALSE;
   }
 
 
-The **ensemble_flag** specifies which gridded verification output types should be written to the Observation Rank (**_orank.nc**) NetCDF file. Setting the flag to TRUE produces output of the specified field, while FALSE produces no output for that field type. The flags correspond to the following output line types:
+The **nc_orank_flag** specifies which gridded verification output types should be written to the Observation Rank (**_orank.nc**) NetCDF file. This output file is only created when gridded observations have been provided with the -grid_obs command line option. Setting the flag to TRUE produces output of the specified field, while FALSE produces no output for that field type. The flags correspond to the following output line types:
 
 1. Grid Latitude and Longitude Fields
 
-2. The grid area weights.
+2. Ensemble mean field
+
+3. Raw observation values
+
+4. Observation ranks
 
-3. Observation values, ranks, and probability-integral transform values.
+5. Observation probability-integral transform values
 
-4. Ensemble Valid Data Count
+6. Ensemble valid data count
 
-5. Ensemble Mean Field
+7. Grid area weight values
 
 __________________
 
@@ -410,13 +416,13 @@ ensemble_stat_PREFIX_YYYYMMDD_HHMMSSV.stat where PREFIX indicates the user-defin
 The output ASCII files are named similarly:
 
 
-ensemble_stat_PREFIX_YYYYMMDD_HHMMSSV_TYPE.txt where TYPE is one of ecnt, rps, rhist, phist, relp, orank, and ssvar to indicate the line type it contains.
+ensemble_stat_PREFIX_YYYYMMDD_HHMMSSV_TYPE.txt where TYPE is one of elements of the **output_flag** configuration option to indicate the line type it contains.
 
 
 When verification against gridded analyses is performed, Ensemble-Stat can produce output NetCDF files using the following naming convention:
 
 
-ensemble_stat_PREFIX_YYYYMMDD_HHMMSSV_orank.nc contains gridded fields of observation ranks when the -grid_obs command line option is used. Its contents are specified by the **ensemble_flag** configuration option.
+ensemble_stat_PREFIX_YYYYMMDD_HHMMSSV_orank.nc contains gridded fields of observation ranks when the -grid_obs command line option is used. Its contents are specified by the **nc_orank_flag** configuration option.
 
 The Ensemble-Stat tool can compute the following statistics for the fields specified in the fcst and obs dictionaries of the configuration file:
 

diff --git a/internal/test_unit/config/EnsembleStatConfig b/internal/test_unit/config/EnsembleStatConfig
@@ -181,6 +181,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = BOTH;
@@ -201,13 +202,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_MASK_SID b/internal/test_unit/config/EnsembleStatConfig_MASK_SID
@@ -173,6 +173,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = STAT;
@@ -193,13 +194,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = FALSE;
    rank      = FALSE;
+   pit       = FALSE;
    vld_count = FALSE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_climo b/internal/test_unit/config/EnsembleStatConfig_climo
@@ -202,6 +202,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = BOTH;
@@ -222,13 +223,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = FALSE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = FALSE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_grid_weight b/internal/test_unit/config/EnsembleStatConfig_grid_weight
@@ -190,6 +190,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = STAT;
@@ -210,13 +211,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = TRUE;
+   mean      = TRUE;
+   raw       = FALSE;
    rank      = FALSE;
+   pit       = FALSE;
    vld_count = FALSE;
-   mean      = TRUE;
+   weight    = TRUE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_one_cdf_bin b/internal/test_unit/config/EnsembleStatConfig_one_cdf_bin
@@ -195,6 +195,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = BOTH;
@@ -214,9 +215,10 @@ output_flag = {
 ////////////////////////////////////////////////////////////////////////////////
 
 //
-// Ensemble product output types
+// Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = false;
+nc_orank_flag = false;
 
 ////////////////////////////////////////////////////////////////////////////////
 

diff --git a/internal/test_unit/config/EnsembleStatConfig_python b/internal/test_unit/config/EnsembleStatConfig_python
@@ -177,6 +177,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = STAT;
@@ -197,13 +198,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = FALSE;
    rank      = FALSE;
+   pit       = FALSE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_qty_inc_exc b/internal/test_unit/config/EnsembleStatConfig_qty_inc_exc
@@ -190,6 +190,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = BOTH;
@@ -210,13 +211,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_single_file_grib b/internal/test_unit/config/EnsembleStatConfig_single_file_grib
@@ -226,6 +226,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = STAT;
@@ -246,13 +247,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/config/EnsembleStatConfig_single_file_nc b/internal/test_unit/config/EnsembleStatConfig_single_file_nc
@@ -232,6 +232,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = STAT;
@@ -252,13 +253,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/scripts/config/EnsembleStatConfig b/scripts/config/EnsembleStatConfig
@@ -227,6 +227,7 @@ interp = {
 
 //
 // Statistical output types
+// May be set separately in each "obs.field" entry
 //
 output_flag = {
    ecnt  = BOTH;
@@ -247,13 +248,16 @@ output_flag = {
 
 //
 // Gridded verification output types
+// May be set separately in each "obs.field" entry
 //
-ensemble_flag = {
+nc_orank_flag = {
    latlon    = TRUE;
-   weight    = FALSE;
+   mean      = TRUE;
+   raw       = TRUE;
    rank      = TRUE;
+   pit       = TRUE;
    vld_count = TRUE;
-   mean      = TRUE;
+   weight    = FALSE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/src/basic/vx_config/config_constants.h b/src/basic/vx_config/config_constants.h
@@ -739,8 +739,9 @@ static const char conf_key_nmep_smooth[]      = "nmep_smooth";
 static const char conf_key_skip_const[]       = "skip_const";
 static const char conf_key_rng_type[]         = "rng.type";
 static const char conf_key_rng_seed[]         = "rng.seed";
-static const char conf_key_ensemble_flag[]    = "ensemble_flag";
+static const char conf_key_nc_orank_flag[]    = "nc_orank_flag";
 static const char conf_key_rank_flag[]        = "rank";
+static const char conf_key_pit_flag[]         = "pit";
 static const char conf_key_ssvar_bin[]        = "ens_ssvar_bin_size";
 static const char conf_key_phist_bin[]        = "ens_phist_bin_size";
 static const char conf_key_prob_cat_thresh[]  = "prob_cat_thresh";
@@ -760,6 +761,7 @@ static const char conf_key_ens_field[]      = "ens.field";
 static const char conf_key_ens_ens_thresh[] = "ens.ens_thresh";
 static const char conf_key_ens_vld_thresh[] = "ens.vld_thresh";
 static const char conf_key_normalize[]      = "normalize";
+static const char conf_key_ensemble_flag[]  = "ensemble_flag";
 static const char conf_key_mean_flag[]      = "mean";
 static const char conf_key_stdev_flag[]     = "stdev";
 static const char conf_key_minus_flag[]     = "minus";