[185] Update N cycle documentation#342
Open
Sanketmandwal wants to merge 2 commits into
Open
Conversation
Sanketmandwal
requested review from
Alomir,
dlebauer,
mdietze and
mswilburn
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates nitrogen-cycle documentation to reflect a single mineral nitrogen pool and clarifies volatilization/leaching parameter definitions and equations.
Changes:
- Renames initial mineral N state symbol to a single shared
$N_{\text{min},0}$ pool. - Rewrites nitrogen volatilization and leaching documentation (including justification and updated leaching scaling).
- Adjusts temperature-response equation formatting and clarifies moisture-fraction wording.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/parameters.md | Updates parameter table entries and nitrogen-cycle parameter definitions/units to match revised model description. |
| docs/model-structure.md | Updates nitrogen volatilization/leaching sections to reflect single |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+205
to
+208
| | Symbol | Parameter Name | Definition | Units | Notes | | ||
| | ---------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | -------------------------------- | | ||
| | $K_\text{vol}$ | nVolatilizationFrac | Nitrogen volatilization rate constant that determines the maximum rate of N volatilization as a proportion of available $N_\text{min}$ | $\text{day}^{-1}$ | \eqref{eq:n_vol} | | ||
| | $f^N_{\text{leach}}$ | nLeachingFrac | Fraction of $N_\text{min}$ available to be leached, applied after scaling by $\phi = \min(F^W_\text{drainage}/W_\text{WHC}, 1)$ | unitless | \eqref{eq:n_leach} | |
|
|
||
| \begin{equation} | ||
| F^N_\text{leach} = N_\text{min} \cdot F^W_{drainage} \cdot f_{N leach} | ||
| F^N_\text{leach} = N_\text{min} \cdot \phi \cdot f_{N leach} |
Comment on lines
+599
to
+605
| where: | ||
|
|
||
| \begin{equation} | ||
| \phi = \min\left(\frac{F^W_\text{drainage}}{W_\text{WHC}}, 1\right) | ||
| \end{equation} | ||
|
|
||
| $f^N_\text{leach}$ is the fraction of $N_\text{min}$ available to be leached, $F^W_\text{drainage}$ is drainage, and |
| mineral nitrogen pool. The realized volatilization flux is proportional to $N_\text{min}$ and depends on temperature and | ||
| soil moisture. | ||
| $K_\text{vol}$ is the nitrogen volatilization rate constant that determines the maximum rate of N volatilization as a | ||
| proportion of available $N_\text{min}$. The realized volatilization flux is proportional to available Nmin through Kvol and depends on temperature and soil moisture. |
Comment on lines
+915
to
+917
| \[ | ||
| D_{\text{temp,Q10}} = Q_{10}^{\frac{(T-T_\text{opt})}{10}} | ||
| \label{eq:Braswell_A18b} | ||
| \end{equation} | ||
| \] |
Author
|
Hello @dlebauer sir , I have made changes. Can you please review it once ? Tell me if any correction is there. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
What: Updated nitrogen cycle documentation in
docs/model-structure.mdanddocs/parameters.mdto reflect the implemented N-cycle behavior.Changes include:
K_volto Nitrogen Cycle ParametersfN2O_volfNLeachF^N_leach = N_min · φ · fN_leachφ = min(F^W_drainage / W_WHC, 1)minNpool while preserving separate soil and litter mineralization fluxesMotivation: The documentation did not fully match the implemented nitrogen cycle behavior and parameter definitions. This update aligns the documentation with the current implementation and removes outdated or redundant descriptions.
How was this change tested?
Verified documentation builds successfully.
Manually reviewed rendered pages for:
Reviewed
git diffto confirm changes are limited to intended documentation updates.No smoke tests or code execution changes were required since this PR only updates documentation.
Reproduction steps
Related issues
Checklist