-
Notifications
You must be signed in to change notification settings - Fork 282
Improve PEcAn.SIPNET documentation and connect to PEcAn book #3705
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.
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
base: develop
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,22 @@ | ||
| #### SIPNET {inst-sipnet} | ||
| #### SIPNET {#inst-sipnet} | ||
|
|
||
| You can download a compiled binary from the [SIPNET releases page](https://github.com/PecanProject/sipnet/releases). | ||
|
|
||
| You can also install SIPNET is from the repository: | ||
|
|
||
|
|
||
| ```bash | ||
| cd | ||
| curl -o sipnet_unk.tar.gz http://isda.ncsa.illinois.edu/~kooper/EBI/sipnet_unk.tar.gz | ||
| tar zxf sipnet_unk.tar.gz | ||
| rm sipnet_unk.tar.gz | ||
| # Clone the SIPNET repository | ||
| git clone https://github.com/PecanProject/sipnet.git | ||
| cd sipnet | ||
|
|
||
| cd sipnet_unk | ||
| # Build SIPNET | ||
| make | ||
| sudo cp sipnet /usr/local/bin/sipnet.runk | ||
|
|
||
| # Install the executable (optional - adjust path as needed) | ||
| sudo cp sipnet /usr/local/bin/sipnet | ||
| ``` | ||
|
|
||
| ##### SIPNET testrun | ||
| For detailed installation instructions, build options, and dependencies, please see the [SIPNET Installation Guide](https://pecanproject.github.io/sipnet/install.html). | ||
|
|
||
| ```bash | ||
| cd | ||
| curl -o testrun.sipnet.tar.gz http://isda.ncsa.illinois.edu/~kooper/EBI/testrun.sipnet.tar.gz | ||
| tar zxf testrun.sipnet.tar.gz | ||
| rm testrun.sipnet.tar.gz | ||
| cd testrun.sipnet | ||
| sipnet.runk | ||
| ``` | ||
| **Note:** Previous installation methods using tarballs (`sipnet_unk.tar.gz`, `sipnet_r136.tar.gz`) are deprecated. Please use the repository method above for the most up-to-date version. All previous tagged releases are available as source code and compiled binaries from the SIPNET releases page. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,18 +2,45 @@ | |||||
|
|
||||||
| <!-- badges: start --> | ||||||
|
|
||||||
| [](https://lifecycle.r-lib.org/articles/stages.html#experimental) | ||||||
| [](https://lifecycle.r-lib.org/articles/stages.html#experimental) | ||||||
| [](https://pecanproject.r-universe.dev/PEcAn.SIPNET) | ||||||
|
|
||||||
| <!-- badges: end --> | ||||||
|
|
||||||
| PEcAn Functions Used for Ecological Forecasts and Reanalysis | ||||||
| ## What is SIPNET? | ||||||
|
|
||||||
| The SIPNET v1 (**S**implified PnET (**P**hotosynthesis** and **E**vapo**t**ranspiration)) model is a lightweight ecosystem model designed to simulate ecosystem carbon and water dynamics. | ||||||
|
|
||||||
| SIPNET v2 added a nitrogen cycle, trace greenhouse-gas (N₂O, CH₄) fluxes, and support for cropland and ecosystem management. As of PEcAn v1.10, support for SIPNET v2 is partially implemented and under active development. | ||||||
|
|
||||||
| **Key Features:** | ||||||
| - Simulates photosynthesis, respiration, allocation, soil water, soil temperature, and nitrogen cycling | ||||||
| - Operates on sub-daily time steps | ||||||
| - Tracks vegetation, litter, soil, and mineral-N pools | ||||||
| - Event-based management for agricultural processes (planting, harvest, tillage, irrigation) | ||||||
| - Clean, modular, BSD-licensed codebase suitable for research and production | ||||||
|
|
||||||
| For comprehensive SIPNET documentation, see the [SIPNET project website](https://pecanproject.github.io/sipnet). | ||||||
|
|
||||||
| ## Using SIPNET via PEcAn | ||||||
|
|
||||||
| PEcAn.SIPNET is the PEcAn interface package that enables SIPNET integration with the PEcAn workflow system. This package: | ||||||
| - Converts PEcAn-standard inputs to SIPNET format | ||||||
| - Manages SIPNET model configuration and execution | ||||||
| - Converts SIPNET outputs to netCDF in PEcAn standard format | ||||||
| - 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @AritraDey-Dev what is the correct URL for the new Demo 1?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - [SIPNET in the PEcAn Book](https://pecanproject.github.io/pecan-documentation/develop/models-sipnet.html) | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| You can install the development version of `PEcAn.SIPNET` from r-universe like so: | ||||||
| ### Install PEcAn.SIPNET Package | ||||||
|
|
||||||
| You can install the development version of `PEcAn.SIPNET` from r-universe: | ||||||
|
|
||||||
| ``` r | ||||||
| ```r | ||||||
| # Enable repository from pecanproject | ||||||
| options(repos = c( | ||||||
| pecanproject = 'https://pecanproject.r-universe.dev', | ||||||
|
|
@@ -22,18 +49,28 @@ options(repos = c( | |||||
| install.packages('PEcAn.SIPNET') | ||||||
| ``` | ||||||
|
|
||||||
| Or you can install directly from GitHub with the remotes package like so: | ||||||
| Or install directly from GitHub: | ||||||
|
|
||||||
| ``` r | ||||||
| ```r | ||||||
| library(remotes) | ||||||
| install_github('pecanproject/pecan', subdir = "models/sipnet") | ||||||
| install_github('pecanproject/pecan', subdir = "models/sipnet") | ||||||
| ``` | ||||||
|
|
||||||
| ## Example | ||||||
| ### Install SIPNET Model | ||||||
|
|
||||||
| 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) | ||||||
| - [SIPNET Installation Guide](https://pecanproject.github.io/sipnet/install.html) | ||||||
|
|
||||||
| ``` r | ||||||
| library(PEcAn.SIPNET) | ||||||
| ## basic example code | ||||||
| ``` | ||||||
| ## Documentation | ||||||
|
|
||||||
| - **PEcAn.SIPNET Package Docs:** https://pecanproject.github.io/package-documentation/develop/PEcAn.SIPNET/ | ||||||
| - **SIPNET Model Docs:** https://pecanproject.github.io/sipnet | ||||||
| - **PEcAn Book - SIPNET Chapter:** https://pecanproject.github.io/pecan-documentation/develop/models-sipnet.html | ||||||
| - **Source Code:** https://github.com/PecanProject/pecan/tree/develop/models/sipnet | ||||||
|
|
||||||
| ## Learn More | ||||||
|
|
||||||
| - **PEcAn Project:** https://pecanproject.github.io | ||||||
| - **Tutorials:** https://pecanproject.github.io/tutorials.html | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **SIPNET Repository:** https://github.com/PecanProject/sipnet | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.