From 3780e4dd6f2a1318d1859ee0c381aac70998325a Mon Sep 17 00:00:00 2001
From: Tracy <tracy.hertneky@noaa.gov>
Date: Wed, 23 Feb 2022 15:44:12 -0700
Subject: [PATCH] Enhancement for the ability to output satellite products from
 the UPP using the CRTM

---
 scripts/exregional_run_post.sh | 18 ++++++++++++++++++
 ush/config_defaults.sh         | 22 ++++++++++++++++++++++
 ush/setup.sh                   | 16 ++++++++++++++++
 ush/valid_param_vals.sh        |  1 +
 4 files changed, 57 insertions(+)

diff --git a/scripts/exregional_run_post.sh b/scripts/exregional_run_post.sh
index 631b50217..e45223ce9 100755
--- a/scripts/exregional_run_post.sh
+++ b/scripts/exregional_run_post.sh
@@ -171,6 +171,24 @@ temporary work directory (tmp_dir):
 fi
 cp_vrfy ${post_config_fp} ./postxconfig-NT.txt
 cp_vrfy ${UPP_DIR}/parm/params_grib2_tbl_new .
+if [ ${USE_CRTM} = "TRUE" ]; then
+  cp_vrfy ${CRTM_DIR}/fix/EmisCoeff/IR_Water/Big_Endian/Nalli.IRwater.EmisCoeff.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/EmisCoeff/MW_Water/Big_Endian/FAST*.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/EmisCoeff/IR_Land/SEcategory/Big_Endian/NPOESS.IRland.EmisCoeff.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/EmisCoeff/IR_Snow/SEcategory/Big_Endian/NPOESS.IRsnow.EmisCoeff.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/EmisCoeff/IR_Ice/SEcategory/Big_Endian/NPOESS.IRice.EmisCoeff.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/AerosolCoeff/Big_Endian/AerosolCoeff.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/CloudCoeff/Big_Endian/CloudCoeff.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/SpcCoeff/Big_Endian/*.bin ./
+  cp_vrfy ${CRTM_DIR}/fix/TauCoeff/ODPS/Big_Endian/*.bin ./
+  print_info_msg "
+====================================================================
+Copying the external CRTM fix files from CRTM_DIR to the temporary
+work directory (tmp_dir):
+  CRTM_DIR = \"${CRTM_DIR}\"
+  tmp_dir = \"${tmp_dir}\"
+===================================================================="
+fi
 #
 #-----------------------------------------------------------------------
 #
diff --git a/ush/config_defaults.sh b/ush/config_defaults.sh
index 6de917fa2..1e59038ee 100644
--- a/ush/config_defaults.sh
+++ b/ush/config_defaults.sh
@@ -1732,6 +1732,28 @@ CUSTOM_POST_CONFIG_FP=""
 #
 #-----------------------------------------------------------------------
 #
+# Set parameters associated with outputting satellite fields in the UPP
+# grib2 files using the Community Radiative Transfer Model (CRTM).
+#
+# USE_CRTM:
+# Flag that defines whether external CRTM coefficient files have been
+# staged by the user in order to output synthetic statellite products
+# available within the UPP. If this is set to "TRUE", then the workflow
+# will check for these files in the directory CRTM_DIR. Otherwise, it is
+# assumed that no satellite fields are being requested in the UPP
+# configuration.
+#
+# CRTM_DIR:
+# This is the path to the top CRTM fix file directory. This is only used
+# if USE_CRTM is set to "TRUE".
+#
+#-----------------------------------------------------------------------
+#
+USE_CRTM="FALSE"
+CRTM_DIR=""
+#
+#-----------------------------------------------------------------------
+#
 # Set parameters associated with running ensembles.  Definitions:
 #
 # DO_ENSEMBLE:
diff --git a/ush/setup.sh b/ush/setup.sh
index 2cbd0f6fc..407d20d5c 100755
--- a/ush/setup.sh
+++ b/ush/setup.sh
@@ -754,6 +754,22 @@ fi
 #
 #-----------------------------------------------------------------------
 #
+# If using external CRTM fix files to allow post-processing of synthetic
+# satellite products from the UPP, then make sure the fix file directory
+# exists.
+#
+#-----------------------------------------------------------------------
+#
+if [ ${USE_CRTM} = "TRUE" ]; then
+  if [ ! -d "${CRTM_DIR}" ]; then
+    print_err_msg_exit "
+The external CRTM fix file directory specified by CRTM_DIR does not exist:
+  CRTM_DIR = \"${CRTM_DIR}\""
+  fi
+fi
+#
+#-----------------------------------------------------------------------
+#
 # The forecast length (in integer hours) cannot contain more than 3 cha-
 # racters.  Thus, its maximum value is 999.  Check whether the specified
 # forecast length exceeds this maximum value.  If so, print out a warn-
diff --git a/ush/valid_param_vals.sh b/ush/valid_param_vals.sh
index c42144130..e80721d51 100644
--- a/ush/valid_param_vals.sh
+++ b/ush/valid_param_vals.sh
@@ -68,6 +68,7 @@ valid_vals_NOMADS=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_NOMADS_file_type=("GRIB2" "grib2" "NEMSIO" "nemsio")
 valid_vals_DO_ENSEMBLE=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_USE_CUSTOM_POST_CONFIG_FILE=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
+valid_vals_USE_CRTM=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_DO_SHUM=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_DO_SPPT=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")
 valid_vals_DO_SPP=("TRUE" "true" "YES" "yes" "FALSE" "false" "NO" "no")