Skip to content

#309 Clarify soil water fraction notation in documentation#321

Open
ayushman1210 wants to merge 8 commits intoPecanProject:masterfrom
ayushman1210:fix/309
Open

#309 Clarify soil water fraction notation in documentation#321
ayushman1210 wants to merge 8 commits intoPecanProject:masterfrom
ayushman1210:fix/309

Conversation

@ayushman1210
Copy link
Copy Markdown
Contributor

Summary

  • What: Updated mathematical notation for "soil water fraction" across parameter documentation and model structure descriptions to clarify unclipped and clipped variants.
  • Motivation: Addresses confusion regarding the overloaded term "soil water content fraction", distinguishing between the absolute soil water content ($W_{\text{soil}}$), the unbounded fraction ($f_{\text{WHC}}$), and the internally clipped fraction used for dependency functions ($f_{\text{WHC}^*}$).

How was this change tested?

This is a documentation-only change. No code, configuration files, or model logic was modified, so existing tests are unaffected.

Reproduction steps

N/A

Related issues

Checklist

  • Related issues are listed above. PRs without an approved, related issue may not get reviewed.
  • PR title has the issue number in it ("[#] <concise description of proposed change>")
  • Tests added/updated for new features (if applicable)
  • Documentation updated (if applicable)
  • docs/CHANGELOG.md updated with noteworthy changes
  • Code formatted with clang-format (run git clang-format if needed)

@ayushman1210 ayushman1210 changed the title Fix/309 #309 Clarify soil water fraction notation in documentation Apr 20, 2026
Copy link
Copy Markdown
Collaborator

@Alomir Alomir left a comment

Choose a reason for hiding this comment

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

I'm marking this as 'requested changes' pending @dlebauer's thoughts on proposed changes.

Comment thread docs/CHANGELOG.md Outdated
Comment thread docs/parameters.md Outdated
Comment thread docs/parameters.md Outdated
Comment thread docs/model-structure.md Outdated
Comment thread docs/model-structure.md Outdated
Comment thread docs/model-structure.md Outdated
Co-authored-by: Mike Longfritz <Mike.Longfritz@gmail.com>
@dlebauer
Copy link
Copy Markdown
Member

👍 I agree with the proposed changes.

@ayushman1210 ayushman1210 requested a review from Alomir April 27, 2026 10:31
@ayushman1210
Copy link
Copy Markdown
Contributor Author

hey @Alomir @dlebauer please review this pr when you have some free time
thanks !!

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.

Clarify soil water fraction notation in documentation

3 participants