Added description of package (as in paper) to README and vignette

cvitolo · Dec 18, 2016 · 0222863 · 0222863
1 parent 7527c64
commit 0222863
Show file tree

Hide file tree

Showing 25 changed files with 191 additions and 8 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -24,7 +24,9 @@ knitr::opts_chunk$set(
 [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/cvitolo/fuse?branch=master&svg=true)](https://ci.appveyor.com/project/cvitolo/fuse)
 [![codecov.io](https://codecov.io/github/cvitolo/fuse/coverage.svg?branch=master)](https://codecov.io/github/cvitolo/fuse?branch=master)
 
-Implementation of the framework for hydrological modelling FUSE described in Clark et al. (2008) and based on the Fortran code provided by M. Clark in 2011. The package consists of two modules: Soil Moisture Accounting module (fusesma.sim) and Gamma routing module (fuserouting.sim). It also contains default parameter ranges (fusesma.ranges and fuserouting.ranges) and three data objects: fuse_hydrological_timeseries (sample input dataset), parameters (sample parameters) and modlist (list of FUSE model structures).
+The fuse modelling framework takes as input rainfall and potential evapotranspiration time series (areal averages over the river catchment area) and returns a simulated time series of river discharges. It can be used to understand the variability of expected hydrological responses based on model structures. 
+
+This package is an implementation of the framework for hydrological modelling FUSE described in Clark et al. (2008) and based on the Fortran code provided by M. Clark in 2011. The package consists of two modules: Soil Moisture Accounting module (fusesma.sim) and Gamma routing module (fuserouting.sim). It also contains default parameter ranges (fusesma.ranges and fuserouting.ranges) and three data objects: fuse_hydrological_timeseries (sample input dataset), parameters (sample parameters) and modlist (list of FUSE model structures).
 
 ### Dependencies
 The fuse package, as well as the examples in the vignette, depend on a number of CRAN packages. Check for missing dependencies and install them:

diff --git a/README.md b/README.md
@@ -7,7 +7,9 @@ fuse: an R package implementing the Framework for Understanding Structural Error
 
 [![Build Status](https://travis-ci.org/cvitolo/fuse.svg)](https://travis-ci.org/cvitolo/fuse.svg?branch=master) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/cvitolo/fuse?branch=master&svg=true)](https://ci.appveyor.com/project/cvitolo/fuse) [![codecov.io](https://codecov.io/github/cvitolo/fuse/coverage.svg?branch=master)](https://codecov.io/github/cvitolo/fuse?branch=master)
 
-Implementation of the framework for hydrological modelling FUSE described in Clark et al. (2008) and based on the Fortran code provided by M. Clark in 2011. The package consists of two modules: Soil Moisture Accounting module (fusesma.sim) and Gamma routing module (fuserouting.sim). It also contains default parameter ranges (fusesma.ranges and fuserouting.ranges) and three data objects: fuse\_hydrological\_timeseries (sample input dataset), parameters (sample parameters) and modlist (list of FUSE model structures).
+The fuse modelling framework takes as input rainfall and potential evapotranspiration time series (areal averages over the river catchment area) and returns a simulated time series of river discharges. It can be used to understand the variability of expected hydrological responses based on model structures.
+
+This package is an implementation of the framework for hydrological modelling FUSE described in Clark et al. (2008) and based on the Fortran code provided by M. Clark in 2011. The package consists of two modules: Soil Moisture Accounting module (fusesma.sim) and Gamma routing module (fuserouting.sim). It also contains default parameter ranges (fusesma.ranges and fuserouting.ranges) and three data objects: fuse\_hydrological\_timeseries (sample input dataset), parameters (sample parameters) and modlist (list of FUSE model structures).
 
 ### Dependencies
 

diff --git a/README_files/figure-markdown_github/example-1.png b/README_files/figure-markdown_github/example-1.png
diff --git a/docs/articles/fuse_vignette.html b/docs/articles/fuse_vignette.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index_files/figure-html/example-1.png b/docs/index_files/figure-html/example-1.png
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/reference/fuse.html b/docs/reference/fuse.html
diff --git a/docs/reference/fuseInfo.html b/docs/reference/fuseInfo.html
diff --git a/docs/reference/fuse_hydrological_timeseries.html b/docs/reference/fuse_hydrological_timeseries.html
diff --git a/docs/reference/fuse_parameters.html b/docs/reference/fuse_parameters.html
diff --git a/docs/reference/fuserouting.ranges.html b/docs/reference/fuserouting.ranges.html
diff --git a/docs/reference/fuserouting.sim.html b/docs/reference/fuserouting.sim.html
diff --git a/docs/reference/fusesma.ranges.html b/docs/reference/fusesma.ranges.html
diff --git a/docs/reference/fusesma.sim.html b/docs/reference/fusesma.sim.html
diff --git a/docs/reference/generateParameters.html b/docs/reference/generateParameters.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/model_param_table.html b/docs/reference/model_param_table.html
diff --git a/docs/reference/modlist.html b/docs/reference/modlist.html
diff --git a/docs/reference/modliststring.html b/docs/reference/modliststring.html
diff --git a/docs/reference/readmd.html b/docs/reference/readmd.html
diff --git a/docs/reference/readmd2var.html b/docs/reference/readmd2var.html
diff --git a/vignettes/fuse_vignette.Rmd b/vignettes/fuse_vignette.Rmd
@@ -18,7 +18,9 @@ knitr::opts_chunk$set(
 ```
 
 # Introduction
-Implementation of the framework for hydrological modelling FUSE described in Clark et al. (2008) and based on the Fortran code provided by M. Clark in 2011. The package consists of two modules: Soil Moisture Accounting module (fusesma.sim) and Gamma routing module (fuserouting.sim). It also contains default parameter ranges (fusesma.ranges and fuserouting.ranges) and three data objects: fuse_hydrological_timeseries (sample input dataset), parameters (sample parameters) and modlist (list of FUSE model structures).
+The fuse modelling framework takes as input rainfall and potential evapotranspiration time series (areal averages over the river catchment area) and returns a simulated time series of river discharges. It can be used to understand the variability of expected hydrological responses based on model structures. 
+
+This package is an implementation of the framework for hydrological modelling FUSE described in Clark et al. (2008) and based on the Fortran code provided by M. Clark in 2011. The package consists of two modules: Soil Moisture Accounting module (fusesma.sim) and Gamma routing module (fuserouting.sim). It also contains default parameter ranges (fusesma.ranges and fuserouting.ranges) and three data objects: fuse_hydrological_timeseries (sample input dataset), parameters (sample parameters) and modlist (list of FUSE model structures).
 
 ### Dependencies
 The fuse package, as well as the examples in this vignette, depend on a number of CRAN packages. Check for missing dependencies and install them: