Skip to content

CN allocation tech notes improvements#4020

Merged
slevis-lmwg merged 6 commits into
ESCOMP:b4b-devfrom
huiqi-wang:docs/cn-allocation-improvements
May 19, 2026
Merged

CN allocation tech notes improvements#4020
slevis-lmwg merged 6 commits into
ESCOMP:b4b-devfrom
huiqi-wang:docs/cn-allocation-improvements

Conversation

@huiqi-wang

@huiqi-wang huiqi-wang commented May 13, 2026

Copy link
Copy Markdown
Contributor

Description of changes

Specific notes

Contributors other than yourself, if any:

CTSM issues resolved or otherwise addressed, if any:
Resolves #3866

  • references related:
    Line 14, 16: Plant Respiration → Chapter :numref:rst_Plant RespirationLine 14: Sprugel → :ref:Sprugel et al. (1995)
    Line 72: Larcher → :ref:Larcher (1995) Line 81: Allen / Vanninen / Axelsson — all three are now :ref: Lines 72, 161: Table → :numref:Table Allocation and CN ratio parameters
    Lines 163, 182: Equations → :eq:19.7, :eq:19.9, :eq:19.10, :eq:19.11, :eq:19.12 Lines 259, 335: FUN → Chapter :numref:rst_FUN

  • Bug fixes:
    Line 72: g_l → g_1 (typo)
    Line 79: parentheses fixed in the a_3 sigmoid → \frac{2.7}{1 + e^{-0.004 (NPP_{ann} - 300)}} - 0.4
    Line 111: missing table row separator inserted (BDS boreal / C₃ arctic grass)
    Line 194: CF_{alloc,leaf} → CF_{alloc,leaf_tot} (consistent with Eq. 19.14–19.25)

  • add more explanation and clarification:
    Line 45: 86400 is now explained (s day⁻¹, converts τ from days to s)
    Line 147: PFT abbreviation legend (NET/NDT/BET/BDT/BES/BDS + R/I)
    Lines 64–70 & 154–159: Eqs. 19.7 and 19.9 use \begin{aligned} + \text{}
    Line 256: section title capitalized "Nitrogen Allocation"
    Line 85: table title "carbon:nitrogen" (not :)
    Line 88: Target :math:CN_{...}`` (text outside math) — keep it consistant with similar item in CN Pools

- flag some but have not solved yet

  1. Eq. 19.26 (min(demand, supply)) and Eq. 19.40 (N_uptake · demand_i / demand_tot) both define NF_{alloc,i}. This is confusing to me. I feel like there some sentences missing here, such as when When N_{uptake} ≥ NF_{demand,tot}, then xxxx, need help from science team.
  2. The table shows 9-column in rst file but shows 7 columns in html. It may truncate in PDF; verify after a new html build, then decide split/landscape if needed

@slevis-lmwg slevis-lmwg linked an issue May 13, 2026 that may be closed by this pull request
8 tasks
@wwieder wwieder requested a review from slevis-lmwg May 14, 2026 14:44
@wwieder wwieder added the docs:update Significant update or fix needed to existing documentation label May 14, 2026
@wwieder

wwieder commented May 14, 2026

Copy link
Copy Markdown
Contributor

@slevis-lmwg do you mind reviewing this?

@slevis-lmwg slevis-lmwg moved this to In review in CLM documentation May 14, 2026
@slevis-lmwg slevis-lmwg added b4b bit-for-bit docs-loc:tech-note Relates to Technical Note (science) labels May 14, 2026
@slevis-lmwg slevis-lmwg changed the base branch from master to b4b-dev May 14, 2026 15:12
@slevis-lmwg slevis-lmwg moved this from Todo to In Progress in LMWG: Sprint Planning Board May 19, 2026

@slevis-lmwg slevis-lmwg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@huiqi-wang thank you for your work in this PR!

  • Good news, the table looks fine in the html because it has a scroll bar at the bottom.
  • I requested two updates that I will try to push to the PR myself.
  • Then I will merge this to b4b-dev.

Comment thread doc/source/tech_note/CN_Allocation/CLM50_Tech_Note_CN_Allocation.rst Outdated
Comment thread doc/source/tech_note/CN_Allocation/CLM50_Tech_Note_CN_Allocation.rst Outdated
@github-actions

This comment was marked as resolved.

@github-actions

This comment was marked as resolved.

@slevis-lmwg

Copy link
Copy Markdown
Contributor

I messed up the table. Fixing now.

@slevis-lmwg slevis-lmwg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me. Thanks again @huiqi-wang.

@slevis-lmwg slevis-lmwg merged commit 88dfe42 into ESCOMP:b4b-dev May 19, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in CLM documentation May 19, 2026
@github-project-automation github-project-automation Bot moved this from In Progress to Done in LMWG: Sprint Planning Board May 19, 2026
@slevis-lmwg slevis-lmwg deleted the docs/cn-allocation-improvements branch May 19, 2026 23:51
@huiqi-wang

Copy link
Copy Markdown
Contributor Author

Thank you for your help too!!

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)

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

Review 2.20. C and N Allocation; and make updates

3 participants