Docs update model install instructions #3769
Open
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
This PR replaces plain-text references to PEcAn functions and packages in the book with hyperlinks to the existing pkgdown documentation. The goal is to keep the book focused on concepts and workflows while directing readers to pkgdown for detailed API references. Changes are limited to documentation only and do not affect code execution. Fixes PecanProject#3745
Removed the duplicate 'Example meteorological drivers' list in 02_pecan_standards.Rmd to clean up the introductory content and avoid repetition.
Co-authored-by: Chris Black <chris@ckblack.org>
- Add list of available meteorological drivers to meteorology page - Clarify BETY, soil, and vegetation input sections in pecan.xml documentation - Remove redundant introductory text from standards page - Improve cross-referencing between documentation sections
…ecan into docs-add-intro-pages # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
infotroph
reviewed
Feb 12, 2026
Member
infotroph
left a comment
infotroph
left a comment
There was a problem hiding this comment.
Apparently I started reviewing this some time ago and never posted my comments. I think this is a solid improvement that needs a bit more iteration -- see my inline comments for details.
| ##### (Experimental) `veg`: Vegetation initial conditions {#xml-run-inputs-veg} | ||
| Soil inputs are handled through the `PEcAn.data.land` module. | ||
| For full technical details, see the | ||
| [PEcAn.data.land package documentation](https://pecan.ncsa.illinois.edu/pkgdocs/PEcAn.data.land/). |
Member
There was a problem hiding this comment.
Suggested change
| [PEcAn.data.land package documentation](https://pecan.ncsa.illinois.edu/pkgdocs/PEcAn.data.land/). | |
| [PEcAn.data.land package documentation](https://pecanproject.github.io/package-documentation/develop/PEcAn.data.land/). |
| processing. | ||
|
|
||
| Note that some models reference soil inputs using the `<soil>` tag, | ||
| while others use `<soilphysics>`. This inconsistency is historical and |
Member
There was a problem hiding this comment.
Funny story, I wasted an hour earlier this month finding the place I made this exact typo in a model run 🙈
Suggested change
| while others use `<soilphysics>`. This inconsistency is historical and | |
| while others use `<soil_physics>`. This inconsistency is historical and |
Comment on lines
429
to
433
| See the `PEcAn.data.atmosphere` package documentation for more details. | ||
| In particular, users working with meteorological inputs should focus on | ||
| the data download functions and the `met2CF` conversion utilities, which | ||
| handle retrieval of raw meteorological products and conversion to | ||
| CF-compliant NetCDF files used by PEcAn. |
Member
There was a problem hiding this comment.
This is good advice for people who want to understand the met conversion system, but not very useful to this page's intended use as a guide to the tags used in a pecan XML file.
Expanded the section on meteorological inputs to include details about the <met> tag and its sub-tags, along with an example XML structure.
Contributor
Author
|
Thank you for the thoughtful review and the inline comments. I’m glad to hear this is a solid improvement. I’ll address the suggested changes and push an updated version shortly.. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
Motivation and Context
Review Time Estimate
Types of changes
Checklist:
#Fixes #3741