diff --git a/CHANGELOG.md b/CHANGELOG.md index 252f298ccb9..00107d04ed1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ For more information about this file see also [Keep a Changelog](http://keepacha ## [Unreleased] ### Fixes + - Fixed status page, should now be run from cronjob, creates static page ### Added @@ -34,10 +35,14 @@ For more information about this file see also [Keep a Changelog](http://keepacha ### Added - New Dockerfile to create PEcAN specific container for SIPNET. +- New Rmd template for basic PEcAn workflow in PEcAn.all package + ### Removed + - Removed `PEcAn.utils::model2netcdf`, which has been deprecated since PEcAn 1.3.7. Use `model2netcdf.` in the appropriate model package instead. ### Changed + - Major namespace cleanup in the `PEcAn.utils` package. It now loads more quietly and is much less likely to mask functions in a package you loaded earlier. - Moved many functions from `PEcAn.utils` into other PEcAn packages. The `PEcAn.utils` versions still work with a deprecation warning, but will be removed in next release. - `listToXml` and `SafeList` moved to `PEcAn.settings` @@ -47,6 +52,7 @@ For more information about this file see also [Keep a Changelog](http://keepacha ## [1.5.1] - 2017-10-05 ### Fixes + - Fixed hyperparameter draws in PDA - Show workflowid in the URL when run is finshed and user clicks results (#1659) - `PEcAn.BIOCRO` now uses PEcAn-standard variable names. As a result, two output variables have been renamed but keep their existing units and definitions: @@ -70,6 +76,7 @@ For more information about this file see also [Keep a Changelog](http://keepacha - PRELES model run script bug fix ### Added + - Functionality to pass hyperparameters via settings - Created new (and very rudimentary) web interface for downloading data from the dataone federation into the PEcAn database. More updates to come. - Expanded initial conditions workflow for pool-based models, including PEcAn.data.land::prepare_pools to calculate pools from IC file (to be coupled with write.configs) @@ -85,6 +92,7 @@ For more information about this file see also [Keep a Changelog](http://keepacha - A Pre-release database clean up script that deletes unused/unassosiated entries from the database ### Changed + - Clean up directory structure: * Move `base` packages (`utils`, `settings`, `db`, `visualizaton`) to a `base` directory, for consistency with `modules` and `models` * Move `logger.*` functions out of the `PEcAn.utils` package and into the `PEcAn.logger` package @@ -96,7 +104,9 @@ For more information about this file see also [Keep a Changelog](http://keepacha ## [1.5.0] - 2017-07-13 + ### Added + - Added cron job and script for the sync of the database. - Added PEcAn.utils::download.file() to allow for use of alternative FTP programs - Updated downloadAmeriflux and downloadNARR to make use of PEcAn.utils::download.file() @@ -109,12 +119,14 @@ For more information about this file see also [Keep a Changelog](http://keepacha - Added initial conditions file io functions for pool-based models in data.land ### Changed + - upscale_met now accepts ~any valid CF file (not just full years), retains correct time units, and respects the previously ignored `overwrite` parameter - Better date handling in BioCro functions ## [1.4.10.1] - 2017-04-18 ### Changed + - Bugfix in Fluxnet2015 - Update Git workflow in Documentation - download.CRUNCEP now uses CF-compliant time units (days since start of year instead of "secs") @@ -122,30 +134,39 @@ For more information about this file see also [Keep a Changelog](http://keepacha ## [1.4.10] - 2017-03-27 + Documentation ### Added + - Source Rmarkdown and deploy scripts for PEcAn documentation - Autocorrelation correction in PDA and scaling factor in emulator ### Changed + - now dumping/loading experiments, cultivars_pfts, current_posteriors, experiments_sites experiments_treatments, trait_covariate_associations [BETY #403](https://github.com/PecanProject/bety/issues/403) [BETY #491](https://github.com/PecanProject/bety/issues/491) ### Removed + - Ameriflux is no longer selectable from the web gui [#1291](https://github.com/PecanProject/pecan/issues/1291) ## [1.4.9] - 2016-12-10 + Benchmarking, code cleanup ### Added + - benchmarking code ### Changed + - no more build.sh, using Makefile - Lots of code cleanup thanks to @bpbond ## [1.4.8] - 2016-08-11 + Camp PEON: Assimilation, multi-site, soil params, Maespa, LPJ-GUESS, improvements to web & tutorials ## [1.4.7] - 2016-07-13 + CMIP5, Shiny, FLUXNET2015, Global Sensitivity diff --git a/base/all/inst/rmarkdown/templates/pecan_workflow/skeleton/skeleton.Rmd b/base/all/inst/rmarkdown/templates/pecan_workflow/skeleton/skeleton.Rmd new file mode 100644 index 00000000000..0421ac333fd --- /dev/null +++ b/base/all/inst/rmarkdown/templates/pecan_workflow/skeleton/skeleton.Rmd @@ -0,0 +1,61 @@ +--- +title: "PEcAn Workflow" +author: "PEcAn User" +date: '`r format(Sys.Date(), "%B %d, %Y")`' +output: html_document +--- + +# Load PEcAn packages + +```{r, echo=FALSE,warning=FALSE} +# .libPaths("/path/to/stable/build") + +library(PEcAn.all) +``` + +# Load PEcAn settings files. + +Open and read in settings file for PEcAn run. + +To create a pecan.xml, you can download one genrated in the PEcAn web interface or one of the `pecan..xml` files in the tests/ directory of the PEcAn repository (github.com/pecanproject/pecan). + +```{r read.settings} +settings <- PEcAn.settings::read.settings("pecan.xml") +``` + +# Meta Analysis + + +```{r meta-analysis} + +settings <- runModule.get.trait.data(settings) +runModule.run.meta.analysis(settings) + +``` + +# Write Configuration Files + +```{r run.write.configs} +settings <- runModule.run.write.configs(settings) + +``` + +# Run Model and Retrieve Results + +```{r run-model} + +runModule.start.model.runs(settings) +runModule.get.results(settings) + +``` + +# Model Analyses + +These are a few core analyses; many others exist. + +```{r model-analysis} +run.sensitivity.analysis() # Run sensitivity analysis and variance decomposition on model output +run.ensemble.analysis() # Run ensemble analysis on model output. +run.ensemble.analysis(plot.timeseries=TRUE) + +``` diff --git a/base/all/inst/rmarkdown/templates/pecan_workflow/template.yaml b/base/all/inst/rmarkdown/templates/pecan_workflow/template.yaml new file mode 100644 index 00000000000..f4fc332e97b --- /dev/null +++ b/base/all/inst/rmarkdown/templates/pecan_workflow/template.yaml @@ -0,0 +1 @@ +name: PEcAn Workflow diff --git a/book_source/adv_user_guide_cmd/replicate_run_cmd.Rmd b/book_source/adv_user_guide_cmd/replicate_run_cmd.Rmd index 8b3de8e809a..78b53059ae4 100644 --- a/book_source/adv_user_guide_cmd/replicate_run_cmd.Rmd +++ b/book_source/adv_user_guide_cmd/replicate_run_cmd.Rmd @@ -1 +1,9 @@ -# Run PEcAn from COmmand Line \ No newline at end of file +# Run PEcAn from Command Line + +## PEcAn workflow template + +File --> new file --> Rmarkdown --> From Template + +Choose the PEcAn workflow template. + +The template will guide you through the steps to reproducing a run generated in the PEcAn Web Interface, starting with the pecan.xml file that you can download from . \ No newline at end of file