Skip to content

Conversation

@S1DDHEY
Copy link

@S1DDHEY S1DDHEY commented Dec 25, 2025

Summary

fixes #3731
This PR clarifies a missing dependency in the run_pecan.qmd tutorial by documenting the requirement for the PEcAn.SIPNET package

Changes

  • Added an inline note in the Write Model Configuration Files section explaining that PEcAn.SIPNET is required for the this demo
  • Included the installation command for PEcAn.SIPNET as inline documentation (without adding it as an executable code chunk)

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.


- A valid `pecan.xml` configuration file or use the example provided: `pecan/documentation/tutorials/Demo_1_Basic_Run/pecan.xml`

- Some steps in this notebook are model-specific and require the corresponding PEcAn model package to be installed (e.g. `PEcAn.SIPNET` when using the SIPNET model, which can be installed by running: `install.packages('PEcAn.SIPNET')`).
Copy link
Member

Choose a reason for hiding this comment

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

This note won't be needed at all if you edit line 62 above to be install.packages(c("PEcAn.all", "PEcAn.SIPNET"))

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.

run_pecan.qmd uses write.config.SIPNET function without documenting installation of PEcAn.SIPNET

3 participants