Improve PEcAn.SIPNET documentation and connect to PEcAn book#3705
Improve PEcAn.SIPNET documentation and connect to PEcAn book#3705Eshaan-byte wants to merge 6 commits intoPecanProject:developfrom
Conversation
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
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
models/sipnet/README.md
Outdated
| - 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) |
There was a problem hiding this comment.
@AritraDey-Dev what is the correct URL for the new Demo 1?
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
Co-authored-by: David LeBauer <dlebauer@gmail.com> Co-authored-by: Aritra Dey <155592377+AritraDey-Dev@users.noreply.github.com>
|
|
||
| This is a basic example which shows you how to solve a common problem: | ||
| To use PEcAn.SIPNET, you also need the SIPNET model executable installed on your system. For installation instructions, see: | ||
| - [Installing SIPNET](https://pecanproject.github.io/pecan-documentation/develop/install-models.html#inst-sipnet) |
There was a problem hiding this comment.
This seems circular. Sorry to add more work but it seems that, if anything, that section of the page in the URL should link to the official sipnet install + this README (published as part of the package docs), but not duplicate the information.
|
@Eshaan-byte Is this PR still on your radar? It seems very close -- just one more comment to resolve before merging! |
4 participants
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.