diff --git a/README.Rmd b/README.Rmd index fcc16e7..37e4b42 100644 --- 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 index 540d9ee..c7ada02 100644 --- 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 index d9ae682..4d2a22b 100644 Binary files a/README_files/figure-markdown_github/example-1.png and b/README_files/figure-markdown_github/example-1.png differ diff --git a/docs/articles/fuse_vignette.html b/docs/articles/fuse_vignette.html index fcf4766..e9e70e7 100644 --- a/docs/articles/fuse_vignette.html +++ b/docs/articles/fuse_vignette.html @@ -20,6 +20,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/authors.html b/docs/authors.html index 3cc81ee..757ad07 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/index.html b/docs/index.html index eb30be3..cff4284 100644 --- a/docs/index.html +++ b/docs/index.html @@ -20,6 +20,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/fuseInfo.html b/docs/reference/fuseInfo.html index f4c9a5f..4ad820d 100644 --- a/docs/reference/fuseInfo.html +++ b/docs/reference/fuseInfo.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/fuse_hydrological_timeseries.html b/docs/reference/fuse_hydrological_timeseries.html index 924d035..369a03e 100644 --- a/docs/reference/fuse_hydrological_timeseries.html +++ b/docs/reference/fuse_hydrological_timeseries.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/fuse_parameters.html b/docs/reference/fuse_parameters.html index 73f4a1a..fa5919b 100644 --- a/docs/reference/fuse_parameters.html +++ b/docs/reference/fuse_parameters.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/fuserouting.ranges.html b/docs/reference/fuserouting.ranges.html index 5f6dbb1..04e75ef 100644 --- a/docs/reference/fuserouting.ranges.html +++ b/docs/reference/fuserouting.ranges.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/fuserouting.sim.html b/docs/reference/fuserouting.sim.html index d95f7b6..796d559 100644 --- a/docs/reference/fuserouting.sim.html +++ b/docs/reference/fuserouting.sim.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • @@ -90,7 +93,7 @@

    Ar
    mid
    This is the model identification number (see first column of modlist). This is a numeric value in the range [1, 1248].
    deltim
    -
    This is the input time step. By default deltim = 1 for daily steps. All options: deltim = 1 (daily time step), 1/24 (hourly time step), 1/24/4 (15 min time step). This is a numeric value.
    +
    This is the input time step (numeric value). By default deltim = 1 for daily steps. All options: deltim = 1 (daily time step), 1/24 (hourly time step), 1/24/4 (15 min time step).
    timedelay
    Time delay in runoff (days). This is a numeric value.
    diff --git a/docs/reference/fusesma.ranges.html b/docs/reference/fusesma.ranges.html index 6c1d780..f19bb39 100644 --- a/docs/reference/fusesma.ranges.html +++ b/docs/reference/fusesma.ranges.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/fusesma.sim.html b/docs/reference/fusesma.sim.html index 95c5b95..9417185 100644 --- a/docs/reference/fusesma.sim.html +++ b/docs/reference/fusesma.sim.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • @@ -92,9 +95,9 @@

    Ar
    DATA
    This is a data.frame containing the observed time series (zoo objects). It is structured into three columns containing: precipitation (P), potential evapo-transpiration (E) and streamflow discharge (Q).
    mid
    -
    This is the model identification number (see first column of modlist).
    +
    This is the model identification number (see first column of modlist). This is a numeric value in the range [1, 1248].
    deltim
    -
    This is the input time step. By default deltim = 1 for daily steps. Other options: 1/24 (hourly time step), 1/(24*4) (15 min time step).
    +
    This is the input time step (numeric value). By default deltim = 1 for daily steps. Other options: 1/24 (hourly time step), 1/(24*4) (15 min time step).
    rferr_add
    Additive rainfall error, default is 0 (mm day-1).
    rferr_mlt
    diff --git a/docs/reference/generateParameters.html b/docs/reference/generateParameters.html index 8caa99a..6cc3cb7 100644 --- a/docs/reference/generateParameters.html +++ b/docs/reference/generateParameters.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/index.html b/docs/reference/index.html index b669dbf..e43a5d3 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/model_param_table.html b/docs/reference/model_param_table.html index 2dbb61d..71db082 100644 --- a/docs/reference/model_param_table.html +++ b/docs/reference/model_param_table.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/modlist.html b/docs/reference/modlist.html index a219539..2d01613 100644 --- a/docs/reference/modlist.html +++ b/docs/reference/modlist.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/modliststring.html b/docs/reference/modliststring.html index 59000cc..c760837 100644 --- a/docs/reference/modliststring.html +++ b/docs/reference/modliststring.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/readmd.html b/docs/reference/readmd.html index 74a3e39..abfabaa 100644 --- a/docs/reference/readmd.html +++ b/docs/reference/readmd.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/docs/reference/readmd2var.html b/docs/reference/readmd2var.html index 8caded3..0611d7a 100644 --- a/docs/reference/readmd2var.html +++ b/docs/reference/readmd2var.html @@ -53,6 +53,9 @@
  • Articles +
    • +
  • + News
    • diff --git a/vignettes/fuse_vignette.Rmd b/vignettes/fuse_vignette.Rmd index 739bf05..6799511 100644 --- 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: