镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

docs: Update SIPNET tutorials for Russell Ranch - #4192

Open
tyagivibhor111-hub wants to merge 2 commits into
PecanProject:sipnet-2-tutorialfrom
tyagivibhor111-hub:feat/russell-ranch-sipnet-demos
Open

tyagivibhor111-hub wants to merge 2 commits into
PecanProject:sipnet-2-tutorialfrom
tyagivibhor111-hub:feat/russell-ranch-sipnet-demos

Conversation

@tyagivibhor111-hub

Copy link
Copy Markdown
Contributor

Docs: Update SIPNET tutorials for Russell Ranch

Description

  • Update Demo 1 and Demo 2 to use the Russell Ranch example with SIPNET v2.2.0.
  • Add the Russell Ranch climate (sipnet.clim) and event (events.in) input files to Demo 1.
  • Update both pecan.xml configurations for the 2016–2017 simulation period and use the shared inputs in Demo 2.
  • Revise both tutorial notebooks to describe the new setup and simulation scenario.

Motivation and Context

The existing tutorials use SIPNET v1.3.0 and the Niwot Ridge 2004 scenario. These changes update the examples to use the Russell Ranch inputs and SIPNET v2.2.0, keeping the two tutorial configurations consistent.

This PR covers Part 2 of #4184 and complements the shared downloader work in #4189.

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff.
  • I agree that PEcAn Project may distribute my contribution under any or all of the same license as the existing code and/or the BSD 3-clause license.
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@tyagivibhor111-hub

Copy link
Copy Markdown
Contributor Author

Hey @dlebauer and @S1DDHEY, could you please review this PR when you have time?

I've updated both Demo 1 and Demo 2 for the Russell Ranch example, added the SIPNET v2.2.0 climate and event inputs, and updated the configurations and notebook instructions for the 2016–2017 simulation period. I've also kept the shared downloader changes separate from Madhav's Part 1 PR #4189.

If you notice any issues, have concerns about the approach, or think anything needs to be changed, please let me know. I'll address the feedback and make the necessary updates.

@S1DDHEY S1DDHEY left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The Russell Ranch climate and event inputs have been added, but both pecan.xml files still reference the existing temperate.coniferous prior distributions. Since #4184 says these priors should not be carried over, could we confirm the appropriate Russell Ranch teaching priors before merging?

@dlebauer @mdietze @infotroph @divine7022 , guidance on a suitable prior set would be appreciated.

@S1DDHEY

S1DDHEY commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

Since this is the Part 2 follow-up to #4189, it would be better if this one gets rebased once #4189 get merged. This will avoid duplicating doc edits.

@dlebauer

Copy link
Copy Markdown
Member

I'll defer to @divine7022 for priors.

re

it would be better if this one gets rebased once #4189 get merged

Not strictly necessary but an alternative is to point this PR at the 4189 branch. Then this one can merge before or after the other one (if merged after, the target branch will automatically update to develop).

@tyagivibhor111-hub

Copy link
Copy Markdown
Contributor Author

I'll defer to @divine7022 for priors.

re

it would be better if this one gets rebased once #4189 get merged

Not strictly necessary but an alternative is to point this PR at the 4189 branch. Then this one can merge before or after the other one (if merged after, the target branch will automatically update to develop).

Thanks, @dlebauer. I’ll wait for @divine7022’s guidance on the priors.

@dlebauer
dlebauer changed the base branch from develop to sipnet-2-tutorial November 3, 2026 03:27
@madhavzanwar

Copy link
Copy Markdown
Contributor

Thanks for putting this together. I read through the diff ( and tested one thing against develop’s write.config.SIPNET():

1.Site lat/lon: both pecan.xml files now have with only . Without lat/lon the generated job.sh contains the literal model2netcdf.SIPNET('…', @SITE_LAT@, @SITE_LON@, …) (with lat/lon given it expands to numbers), which isn’t valid R, so the output conversion step would fail when there is no database to fill them in. Adding / for Russell Ranch (from the SIPNET smoke-test inputs) should fix it.
2.Wording: the notebooks tell readers to “ensure the download script has been updated” to v2.2.0. Since #4189 is merged into this branch, that can just say the notebook downloads v2.2.0.
3.Provenance: a short note on where inputs/sipnet.clim and inputs/events.in come from (SIPNET release/path) and what the site is (location, management) would help readers.
4.I agree with @S1DDHEY’s point about the temperate.coniferous priors, including in the Demo 2 text.

@tyagivibhor111-hub

Copy link
Copy Markdown
Contributor Author

@dlebauer @infotroph @divine7022

Based on @madhavzanwar's review, I propose the following changes:

  1. Add Russell Ranch latitude and longitude to both pecan.xml files.
  2. Update the notebook instructions to reflect the SIPNET v2.2.0 downloader.
  3. Add a short note explaining the source of the climate and event input files.
  4. Review and replace the existing temperate.coniferous priors with suitable priors for the Russell Ranch example.

I think these changes will improve the reliability and clarity of both demos.
Does this approach look good to you? Also, are there any other changes you'd like me to make in the existing PR or its implementation before I proceed?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants