From 3bca6399a3e45cd649c2f32b2134aaa02a09990f Mon Sep 17 00:00:00 2001
From: BenjaminBlake-NOAA <Benjamin.Blake@noaa.gov>
Date: Thu, 4 Jan 2024 20:31:06 +0000
Subject: [PATCH] Add RUN_TASK_RUN_PRDGEN flag to non-DA xml file, fix typo in
 RRFSFW config file for WCOSS2

---
 parm/FV3LAM_wflow_nonDA.xml                   |  8 +++++++
 ush/config_defaults.sh                        |  5 +++++
 ush/generate_FV3LAM_wflow.sh                  |  2 ++
 .../RRFSFW/config.rrfsfw.hera.sh              |  1 +
 .../RRFSFW/config.rrfsfw.wcoss2.sh            |  3 ++-
 .../non-DA_eng/config.nonDA.grib2.hera.sh     |  1 +
 .../non-DA_eng/config.nonDA.grib2.hercules.sh |  1 +
 .../non-DA_eng/config.nonDA.grib2.jet.sh      |  1 +
 .../non-DA_eng/config.nonDA.grib2.orion.sh    |  1 +
 .../non-DA_eng/config.nonDA.netcdf.hera.sh    |  1 +
 .../config.nonDA.netcdf.hercules.sh           |  1 +
 .../non-DA_eng/config.nonDA.netcdf.jet.sh     |  1 +
 .../non-DA_eng/config.nonDA.netcdf.orion.sh   |  1 +
 .../non-DA_eng/config.nonDA.netcdf.wcoss2.sh  |  1 +
 ush/setup.sh                                  | 21 +++++++++++++++++++
 ush/valid_param_vals.sh                       |  1 +
 16 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/parm/FV3LAM_wflow_nonDA.xml b/parm/FV3LAM_wflow_nonDA.xml
index 3f997a25c..4cc05d710 100644
--- a/parm/FV3LAM_wflow_nonDA.xml
+++ b/parm/FV3LAM_wflow_nonDA.xml
@@ -48,6 +48,11 @@ Flags that specify whether to run the preprocessing tasks.
 <!ENTITY RUN_TASK_MAKE_OROG      "{{ run_task_make_orog | upper }}">
 <!ENTITY RUN_TASK_MAKE_SFC_CLIMO "{{ run_task_make_sfc_climo | upper }}">
 
+<!--
+Flag that specifies whether to run the product generation task.
+-->
+<!ENTITY RUN_TASK_RUN_PRDGEN "{{ run_task_run_prdgen | upper }}">
+
 <!--
 Number of physical cores per node for the current machine.  This is used
 below in the <nodesize> tag, but that tag is not clearly documented.  This
@@ -486,6 +491,8 @@ MODULES_RUN_TASK_FP script.
 
       </task>
   </metatask>
+
+{%- if run_task_run_prdgen %}
 <!--
 ************************************************************************
 ************************************************************************
@@ -517,5 +524,6 @@ MODULES_RUN_TASK_FP script.
 
       </task>
   </metatask>
+{%- endif %}
 
 </workflow>
diff --git a/ush/config_defaults.sh b/ush/config_defaults.sh
index 67072206f..c92bdaa06 100644
--- a/ush/config_defaults.sh
+++ b/ush/config_defaults.sh
@@ -1507,6 +1507,9 @@ SAVE_CYCLE_LOG="TRUE"
 # SFC_CLIMO_DIR:
 # Same as GRID_DIR but for the surface climatology generation task.
 #
+# RUN_TASK_RUN_PRDGEN:
+# Same as RUN_TASK_MAKE_GRID but for the product generation task.
+#
 # IS_RTMA:
 # If true, some ICs,LBCs,GSI rocoto tasks will be turned off
 #
@@ -1535,6 +1538,8 @@ OROG_DIR=""
 RUN_TASK_MAKE_SFC_CLIMO="FALSE"
 SFC_CLIMO_DIR=""
 
+RUN_TASK_RUN_PRDGEN="TRUE"
+
 #
 NCORES_PER_NODE=24 #Jet default value
 IS_RTMA="FALSE"
diff --git a/ush/generate_FV3LAM_wflow.sh b/ush/generate_FV3LAM_wflow.sh
index 5e39f0f01..74f1b4366 100755
--- a/ush/generate_FV3LAM_wflow.sh
+++ b/ush/generate_FV3LAM_wflow.sh
@@ -400,6 +400,8 @@ settings="\
   'run_task_make_grid': ${RUN_TASK_MAKE_GRID}
   'run_task_make_orog': ${RUN_TASK_MAKE_OROG}
   'run_task_make_sfc_climo': ${RUN_TASK_MAKE_SFC_CLIMO}
+#
+  'run_task_run_prdgen': ${RUN_TASK_RUN_PRDGEN}
 #
   'is_rtma':  ${IS_RTMA}
   'fg_rootdir': ${FG_ROOTDIR}
diff --git a/ush/sample_configs/RRFSFW/config.rrfsfw.hera.sh b/ush/sample_configs/RRFSFW/config.rrfsfw.hera.sh
index fb3a9c86c..992ecf9a5 100644
--- a/ush/sample_configs/RRFSFW/config.rrfsfw.hera.sh
+++ b/ush/sample_configs/RRFSFW/config.rrfsfw.hera.sh
@@ -38,6 +38,7 @@ CYCL_HRS=( "18" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="TRUE"
 NNODES_MAKE_SFC_CLIMO="6"
 PPN_MAKE_SFC_CLIMO="12"
 
diff --git a/ush/sample_configs/RRFSFW/config.rrfsfw.wcoss2.sh b/ush/sample_configs/RRFSFW/config.rrfsfw.wcoss2.sh
index 2e8e73e87..8b1c19519 100644
--- a/ush/sample_configs/RRFSFW/config.rrfsfw.wcoss2.sh
+++ b/ush/sample_configs/RRFSFW/config.rrfsfw.wcoss2.sh
@@ -38,6 +38,7 @@ CYCL_HRS=( "18" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="TRUE"
 NNODES_MAKE_SFC_CLIMO="6"
 PPN_MAKE_SFC_CLIMO="12"
 
@@ -62,7 +63,7 @@ DO_NON_DA_RUN="TRUE"
 DO_RETRO="TRUE"
 DO_SMOKE_DUST="FALSE"
 VCOORD_FILE="global_hyblev_fcst_rrfsL65.txt"
-WFLOW_XML_TMPL_FN="FV3LAM_wflow_firewx.xml"
+WFLOW_XML_TMPL_FN="FV3LAM_wflow_nonDA.xml"
 FV3_NML_YAML_CONFIG_FN=""
 FV3_NML_BASE_SUITE_FN="input.nml.RRFSFW"
 
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hera.sh b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hera.sh
index 6047a5fb6..e7a6630a6 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hera.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hera.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "00" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hercules.sh b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hercules.sh
index 9257c206e..9df8620cd 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hercules.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.hercules.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "00" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.jet.sh b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.jet.sh
index 0288bef77..209f3b27a 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.jet.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.jet.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "00" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.orion.sh b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.orion.sh
index 071a23cb9..4af25585f 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.grib2.orion.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.grib2.orion.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "00" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hera.sh b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hera.sh
index 4130c9d62..791d7f7b5 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hera.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hera.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "06" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hercules.sh b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hercules.sh
index 6c90dbaa6..d44005acd 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hercules.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.hercules.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "06" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.jet.sh b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.jet.sh
index 5153828f0..6c0d68e6e 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.jet.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.jet.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "06" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.orion.sh b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.orion.sh
index 5a66202cf..933d43aec 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.orion.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.orion.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "06" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.wcoss2.sh b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.wcoss2.sh
index 54da79dbb..39b55be75 100644
--- a/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.wcoss2.sh
+++ b/ush/sample_configs/non-DA_eng/config.nonDA.netcdf.wcoss2.sh
@@ -34,6 +34,7 @@ CYCL_HRS=( "06" )
 RUN_TASK_MAKE_GRID="TRUE"
 RUN_TASK_MAKE_OROG="TRUE"
 RUN_TASK_MAKE_SFC_CLIMO="TRUE"
+RUN_TASK_RUN_PRDGEN="FALSE"
 
 EXTRN_MDL_NAME_ICS="FV3GFS"
 EXTRN_MDL_NAME_LBCS="FV3GFS"
diff --git a/ush/setup.sh b/ush/setup.sh
index 5a19b47d3..d2fde7642 100755
--- a/ush/setup.sh
+++ b/ush/setup.sh
@@ -225,6 +225,27 @@ fi
 #
 #-----------------------------------------------------------------------
 #
+# Make sure that RUN_TASK_RUN_PRDGEN is set to a valid value.
+#
+#-----------------------------------------------------------------------
+#
+check_var_valid_value \
+  "RUN_TASK_RUN_PRDGEN" "valid_vals_RUN_TASK_RUN_PRDGEN"
+#
+# Set RUN_TASK_RUN_PRDGEN to either "TRUE" or "FALSE" so we don't
+# have to consider other valid values later on.
+#
+RUN_TASK_RUN_PRDGEN=${RUN_TASK_RUN_PRDGEN^^}
+if [ "${RUN_TASK_RUN_PRDGEN}" = "TRUE" ] || \
+   [ "${RUN_TASK_RUN_PRDGEN}" = "YES" ]; then
+  RUN_TASK_RUN_PRDGEN="TRUE"
+elif [ "${RUN_TASK_RUN_PRDGEN}" = "FALSE" ] || \
+     [ "${RUN_TASK_RUN_PRDGEN}" = "NO" ]; then
+  RUN_TASK_RUN_PRDGEN="FALSE"
+fi
+#
+#-----------------------------------------------------------------------
+#
 # Make sure that DO_SHUM is set to a valid value.
 #
 #-----------------------------------------------------------------------
diff --git a/ush/valid_param_vals.sh b/ush/valid_param_vals.sh
index 28c1f4651..63780815f 100644
--- a/ush/valid_param_vals.sh
+++ b/ush/valid_param_vals.sh
@@ -47,6 +47,7 @@ valid_vals_WRTCMP_output_grid=("rotated_latlon" "lambert_conformal" "regional_la
 valid_vals_RUN_TASK_MAKE_GRID=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_RUN_TASK_MAKE_OROG=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_RUN_TASK_MAKE_SFC_CLIMO=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
+valid_vals_RUN_TASK_RUN_PRDGEN=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_QUILTING=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_PRINT_ESMF=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_USE_CRON_TO_RELAUNCH=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")