ctsm5.4.051: Update compsets to use DGLC adjust Fates compsets/tests, remove clm4_5/VIC/BGCDV/NWP%BGC compsets/tests

.github/workflows/check-compset-aliases.sh

@@ -0,0 +1,111 @@
+#!/usr/bin/env bash
+set -e
+
+# Check that clm6* compset aliases return CLM6* longnames
+
+# Change to top level of clone
+cd "$(git rev-parse --show-toplevel)"
+
+# Check that query_config can run without error
+cime/scripts/query_config --compsets 1>/dev/null
+
+bad_compsets() {
+  # Subroutine to Find bad compsets
+  # Set input arguments
+  ALIAS=$1
+  LCOMPSET=$2
+  OLD_IFS=$IFS
+  IFS='\n'
+  set +e
+  # Relies on case sensitivity here: Alias should have $ALIAS and longname should have $LCOMPSET
+  bad_compsets="$(cime/scripts/query_config --compsets | sort | uniq | grep --fixed-strings $ALIAS | grep --fixed-strings --invert-match $LCOMPSET)"
+  set -e
+  if [[ "${bad_compsets}" != "" ]]; then
+      echo "One or more compsets with $ALIAS alias but not $LCOMPSET longname:" >&2
+      echo $bad_compsets  >&2
+      exit 1
+  fi
+}
+
+negative_bad_compsets() {
+  # Subroutine to Find bad compsets by checking that something is found in the long-compset name if something is NOT in the alias
+  # Allows for regular expressions in the alias argument
+  # Set input arguments
+  ALIAS=$1
+  LCOMPSET=$2
+  OLD_IFS=$IFS
+  IFS='\n'
+  set +e
+  # Relies on case sensitivity here: Alias should have $ALIAS and longname should have $LCOMPSET
+  bad_compsets="$(cime/scripts/query_config --compsets clm | awk 'NR > 5{print $0}' | grep -E --invert-match $ALIAS | grep --fixed-strings --invert-match $LCOMPSET)"
+  set -e
+  if [[ "${bad_compsets}" != "" ]]; then
+      echo "One or more compsets without $ALIAS alias but not $LCOMPSET longname:" >&2
+      echo $bad_compsets  >&2
+      exit 1
+  fi
+}
+
+# Now call the subroutine for various options
+# -- Physics versions ---
+bad_compsets Clm60 CLM60
+bad_compsets Clm50 CLM50
+bad_compsets Ctsm50 "CLM50%NWP"
+# -- stub ROF or GLC
+bad_compsets Rs SROF
+bad_compsets Gs SGLC
+# -- General veg type --
+bad_compsets Bgc "%BGC"
+bad_compsets BgcCrop "%BGC-CROP"
+bad_compsets Clm50Sp "%SP"
+bad_compsets Clm60Sp "%SP"
+# ---- Note that specifying SP for NWP compsets as they shouldn't use BGC ----
+bad_compsets Nwp "%NWP-SP"
+# ---- NWP cases should always be stug GLC ---
+bad_compsets Nwp Gs
+bad_compsets Fates "%FATES"
+bad_compsets FatesSp "%FATES-SP"
+# ---- Using full NoAnthro This fails with the error: grep: thro ": No such file or directory
+bad_compsets 'NoA' 'NOANTHRO_'
+
+# -- Period of simulation --
+bad_compsets I2000 2000_
+bad_compsets I2010 2010_
+bad_compsets I1850 1850_
+bad_compsets IHist HIST_
+bad_compsets ISSP585 SSP585_
+bad_compsets ISSP126 SSP126_
+bad_compsets ISSP119 SSP119_
+bad_compsets ISSP245 SSP245_
+bad_compsets ISSP370 SSP370_
+bad_compsets ISSP460 SSP460_
+bad_compsets ISSP534 SSP534_
+# --- DATM forcing types ---
+bad_compsets I1Pt "DATM%1PT"
+bad_compsets Crujra "DATM%CRUJRA2024b"
+bad_compsets Gswp "DATM%GSWP3v1"
+bad_compsets "Cru " "DATM%CRU"
+bad_compsets Nldas "DATM%NLDAS2"
+bad_compsets Qian '_DATM%QIA_'
+# ---- Using full "Spinup" This fails with the error: grep: up ": No such file or directory
+bad_compsets 'Spi' 'DATM%CPLHIST'
+
+# --- ROF models ---
+bad_compsets Miz _MIZUROUTE_
+bad_compsets "Rtm " _RTM_
+bad_compsets RtmFl "_RTM%FLOOD_"
+
+# --- CISM options ---
+bad_compsets "G " '_CISM2%GRIS-EVOLVE_'
+bad_compsets "Ga " '_CISM2%AIS-EVOLVE_'
+bad_compsets "Gag " '_CISM2%AIS-EVOLVE%GRIS-EVOLVE_'
+
+
+#
+# Now check compsets that don't have something in the alias to make sure something else is there
+#
+negative_bad_compsets "Rs|Rtm|Miz" "_MOSART_"
+negative_bad_compsets "Gs|G |Gag|Ga " "_DGLC%NOEVOLVE_"
+negative_bad_compsets 'Crujra|Cru|Nldas|As|1Pt|Qia|Spi' 'GSWP3v1'
+
+exit 0

.github/workflows/check-clm6-aliases.yml → .github/workflows/check-compset-aliases.yml

@@ -1,4 +1,4 @@
-name: Check that clm6* compset aliases return CLM6* longnames
+name: Checking compset aliases are correct
 # Only check files in our repo that AREN'T in submodules
 # Use a Python command to check each file because xmllint isn't available on GH runners
 
@@ -7,14 +7,14 @@ on:
     # Run when a change to these files is pushed to any branch. Without the "branches:" line, for some reason this will be run whenever a tag is pushed, even if the listed files aren't changed.
     branches: ['*']
     paths:
-      - '.github/workflows/check-clm6-aliases.sh'
+      - '.github/workflows/check-compset-aliases.sh'
       - 'cime/**'
       - 'cime_config/config_compsets.xml'
 
   pull_request:
     # Run on pull requests that change the listed files
     paths:
-      - '.github/workflows/check-clm6-aliases.sh'
+      - '.github/workflows/check-compset-aliases.sh'
       - 'cime/**'
       - 'cime_config/config_compsets.xml'
 
@@ -37,4 +37,4 @@ jobs:
 
       - name: Check aliases
         run: |
-          .github/workflows/check-clm6-aliases.sh
+          .github/workflows/check-compset-aliases.sh

cime_config/SystemTests/ssp.py

@@ -3,7 +3,7 @@
 
 This is a CLM specific test:
 Verifies that spinup works correctly
-this test is only valid for CLM compsets with CLM45 or CLM50
+this test is only valid for CLM compsets with CLM50
 (1) do an initial spin test
     - set CLM_ACCELERATED_SPINUP to on
     - write restarts at the end of the run, turn on short term archiving

cime_config/buildnml

@@ -97,10 +97,6 @@ def buildnml(case, caseroot, compname):
     # Warnings for land tuning modes
     #
     closest_tuning = {
-        "clm4_5_1PT": "clm4_5_CRUv7",
-        "clm4_5_QIAN": "clm4_5_CRUv7",
-        "clm4_5_NLDAS2": "clm4_5_CRUv7",
-        "clm4_5_ERA5": "clm4_5_CRUv7",
         "clm5_0_1PT": "clm5_0_GSWP3v1",
         "clm5_0_QIAN": "clm5_0_GSWP3v1",
         "clm5_0_NLDAS2": "clm5_0_GSWP3v1",
@@ -137,9 +133,6 @@ def buildnml(case, caseroot, compname):
         "clm6_0_cam4.0": "clm5_0_cam6.0",
         "clm5_0_cam5.0": "clm5_0_cam6.0",
         "clm5_0_cam4.0": "clm5_0_cam6.0",
-        "clm4_5_cam6.0": "clm5_0_cam6.0",
-        "clm4_5_cam5.0": "clm5_0_cam6.0",
-        "clm4_5_cam4.0": "clm5_0_cam6.0",
     }
     for mode, based_on in tuning_based_on.items():
         if lnd_tuning_mode == mode:

cime_config/config_component.xml

@@ -13,25 +13,20 @@
 
   <!-- Descriptions of all the different valid configurations for different model versions -->
   <description modifier_mode="1">
-    <desc lnd="CLM45[%SP][%SP-VIC][%BGC][%BGC-CROP][%FATES][%BGCDV][%BGCDV-CROP]"                  >clm4.5:</desc>
-    <desc lnd="CLM50[%SP][%SP-VIC][%SP-NOANTHRO][%BGC-NOANTHRO][%BGC][%BGC-CROP][%FATES][%BGCDV][%BGCDV-CROP][%BGC-CROP-CMIP6DECK][%BGC-CROP-CMIP6WACCMDECK][%NWP-SP][%NWP-BGC-CROP]">clm5.0:</desc>
-    <desc lnd="CLM60[%SP][%SP-NOANTHRO][%BGC-NOANTHRO][%BGC][%BGC-CROP][%FATES][%FATES-SP][%BGC-CROP-CMIP6DECK][%BGC-CROP-CMIP6WACCMDECK][%NWP-SP][%NWP-BGC-CROP]">clm6.0:</desc>
+    <desc lnd="CLM50[%SP][%SP-NOANTHRO][%BGC-NOANTHRO][%BGC][%BGC-CROP][%FATES][%BGC-CROP-CMIP6DECK][%BGC-CROP-CMIP6WACCMDECK][%NWP-SP]">clm5.0:</desc>
+    <desc lnd="CLM60[%SP][%SP-NOANTHRO][%BGC-NOANTHRO][%BGC][%BGC-CROP][%FATES][%FATES-SP][%BGC-CROP-CMIP6DECK][%BGC-CROP-CMIP6WACCMDECK][%NWP-SP]">clm6.0:</desc>
     <desc option="SP"              >Satellite phenology:</desc>
 
-    <desc option="SP-VIC"          >Satellite phenology with VIC hydrology:</desc>
     <desc option="SP-NOANTHRO"     >Satellite phenology without anthropomorphic influences</desc>
     <desc option="BGC"             >BGC (vert. resol. CN and methane):</desc>
     <desc option="BGC-CROP"        >BGC (vert. resol. CN and methane) with prognostic crop:</desc>
     <desc option="BGC-NOANTHRO"    >BGC (vert. resol. CN and methane) without anthropomorphic influences:</desc>
     <desc option="FATES"           >FATES (Functionally Assembled Terrestrial Ecosystem Simulator) Ecosystem Demography model: </desc>
     <desc option="FATES-SP"        >Satellite phenology with FATES (Functionally Assembled Terrestrial Ecosystem Simulator) Ecosystem Demography model: </desc>
-    <desc option="BGCDV"           >BGC (vert. resol. CN and methane) with dynamic vegetation:</desc>
-    <desc option="BGCDV-CROP"      >BGC (vert. resol. CN and methane) with dynamic vegetation and prognostic crop:</desc>
     <desc option="BGC-CROP-CMIP6DECK">BGC (vert. resol. CN and methane) with prognostic crop, with modifications appropriate for CMIP6 DECK experiments:</desc>
     <desc option="BGC-CROP-CMIP6WACCMDECK">BGC (vert. resol. CN and methane) with prognostic crop, with modifications appropriate for CMIP6 WACCM DECK experiments:</desc>
 
     <desc option="NWP-SP"          >NWP configuration with satellite phenology:</desc>
-    <desc option="NWP-BGC-CROP"    >NWP configuration with BGC and CROP:</desc>
   </description>
   <entry id="COMP_LND">
     <type>char</type>
@@ -79,24 +74,9 @@
     </desc>
     <default_value>UNSET</default_value>
     <!-- List of forcing options for each CLM physics option: CRUJRA2024, CRUv7, GSWP3, cam7.0, cam6.0, cam5.0, cam4.0, QIAN, 1PT, NLDAS2, ERA5 -->
-    <valid_values>clm5_0_cam6.0,clm5_0_cam7.0,clm5_0_cam5.0,clm5_0_cam4.0,clm5_0_GSWP3v1,clm5_0_CRUJRA2024,clm5_0_CRUv7,clm5_0_QIAN,clm5_0_1PT,clm5_0_NLDAS2,clm5_0_ERA5,clm4_5_CRUv7,clm4_5_GSWP3v1,clm4_5_QIAN,clm4_5_cam6.0,clm4_5_cam7.0,clm4_5_cam5.0,clm4_5_cam4.0,clm4_5_1PT,clm4_5_NLDAS2,clm4_5_ERA5,clm6_0_CRUv7,clm6_0_GSWP3v1,clm6_0_CRUJRA2024,clm6_0_cam6.0,clm6_0_cam7.0,clm6_0_cam5.0,clm6_0_cam4.0,clm6_0_QIAN,clm6_0_1PT,clm6_0_NLDAS2,clm6_0_ERA5</valid_values>
+    <valid_values>clm5_0_cam6.0,clm5_0_cam7.0,clm5_0_cam5.0,clm5_0_cam4.0,clm5_0_GSWP3v1,clm5_0_CRUJRA2024,clm5_0_CRUv7,clm5_0_QIAN,clm5_0_1PT,clm5_0_NLDAS2,clm5_0_ERA5,clm6_0_CRUv7,clm6_0_GSWP3v1,clm6_0_CRUJRA2024,clm6_0_cam6.0,clm6_0_cam7.0,clm6_0_cam5.0,clm6_0_cam4.0,clm6_0_QIAN,clm6_0_1PT,clm6_0_NLDAS2,clm6_0_ERA5</valid_values>
     <values match="last">
       <!-- Options for atm forcing are: CRUJRA2024, CRUJRA2024b, CRUv7, GSWP3, cam6.0 (also used for DATM%CPLHIST), cam5.0, cam4.0, QIAN, WISOQIA, 1PT, NLDAS2, and ERA5) -->
-      <!-- All the clm4_5 physics options -->
-      <value compset="SATM_CLM45"        >clm4_5_CRUv7</value>
-      <value compset="DATM%CRUv7_CLM45"  >clm4_5_CRUv7</value>
-      <value compset="DATM%GSWP3v1_CLM45">clm4_5_GSWP3v1</value>
-      <value compset="CAM[^_]+_CLM45"    >clm4_5_cam6.0</value>
-      <value compset="CAM40[^_]*_CLM45"  >clm4_5_cam4.0</value>
-      <value compset="CAM50[^_]*_CLM45"  >clm4_5_cam5.0</value>
-      <value compset="CAM60[^_]*_CLM45"  >clm4_5_cam6.0</value>
-      <value compset="CAM70[^_]*_CLM45"  >clm4_5_cam7.0</value>
-      <value compset="DATM%CPLHIST_CLM45">clm4_5_cam5.0</value>
-      <value compset="DATM%QIA_CLM45"    >clm4_5_QIAN</value>
-      <value compset="DATM%WISOQIA_CLM45">clm4_5_QIAN</value>
-      <value compset="DATM%1PT_CLM45"    >clm4_5_1PT</value>
-      <value compset="DATM%NLDAS2_CLM45" >clm4_5_NLDAS2</value>
-      <value compset="DATM%ERA5_CLM45"   >clm4_5_ERA5</value>
       <!-- All the clm5_0 physics options -->
       <value compset="DATM%CRUJRA2024[b]*_CLM50">clm5_0_CRUJRA2024</value>
       <value compset="DATM%CRUv7_CLM50"  >clm5_0_CRUv7</value>
@@ -146,7 +126,6 @@
          by the compset match. -->
     <default_value>UNSET</default_value>
     <values>
-      <value compset="_CLM45" >clm4_5</value>
       <value compset="_CLM50" >clm5_0</value>
       <value compset="_CLM60" >clm6_0</value>
     </values>
@@ -279,15 +258,6 @@ Caveats:
       <value compset="CAM[^_]*_CLM[^_]*BGC-CROP"  >--bgc bgc --crop --no-megan --no-drydep --no-fire_emis</value>
       <!-- ======================================= End of Coupled to CAM Options ===============================  -->
 
-      <!-- Options specific for CLM4.5 -->
-      <value compset="_CLM45%[^_]*BGCDV"	 >-bgc bgc -dynamic_vegetation</value>
-      <value compset="_CLM45%[^_]*BGCDV-CROP"	 >-bgc bgc -dynamic_vegetation -crop</value>
-      <value compset="_CLM45%[^_]*SP-VIC"	 >-bgc sp -vichydro </value>
-
-      <!-- Options specific for CLM5.0 -->
-      <value compset="_CLM50%[^_]*BGCDV"	 >-bgc bgc -dynamic_vegetation</value>
-      <value compset="_CLM50%[^_]*BGCDV-CROP"	 >-bgc bgc -dynamic_vegetation -crop</value>
-      <value compset="_CLM50%[^_]*SP-VIC"	 >-bgc sp -vichydro </value>
     </values>
     <group>run_component_ctsm</group>
     <file>env_run.xml</file>