ctsm5.4.035: Merge b4bdev 20260424

.github/workflows/docs-pr-failure-post-comment.yml

@@ -0,0 +1,66 @@
+name: Post PR comment with doc-build failure log
+
+env:
+  DOCS_FAILURE_ARTIFACT: test-build-docs-container_failed
+
+on:
+  workflow_run:
+    workflows: ["Test building docs when they're updated"]
+    types: [completed]
+
+jobs:
+  comment:
+    if: >-
+      github.event.workflow_run.event == 'pull_request'
+      && github.event.workflow_run.conclusion == 'failure'
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      actions: read
+    steps:
+      - name: Check for failure artifact
+        id: check
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO: ${{ github.repository }}
+        run: |
+          gh api repos/$REPO/actions/runs/${{ github.event.workflow_run.id }}/artifacts \
+            --jq '.artifacts[] | select(.name == "${{ env.DOCS_FAILURE_ARTIFACT }}") | .id' > artifact_id.txt
+
+          if [ -s artifact_id.txt ]; then
+            echo "found=true" >> $GITHUB_OUTPUT
+          else
+            echo "found=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Download logs
+        if: steps.check.outputs.found == 'true'
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ env.DOCS_FAILURE_ARTIFACT }}
+          path: ${{ env.DOCS_FAILURE_ARTIFACT }}
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Post comment
+        if: steps.check.outputs.found == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO: ${{ github.repository }}
+        run: |
+          PR_NUMBER=$(cat "${DOCS_FAILURE_ARTIFACT}/pr_number.txt")
+
+          {
+            echo "### ❌ Docs build failed"
+            echo
+            echo '<details open="true">'
+            echo "<summary>Build logs</summary>"
+            echo
+            echo '```'
+            cat "${DOCS_FAILURE_ARTIFACT}/build.log"
+            echo '```'
+            echo
+            echo "</details>"
+          } > comment-body.md
+
+          gh pr comment "$PR_NUMBER" --repo "$REPO" --body-file comment-body.md

.github/workflows/docs.yml

@@ -61,4 +61,24 @@ jobs:
       - name: Build docs using Docker (Podman has trouble on GitHub runners)
         id: build-docs
         run: |
-          cd doc && ./build_docs -b ${PWD}/_build -c -d
+          set -o pipefail
+          mkdir -p build-logs
+          cd doc && PYTHONUNBUFFERED=1 ./build_docs -b ${PWD}/_build -c -d 2>&1 | tee >(sed -E $'s/\x1b\\[[0-9;]*[a-zA-Z]//g' > "${GITHUB_WORKSPACE}/build-logs/build.log")
+        # The tee writes build.log for the PR comment (posted by docs-pr-failure-post-comment.yml); the inner sed strips ANSI color codes that would otherwise render as garbage in the comment.
+        # PYTHONUNBUFFERED=1 because otherwise the teed log will be out of order
+
+      # The rest of the steps only trigger on failure of above build-docs step.
+      # They upload logs that will be used by the docs-pr-failure-post-comment.yml workflow.
+
+      - name: Record PR number on failure
+        if: failure() && steps.build-docs.outcome == 'failure' && github.event_name == 'pull_request'
+        run: |
+          mkdir -p build-logs
+          echo "${{ github.event.pull_request.number }}" > build-logs/pr_number.txt
+
+      - name: Upload logs on failure
+        if: failure() && steps.build-docs.outcome == 'failure'
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
+        with:
+          name: test-build-docs-container_failed
+          path: build-logs/

.gitmodules

@@ -68,23 +68,23 @@ fxDONOTUSEurl = https://github.com/ESCOMP/mizuRoute
 [submodule "ccs_config"]
 path = ccs_config
 url = https://github.com/ESMCI/ccs_config_cesm.git
-fxtag = ccs_config_cesm1.0.79
+fxtag = ccs_config_cesm1.0.83
 fxrequired = ToplevelRequired
 # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed
 fxDONOTUSEurl = https://github.com/ESMCI/ccs_config_cesm.git
 
 [submodule "cime"]
 path = cime
 url = https://github.com/ESMCI/cime
-fxtag = cime6.1.169
+fxtag = cime6.1.176
 fxrequired = ToplevelRequired
 # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed
 fxDONOTUSEurl = https://github.com/ESMCI/cime
 
 [submodule "cmeps"]
 path = components/cmeps
 url = https://github.com/ESCOMP/CMEPS.git
-fxtag = cmeps1.1.37
+fxtag = cmeps1.1.44
 fxrequired = ToplevelRequired
 # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed
 fxDONOTUSEurl = https://github.com/ESCOMP/CMEPS.git

bld/CLMBuildNamelist.pm

@@ -2083,13 +2083,16 @@ sub setup_logic_irrigate {
   my ($opts, $nl_flags, $definition, $defaults, $nl) = @_;
 
   add_default($opts,  $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl, 'irrigate',
-                'use_crop'=>$nl_flags->{'use_crop'}, 'use_cndv'=>$nl_flags->{'use_cndv'},
+                'use_crop'=>$nl_flags->{'use_crop'}, 'use_cndv'=>$nl_flags->{'use_cndv'}, 'use_fates'=>$nl_flags->{'use_fates'},
                 'sim_year'=>$nl_flags->{'sim_year'}, 'sim_year_range'=>$nl_flags->{'sim_year_range'}, );
   if ( &value_is_true($nl->get_value('irrigate') ) ) {
      $nl_flags->{'irrigate'} = ".true.";
      if ( $nl_flags->{'sim_year'} eq "PtVg" ) {
         $log->fatal_error("irrigate=TRUE does NOT make sense with the Potential Vegetation dataset, leave irrigate=FALSE");
      }
+     if (&value_is_true($nl_flags->{'use_fates'})) {
+        $log->fatal_error("irrigate=TRUE is NOT possible with use_fates=TRUE, leave irrigate=FALSE");
+     }
   } else {
      $nl_flags->{'irrigate'} = ".false.";
   }

bld/namelist_files/namelist_defaults_ctsm.xml

@@ -200,10 +200,11 @@ attributes from the config_cache.xml file (with keys converted to upper-case).
 <stream_model_year_align_atm_c13  sim_year_range="1850-2000" >1700</stream_model_year_align_atm_c13>
 
 <!-- Irrigation default (Note, the use-cases also set this) -->
-<irrigate                                                             >.false.</irrigate>
-<irrigate               use_cndv=".false."  sim_year_range="1850-2100">.true.</irrigate>
-<irrigate phys="clm6_0" use_cndv=".false."  sim_year_range="1850-2000">.true.</irrigate>
-<irrigate phys="clm4_5" use_cndv=".false."  sim_year_range="1850-2100">.false.</irrigate>
+<irrigate                                                                                  >.false.</irrigate>
+<irrigate                                                              use_fates=".true."  >.false.</irrigate>
+<irrigate               use_cndv=".false."  sim_year_range="1850-2100" use_fates=".false." >.true.</irrigate>
+<irrigate phys="clm6_0" use_cndv=".false."  sim_year_range="1850-2000" use_fates=".false." >.true.</irrigate>
+<irrigate phys="clm4_5" use_cndv=".false."  sim_year_range="1850-2100"                     >.false.</irrigate>
 
 <!-- Saturation excess runoff for crops  -->
 <crop_fsat_equals_zero>.false.</crop_fsat_equals_zero>

bld/unit_testers/build-namelist_test.pl

@@ -165,7 +165,7 @@ sub cat_and_create_namelistinfile {
 #
 # Figure out number of tests that will run
 #
-my $ntests = 3403;
+my $ntests = 3405;
 
 if ( defined($opts{'compare'}) ) {
    $ntests += 2061;
@@ -1271,6 +1271,10 @@ sub cat_and_create_namelistinfile {
                                      namelst=>"z0param_method=Meier2022",
                                      phys=>"clm5_0",
                                    },
+     "FATES_w_irrig"              =>{ options=>"-envxml_dir . -res 0.9x1.25 -bgc fates -use_case 20thC_transient",
+                                     namelst=>"irrigate=T",
+                                     phys=>"clm6_0",
+                                   },
      "noanthro_w_crop"            =>{ options=>"-envxml_dir . -res 0.9x1.25 -bgc bgc -crop -use_case 1850_noanthro_control",
                                      namelst=>"",
                                      phys=>"clm5_0",

doc/.ChangeLog_template

@@ -53,6 +53,8 @@ Substantial timing or memory changes:
 [e.g., check PFS test in the test suite and look at timings, if you
 expect possible significant timing changes]
 
+Contributors:
+
 Notes of particular relevance for developers:
 ---------------------------------------------
 NOTE: Be sure to review the steps in README.CHECKLIST.master_tags as well as the coding style in the Developers Guide
@@ -62,8 +64,6 @@ Caveats for developers (e.g., code that is duplicated that requires double maint
 
 Changes to tests or testing:
 
-Contributors:
-
 Testing summary:
 ----------------
 [... Remove before making master tag.

doc/ChangeLog

@@ -1,4 +1,82 @@
 ===============================================================
+Tag name: ctsm5.4.035
+Originator(s): erik (Erik Kluzek,UCAR/TSS,303-497-1326)
+Date: Sun Apr 26 09:38:17 PM MDT 2026
+One-line Summary: Merge b4b-dev to master
+
+Purpose and description of changes
+----------------------------------
+
+Update submodules, enforce irrigate to off for FATES transient cases, and several documentation updates. Including a github action that will trigger when a PR has a build failure for the documentation. It will then add a comment to the PR summarizing the error. Hopefully, this will be easier for doc editors to understand what broke in the build for their PR.
+
+When a PR has the "build docs" tests fail, it's hard to figure out why. This PR will make it so that the doc build log is posted in a PR comment after the test failure. Example samsrabin#17 (comment).
+
+Since ctsm5.3.046: patch%itype is set to -999, which produces out-of-bounds error, when running HIST with fates, since the defaults point to irrigate=.true..
+
+Though there is irrigate=.true. in use_cases, all the statements with .true. value have use_crop=.true. which can not be true when fates is on.
+
+Bugs fixed
+----------
+
+List of CTSM issues fixed (include CTSM Issue # and description) [one per line]:
+
+Fixes #3170
+Most of #3861 except #3968
+
+Notes of particular relevance for users
+---------------------------------------
+
+Changes made to namelist defaults (e.g., changed parameter values):
+   For FATES ensure that irrigate is off for transient cases
+
+Changes to documentation: Updates to the mizuRoute and dust emission chapters
+
+Contributors:  @dmleung @nmizukami @samsrabin @olyson @mvdebolskiy Claude Sonnet 4.6 and Opus 4.7 1M
+
+Testing summary: regular
+----------------
+ [PASS means all tests PASS; OK means tests PASS other than expected fails.]
+
+  build-namelist tests (if CLMBuildNamelist.pm has changed):
+
+    derecho -
+
+  python testing (if python code has changed; see instructions in python/README.md; document testing done):
+
+    derecho -
+
+  regular tests (aux_clm: https://github.com/ESCOMP/CTSM/wiki/System-Testing-Guide#pre-merge-system-testing):
+
+    derecho -----
+    izumi -------
+
+If the tag used for baseline comparisons was NOT the previous tag, note that here:
+
+Answer changes
+--------------
+
+Changes answers relative to baseline: No bit for bit
+
+Other details
+-------------
+List any git submodules updated (cime, rtm, mosart, cism, fates, etc.): ccs_config, cime, cmeps
+   Update to the latest submodules for the time. This is beyond the versions in cesm3_0_beta08
+
+   ccs_config to ccs_config_cesm1.0.83 (includes grids for the new t233 ocean mask for MOM)
+   cime to cime6.1.176  
+   cmeps to cmeps1.1.44
+
+Pull Requests that document the changes (include PR ids):
+(https://github.com/ESCOMP/ctsm/pull)
+
+#3624 -- dust emission chapter in Tech Note
+#3925 -- mizuRoute chapter in Tech Note
+#3955 -- New workflow to add comments to PR about a failure in the doc-build action
+#3938 -- Update submodules
+#3812 -- Ensure irrigate is FALSE for FATES for transient cases
+
+===============================================================
+===============================================================
 Tag name: ctsm5.4.034
 Originator(s): afoster (Adrianna Foster,UCAR/TSS,303-497-1728)
 Date: Wed Apr 22 11:02:13 AM MDT 2026

doc/ChangeSum

@@ -1,5 +1,6 @@
 Tag                   Who      Date  Summary
 ============================================================================================================================
+       ctsm5.4.035     erik 04/26/2026 Merge b4b-dev to master
        ctsm5.4.034  afoster 04/22/2026 bug fix to the FATES land use driver input code
        ctsm5.4.033 glemieux 04/17/2026 Update fates tag with missing land use data check fix
        ctsm5.4.032 samrabin 04/10/2026 Simplify doc build messaging.