Merge pull request NCAR#329 from mnlevy1981/updates_for_cesm3_workflow

Updates to CUPiD for CESM3 development runs

Author: mnlevy1981

cime_config/config_tool.xml

@@ -247,7 +247,16 @@
     <default_value>FALSE</default_value>
     <group>cupid_run_components</group>
     <file>env_postprocessing.xml</file>
-    <desc>Boolean value that determines whether or not ADF diagnostics are run (if CUPID_RUN_ALL is FALSE)</desc>
+    <desc>Boolean value that determines whether or not ADF diagnostics are run</desc>
+  </entry>
+
+  <entry id="CUPID_RUN_CVDP">
+    <type>char</type>
+    <valid_values>TRUE,FALSE</valid_values>
+    <default_value>FALSE</default_value>
+    <group>cupid_run_components</group>
+    <file>env_postprocessing.xml</file>
+    <desc>Boolean value that determines whether or not CVDP diagnostics are run (requires CUPID_RUN_ADF=TRUE)</desc>
   </entry>
 
   <entry id="CUPID_RUN_LDF">
@@ -256,7 +265,7 @@
     <default_value>FALSE</default_value>
     <group>cupid_run_components</group>
     <file>env_postprocessing.xml</file>
-    <desc>Boolean value that determines whether or not LDF diagnostics are run (if CUPID_RUN_ALL is FALSE)</desc>
+    <desc>Boolean value that determines whether or not LDF diagnostics are run</desc>
   </entry>
 
   <entry id="CUPID_RUN_ILAMB">

examples/key_metrics/config.yml

@@ -156,7 +156,7 @@ compute_notebooks:
             obs_data_loc: /glade/campaign/cgd/amp/amwg/ADF_obs
           analysis_scripts: ["amwg_table"]
           diag_cvdp_info:
-            cvdp_run: False # a bunch of warnings of convert being deprecated in IMv7 will be printed if turned on - will be fixed with CVDP update
+            cvdp_run: False
             cvdp_tar: False
           regridded_output: False
           base_regridded_output: False

helper_scripts/cesm_postprocessing.sh

@@ -35,6 +35,7 @@ CUPID_RUN_ICE=`./xmlquery --value CUPID_RUN_ICE`
 CUPID_RUN_ROF=`./xmlquery --value CUPID_RUN_ROF`
 CUPID_RUN_GLC=`./xmlquery --value CUPID_RUN_GLC`
 CUPID_RUN_ADF=`./xmlquery --value CUPID_RUN_ADF`
+CUPID_RUN_CVDP=`./xmlquery --value CUPID_RUN_CVDP`
 CUPID_RUN_LDF=`./xmlquery --value CUPID_RUN_LDF`
 CUPID_RUN_ILAMB=`./xmlquery --value CUPID_RUN_ILAMB`
 CUPID_RUN_TYPE=`./xmlquery --value CUPID_RUN_TYPE`
@@ -115,7 +116,19 @@ fi
 conda activate ${CUPID_INFRASTRUCTURE_ENV}
 
 # 1. Generate CUPiD config file
+if [ "${CUPID_RUN_CVDP}" == "TRUE" ]; then
+  if [ "${CUPID_RUN_ADF}" != "TRUE" ]; then
+    echo "ERROR: CUPID_RUN_CVDP=TRUE but CUPID_RUN_ADF=${CUPID_RUN_ADF}. CVDP is run by"
+    echo "the ADF, so that combination of flags will result in CVDP not being run."
+    echo "Either set CUPID_RUN_ADF=TRUE or CUPID_RUN_CVDP=FALSE"
+    exit 1
+  fi
+  CVDP_OPT="--run-cvdp"
+else
+  CVDP_OPT=""
+fi
 ${CUPID_ROOT}/helper_scripts/generate_cupid_config_for_cesm_case.py \
+   ${CVDP_OPT} \
    --case-root ${CASEROOT} \
    --cesm-root ${SRCROOT} \
    --cupid-root ${CUPID_ROOT} \

helper_scripts/generate_cupid_config_for_cesm_case.py

@@ -70,6 +70,7 @@
     default=None,
     help="Boolean flag to indicate whether to run ILAMB analysis",
 )
+@click.option("--run-cvdp", is_flag=True, default=False, help="Run CVDP diagnostics")
 def generate_cupid_config(
     case_root,
     cesm_root,
@@ -88,6 +89,7 @@ def generate_cupid_config(
     cupid_run_adf,
     cupid_run_ldf,
     cupid_run_ilamb,
+    run_cvdp,
 ):
     """
     Generate a CUPiD `config.yml` file based on information from a CESM case and
@@ -210,9 +212,7 @@ def generate_cupid_config(
         my_dict = yaml.safe_load(f)
 
     my_dict["data_sources"]["nb_path_root"] = os.path.join(
-        cesm_root,
-        "tools",
-        "CUPiD",
+        cupid_root,
         "nblibrary",
     )
     my_dict["global_params"]["case_name"] = case
@@ -291,7 +291,13 @@ def generate_cupid_config(
         my_dict["compute_notebooks"]["atm"]["ADF"]["parameter_groups"]["none"][
             "adf_root"
         ] = os.path.join(adf_output_root, "ADF_output")
-
+        if "diag_cvdp_info" in my_dict["compute_notebooks"]["atm"]["ADF"].get(
+            "external_tool",
+            {},
+        ):
+            my_dict["compute_notebooks"]["atm"]["ADF"]["external_tool"][
+                "diag_cvdp_info"
+            ]["cvdp_run"] = run_cvdp
     if "CVDP" in my_dict["compute_notebooks"].get("atm", {}):
         my_dict["compute_notebooks"]["atm"]["CVDP"]["parameter_groups"]["none"][
             "cvdp_loc"

nblibrary/atm/ADF.ipynb

@@ -177,7 +177,7 @@
     "        adf_root = adf_root_candidate\n",
     "        display(\n",
     "            HTML(\n",
-    "                f'<a href=\"./ADF/{adf_comparison_name}/website/index.html\" target=\"_blank\" style=\"font-size: 30px\">Full ADF output</a>'\n",
+    "                f'<a href=\"../ADF/{adf_comparison_name}/website/index.html\" target=\"_blank\" style=\"font-size: 30px\">Full ADF output</a>'\n",
     "            )\n",
     "        )\n",
     "        break\n",

nblibrary/lnd/LDF.ipynb

@@ -165,7 +165,7 @@
     "        ldf_root = ldf_root_candidate\n",
     "        display(\n",
     "            HTML(\n",
-    "                f'<a href=\"./LDF/{ldf_comparison_name}/website/index.html\" target=\"_blank\" style=\"font-size: 30px\">Full LDF output</a>'\n",
+    "                f'<a href=\"../LDF/{ldf_comparison_name}/website/index.html\" target=\"_blank\" style=\"font-size: 30px\">Full LDF output</a>'\n",
     "            )\n",
     "        )\n",
     "        break\n",