Docs add intro pages #3756
Docs add intro pages #3756
Conversation
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
|
"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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
This system is pretty mature. Unless the "under construction" is meant to refer to the writing of the text I'd drop that bit
| -(Under construction. See the | ||
| -[`PEcAn.data.atmosphere` package documentation](https://pecanproject.github.io/package-documentation/develop/PEcAn.data.atmosphere/) | ||
| for more details.) | ||
|
|
There was a problem hiding this comment.
Similarly, the soil inputs (next section) isn't really experimental any more. I suspect there is also documentation that's completely missing for phenology and management, and a need to completely rewrite the initial conditions section
There was a problem hiding this comment.
I'd retain the "See the
-PEcAn.data.atmosphere package documentation
for more details." but agree that it would be good to add the additional info of the download and met2CF functions as being the ones to pay attention to.
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 <[email protected]>
|
|
||
| This chapter describes the available meteorological drivers supported by | ||
| PEcAn and provides guidance on selecting an appropriate dataset. | ||
| This chapter describes commonly used meteorological drivers supported by PEcAn and provides guidance on selecting an appropriate dataset. |
There was a problem hiding this comment.
Fixed width was deliberate. I'd recommend reverting
| - [ERA5](#era5) | ||
| - [PRISM](#prism) | ||
|
|
||
| Note: This section highlights a subset of commonly used meteorological |
There was a problem hiding this comment.
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
| -(Under construction. See the | ||
| -[`PEcAn.data.atmosphere` package documentation](https://pecanproject.github.io/package-documentation/develop/PEcAn.data.atmosphere/) | ||
| for more details.) | ||
|
|
There was a problem hiding this comment.
I'd retain the "See the
-PEcAn.data.atmosphere package documentation
for more details." but agree that it would be good to add the additional info of the download and met2CF functions as being the ones to pay attention to.
| (Under construction. See the `PEcAn.data.land` package, located in `modules/data.land`, for more details). | ||
| ##### `soil`: Soil inputs {#xml-run-inputs-soil} | ||
| Soil inputs are handled through the `PEcAn.data.land` module. | ||
| (See the `PEcAn.data.land` package, located in `modules/data.land`, for more details). |
There was a problem hiding this comment.
Similar to the previous comment, would be good to also provide a direct link to the package documentation. I also think for the pecan.xml section in particular that it would be good to provide more info about what the valid elements are, especially as there's a lot in data.land that has nothing to do with soils. For example, while there is in theory automated "soil_process" functionality (analogous to met.process), in practice there are only two soil data products in current use, gSSURGO and SoilGrids, and most users preprocess their soil data so that PEcAn standard soil.nc files are the primary thing put into most pecan.xml
It might also be worth mentioning that some models are using <soil> as the tag and others are using <soilphysics> -- would be good to open an issue to harmonize this, as this sort of accidental drift causes unnecessary confusion & bugs
| ## Documentation | ||
|
|
||
| * [Package Documentation](../../../../package-documentation/PEcAn.DB/reference/index.html) | ||
| * [Package Documentation](https://pecanproject.github.io/package-documentation/develop/data.atmosphere/index.html) |
There was a problem hiding this comment.
I can't remember where @infotroph landed on preferred method of specifying doc paths
| (See the `PEcAn.data.land` package, located in `modules/data.land`, for more details). | ||
|
|
||
| ##### (Experimental) `veg`: Vegetation initial conditions {#xml-run-inputs-veg} | ||
| ##### `veg`: Vegetation initial conditions {#xml-run-inputs-veg} |
There was a problem hiding this comment.
please add phenology and management after poolinitcond
3 participants
Description
Motivation and Context
Review Time Estimate
Types of changes
Checklist: