Skip to content

Update events.out, sipnet.out, and irrigation / water balance documentation #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open

Update events.out, sipnet.out, and irrigation / water balance documentation #152

wants to merge 23 commits into from

Conversation

dlebauer
Copy link
Member

@dlebauer dlebauer commented Aug 28, 2025 •
edited
Loading

This PR updates documentation, inspired by PR #148

  • Revised description of events.in; updated and expanded details about irrigation
  • Updated sipnet.out documentation:
    • remove obsolete params (fPAR, litterWater)
    • added missing terms and improved definitions
  • Added equations to define irrigation events and interception.
  • Refactored water balance section, including addition of equations for evapotranspiration (and its components, E and T)

Please review these sections - I've attached the rendered html versions for reference; especially helpful for eqns in model-description.md
doc_updates.zip

parameters.md|html:

  • Model Outputs
  • Irrigation

model-description.md|html

  • Water Balance
  • Evapotranspiration
  • Irrigation

@dlebauer dlebauer requested a review from Alomir August 28, 2025 18:33
@dlebauer dlebauer changed the title Update documentation Update events.out, sipnet.out, and irrigation / water balance documentation Aug 28, 2025
@dlebauer dlebauer added the documentation Improvements or additions to documentation label Aug 28, 2025
Base automatically changed from SIP147-retool-events-as-fluxes to master August 28, 2025 21:24
dlebauer
dlebauer commented Aug 28, 2025
View reviewed changes
infotroph
infotroph approved these changes Sep 17, 2025
View reviewed changes
Copy link
Member

@infotroph infotroph left a comment

Choose a reason for hiding this comment

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

This looks good to me, with disclaimer that I did not cross-reference it against current code. @dlebauer are there any parts you'd like me to check more carefully?

infotroph
infotroph reviewed Sep 30, 2025
View reviewed changes
docs/user-guide/model-inputs.md
Comment on lines +177 to +179
| fraction of belowground biomass removed | 6 | N | default = 0 |
| fraction of aboveground biomass transferred to litter pool | 7 | N | default = 1 - removed |
| fraction of belowground biomass transferred to litter pool | 8 | N | default = 1 - removed |
Copy link
Member

Choose a reason for hiding this comment

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

If I'm interpreting the current code right these are all required at the moment. Is there a plan to change this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@infotroph infotroph infotroph approved these changes

@Alomir Alomir Awaiting requested review from Alomir

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dlebauer @infotroph @Alomir