Address PR #248 review feedback: document wood carbon storage pool#253
Conversation
Co-authored-by: dlebauer <464871+dlebauer@users.noreply.github.com>
Co-authored-by: dlebauer <464871+dlebauer@users.noreply.github.com>
…r review Co-authored-by: dlebauer <464871+dlebauer@users.noreply.github.com>
Completed in 1a071ee: ✅ Storage pool description added: Updated Wood Carbon section in model-structure.md to document plantWoodCStorageDelta as explicit storage pool tracking NPP/allocation lag The documentation now properly describes the explicit storage pool implementation without making code changes. |
dlebauer
left a comment
There was a problem hiding this comment.
Why are doc updates accompanied by updates to test files?
| We can represent this storage of carbon conceptually as: | ||
| where it acts as a storage pool, and all allocations from the averaged NPP are deducted from that pool. | ||
|
|
||
| Starting in SIPNET v2.1, to support accurate mass balance tracking, this storage is explicitly tracked as a separate pool called $C_{\text{wood,storage}}$ (`plantWoodCStorageDelta` in code). We can represent this storage of carbon as: |
There was a problem hiding this comment.
Remove "accurate". It is implied. Don't add parameter name used in code here, that isn't done elsewhere in this file. The mapping between mathematical symbols and parameter names are in parameters.md. Does the document have sufficient description of the dynamics added in the PR that this PR will be merged into? If needed, make sure it is consistent with the document as a whole and the current state of the code.
There was a problem hiding this comment.
Fixed in 305769d:
- Removed "accurate" qualifier
- Removed code parameter name (
plantWoodCStorageDelta) - Line now reads: "Starting in SIPNET v2.1, to support mass balance tracking, this storage is explicitly tracked as a separate pool called
$C_{\text{wood,storage}}$ ."
The mathematical notation
Co-authored-by: dlebauer <464871+dlebauer@users.noreply.github.com>
The test output files (events.out) were accidentally committed when tests were run during development. Removed in 305769d. Also updated .gitignore to properly exclude generated test outputs (events.out, sipnet.out, sipnet.config) while preserving expected output files. |
|
I updated C_wood,storage description and a few other spots, but also accidentally re-wrapped the model-structure.md file 😬 @dlebauer, please review |
Summary
Per review feedback, this PR now focuses only on documentation updates:
Documentation Changes
model-structure.md:
parameters.md:
CHANGELOG.md:
Code Changes
Test Files
All tests pass.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.