Skip to content

Technote updates for Hillslope Hydrology, biomass heat storage, and Methane model#3947

Merged
slevis-lmwg merged 8 commits into
ESCOMP:b4b-devfrom
swensosc:swenson_ctsm_docs
May 11, 2026
Merged

Technote updates for Hillslope Hydrology, biomass heat storage, and Methane model#3947
slevis-lmwg merged 8 commits into
ESCOMP:b4b-devfrom
swensosc:swenson_ctsm_docs

Conversation

@swensosc
Copy link
Copy Markdown
Contributor

@swensosc swensosc commented Apr 22, 2026

Description of changes

updates to ctsm documentation

update 2.5. Momentum, Sensible Heat, and Latent Heat Fluxes
add biomass heat storage -related text
update 2.25 Methane Model
add description of surface layer addition to transport equations
add 2.?? Hillslope Hydrology chapter

Specific notes

Contributors other than yourself, if any:

CTSM Issues Fixed (include github issue #):

Are answers expected to change (and if so in what way)?

Any User Interface Changes (namelist or namelist defaults changes)?

Does this create a need to change or add documentation? Did you do so?

Testing performed, if any:
(List what testing you did to show your changes worked as expected)
(This can be manual testing or running of the different test suites)
(Documentation on system testing is here: https://github.com/ESCOMP/ctsm/wiki/System-Testing-Guide)
(aux_clm on derecho for intel/gnu and izumi for intel/gnu/nag/nvhpc is the standard for tags on master)

NOTE: Be sure to check your coding style against the standard
(https://github.com/ESCOMP/ctsm/wiki/CTSM-coding-guidelines) and review
the list of common problems to watch out for
(https://github.com/ESCOMP/CTSM/wiki/List-of-common-problems).

If this PR changes the CTSM web documentation, please see our contribution guidelines for documentation.

@samsrabin
Copy link
Copy Markdown
Member

Thanks, @swensosc! Could you please fill out the PR template? Also, please describe in high-level terms the changes you're making—at least what chapters you're touching. Thanks!

@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure b4b bit-for-bit docs:update Significant update or fix needed to existing documentation docs-loc:tech-note Relates to Technical Note (science) labels Apr 22, 2026
@samsrabin
Copy link
Copy Markdown
Member

Also:

  • When you say "first draft"—are you expecting this PR to be merged as-is (after review), then you'll make further updates later? Or were you planning to make more changes to this PR? If the latter, please mark the PR as a draft so we know not to review it yet.
  • Does/will this contain all changes needed to the methane chapter, thus resolving Review 2.26. Methane Model #3872?

@swensosc swensosc marked this pull request as draft April 22, 2026 15:28
@slevis-lmwg
Copy link
Copy Markdown
Contributor

@swensosc do you feel this is ready for review?

@slevis-lmwg slevis-lmwg moved this to In Progress in CLM documentation May 6, 2026
@swensosc
Copy link
Copy Markdown
Contributor Author

swensosc commented May 7, 2026 via email

@slevis-lmwg slevis-lmwg marked this pull request as ready for review May 7, 2026 16:36
@slevis-lmwg slevis-lmwg self-requested a review May 7, 2026 16:37
@slevis-lmwg slevis-lmwg changed the base branch from master to b4b-dev May 7, 2026 16:45
@slevis-lmwg slevis-lmwg self-assigned this May 7, 2026
@slevis-lmwg
Copy link
Copy Markdown
Contributor

I added this to my Sprint board to avoid losing track of it.
I hope to finish the review tomorrow.
So far it looks great.

@slevis-lmwg slevis-lmwg moved this from Todo to In Progress in LMWG: Sprint Planning Board May 7, 2026
Copy link
Copy Markdown
Contributor

@slevis-lmwg slevis-lmwg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @swensosc for this work! Looks good. I will take care of the typo that I reported :-)

Comment thread doc/source/tech_note/Hillslope_Hydrology/CLM50_Tech_Note_Hillslope_Hydrology.rst Outdated
@slevis-lmwg
Copy link
Copy Markdown
Contributor

@swensosc I consider this ready to merge to b4b-dev.
Let me know if you wanted to take a last look before I merge.

@slevis-lmwg slevis-lmwg merged commit 673c598 into ESCOMP:b4b-dev May 11, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in CLM documentation May 11, 2026
@github-project-automation github-project-automation Bot moved this from In Progress to Done in LMWG: Sprint Planning Board May 11, 2026
@slevis-lmwg slevis-lmwg deleted the swenson_ctsm_docs branch May 11, 2026 16:38
@slevis-lmwg slevis-lmwg mentioned this pull request May 11, 2026
8 tasks
@slevis-lmwg slevis-lmwg changed the title first draft of clm6 documentation updates Technote updates for Hillslope Hydrology, biomass heat storage, and Methane model May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit docs:update Significant update or fix needed to existing documentation docs-loc:tech-note Relates to Technical Note (science) documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

Document the biomass heat storage parameterization in the technical note Docs needed: Hillslopes Review 2.26. Methane Model

3 participants