Improve PEcAn.SIPNET documentation and connect to PEcAn book #3705
+89
−71
Conversation
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
Enhanced README with model description and integration details, updated book pages with proper metadata and current installation instructions, and connected all SIPNET documentation resources. Addresses PecanProject#3703
dlebauer
requested changes
Dec 7, 2025
Member
dlebauer
left a comment
dlebauer
left a comment
There was a problem hiding this comment.
This looks great, thanks for your contributions!
I updated the wording in a few sections.
Have you checked that the documentation builds and renders correctly with make document?
The key remaining task from #3703 is to document the process for creating a model package README. I recommend that step be separated into a subtask of #3703.
book_source/03_topical_pages/93_installation/03_install_OS/06_install_models/install_SIPNET.Rmd
Outdated
Show resolved
Hide resolved
| - Converts PEcAn-standard inputs to SIPNET format | ||
| - Manages SIPNET model configuration and execution | ||
| - Processes SIPNET outputs back to PEcAn standards | ||
| - Enables data assimilation, sensitivity analysis, and ensemble runs |
Member
There was a problem hiding this comment.
Suggested change
| - Enables data assimilation, sensitivity analysis, and ensemble runs | |
| - Enables data assimilation, sensitivity analysis, and ensemble runs within the PEcAn modeling framework |
| - Enables data assimilation, sensitivity analysis, and ensemble runs | ||
|
|
||
| **Getting Started:** | ||
| - [Demo 1: Basic PEcAn Run](https://pecanproject.github.io/pecan-documentation/develop/basic-users-guide.html) |
Member
There was a problem hiding this comment.
@AritraDey-Dev what is the correct URL for the new Demo 1?
Member
There was a problem hiding this comment.
book_source/03_topical_pages/93_installation/03_install_OS/06_install_models/install_SIPNET.Rmd
Outdated
Show resolved
Hide resolved
AritraDey-Dev
suggested changes
Dec 7, 2025
| ## Learn More | ||
|
|
||
| - **PEcAn Project:** https://pecanproject.github.io | ||
| - **Tutorials:** https://pecanproject.github.io/tutorials.html |
Member
There was a problem hiding this comment.
Suggested change
| - **Tutorials:** https://pecanproject.github.io/tutorials.html | |
| - **Tutorials:** https://pecanproject.github.io/tutorials/ |
| - Enables data assimilation, sensitivity analysis, and ensemble runs | ||
|
|
||
| **Getting Started:** | ||
| - [Demo 1: Basic PEcAn Run](https://pecanproject.github.io/pecan-documentation/develop/basic-users-guide.html) |
Member
There was a problem hiding this comment.
Suggested change
| - [Demo 1: Basic PEcAn Run](https://pecanproject.github.io/pecan-documentation/develop/basic-users-guide.html) | |
| - [Demo 1: Basic PEcAn Run](https://pecanproject.github.io/pecan-documentation/develop/rendered-demo-notebooks/run_pecan.html) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR addresses #3703 by consolidating and improving SIPNET model documentation across the PEcAn project, completing Task 1 from the issue.
Changes Made
1. Enhanced PEcAn.SIPNET README (
models/sipnet/README.md)2. Updated PEcAn Book SIPNET Page (
book_source/03_topical_pages/05_models/sipnet.Rmd)3. Modernized Installation Instructions (
install_SIPNET.Rmd)4. Updated Project Files
NEWS.md(PEcAn.SIPNET package)CHANGELOG.md(project-wide)Testing
The documentation changes have been reviewed for:
Next Steps
This PR completes Task 1 from #3703. Remaining tasks include:
I'm happy to address any feedback and make additional improvements as needed.