Skip to content

Docs add intro pages#3756

Open
man080107 wants to merge 10 commits intoPecanProject:developfrom
man080107:docs-add-intro-pages
Open

Docs add intro pages#3756
man080107 wants to merge 10 commits intoPecanProject:developfrom
man080107:docs-add-intro-pages

Conversation

@man080107
Copy link
Contributor

Description

Motivation and Context

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.

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
@man080107
Copy link
Contributor Author

"Apologies for the redundant request/commit. I realized I accidentally submitted the same changes twice. Please disregard the duplicate and focus on the latest commit (7bec24b). Thanks!"

This chapter describes the available meteorological drivers supported by
PEcAn and provides guidance on selecting an appropriate dataset.

## Available drivers
Copy link
Member

Choose a reason for hiding this comment

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

This is a small subset of what's available in data.atmosphere. See the download and met2CF functions in https://github.com/PecanProject/pecan/tree/develop/modules/data.atmosphere/R

##### `met`: Meteorological inputs {#xml-run-inputs-met}

(Under construction. See the `PEcAn.data.atmosphere` package, located in `modules/data.atmosphere`, for more details.)
-(Under construction. See the
Copy link
Member

Choose a reason for hiding this comment

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

This system is pretty mature. Unless the "under construction" is meant to refer to the writing of the text I'd drop that bit

man080107 and others added 2 commits January 6, 2026 23:29
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>
@man080107 man080107 requested review from infotroph and mdietze January 8, 2026 07:28
- [ERA5](#era5)
- [PRISM](#prism)

Note: This section highlights a subset of commonly used meteorological
Copy link
Member

Choose a reason for hiding this comment

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

This comment does "future proof" the list a bit, so should be kept, but I was thinking it would be good for you to add more examples

- 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.
@man080107 man080107 requested a review from mdietze January 9, 2026 19:09
@infotroph
Copy link
Member

@man080107 Apologies that I merged #3766 without realizing how much it overlapped with this one -- I've resolved all the outright merge conflicts, but please review and see if there are further changes you want to make.

@mdietze, I think some of your previous comments might be resolved by the newly merged material.

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.

3 participants