Skip to content

Add documentation for nutrient split between litter pools#1065

Merged
jacobcook1995 merged 6 commits intodevelopfrom
1046-document-the-split-of-nutrients-between-litter-pools
Oct 8, 2025
Merged

Add documentation for nutrient split between litter pools#1065
jacobcook1995 merged 6 commits intodevelopfrom
1046-document-the-split-of-nutrients-between-litter-pools

Conversation

@jacobcook1995
Copy link
Copy Markdown
Collaborator

@jacobcook1995 jacobcook1995 commented Oct 1, 2025

Description

@hrlai, this adds documentation for the split between of nutrient between pools. Please let me know whether it makes sense (if it doesn't make sense to you it won't make sense to anyone really).

One thing I was wondering is whether it's worth including the equations for how the split is calculated in here? Let me know whether that seems like a good idea or just clutter.

The relevant docs can be viewed here

Fixes #1046

@jacobcook1995 jacobcook1995 linked an issue Oct 1, 2025 that may be closed by this pull request
@jacobcook1995 jacobcook1995 requested a review from hrlai October 1, 2025 10:33
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.56%. Comparing base (745f4b3) to head (fae07db).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1065   +/-   ##
========================================
  Coverage    94.56%   94.56%           
========================================
  Files           79       79           
  Lines         6973     6973           
========================================
  Hits          6594     6594           
  Misses         379      379           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hrlai
Copy link
Copy Markdown
Collaborator

hrlai commented Oct 2, 2025

Hey @jacobcook1995 yes I think it would benefit (at least someone like me) to have the equations. For now I struggle a bit in parsing the text descriptions.

@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@hrlai, ah yes that was a bit of a wall of text. I've broken up the text a bit and added in equations, which should hopefully make it clearer. Let me know what you think!

Copy link
Copy Markdown
Collaborator

@hrlai hrlai left a comment

Choose a reason for hiding this comment

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

Looks good, added very minor edits.

I think it'd be good to add a one-liner interpretation of $r_m$, and I have come up with a one-liner based on the following flow chart. I hope this is the right interpretation.

image

@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

Yeah the part in the square brackets is a bit hard to explain.

It basically boils down to the fact that the flow to each pool has already been determined, so the ratio of input chemistries ($\rho$) can only be maintained (consistent with the total input) by changing the chemistry of the input flows ($r_m$ and $r_s$). So the first term in the brackets represents the nutrient input to the metabolic pool and the second term the nutrient input that has to be added to the structural pool to maintain the fixed ratio ($\rho$). The solution to the equation is then the only solution that doesn't involve nutrients being created or destroyed.

@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@hrlai , I've tried to explain the above in the docs, let me know if it makes sense or needs further changes

@jacobcook1995 jacobcook1995 requested a review from hrlai October 6, 2025 08:50
@hrlai
Copy link
Copy Markdown
Collaborator

hrlai commented Oct 7, 2025

Ah I see. Thanks, looks good to me now.

@jacobcook1995 jacobcook1995 merged commit 53a743d into develop Oct 8, 2025
13 checks passed
@jacobcook1995 jacobcook1995 deleted the 1046-document-the-split-of-nutrients-between-litter-pools branch October 8, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the split of nutrients between litter pools

3 participants