Commit 8e9db121 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.4.3.77 DOC: minor typo revisions in the airGR help page

parent 9b25adef
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Date: 2020-04-05
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
......@@ -4,7 +4,7 @@
### Release Notes (2020-04-05)
### Release Notes (2020-04-05)
#### CRAN-compatibility updates
- The 'hydroPSO' package is back on CRAN and it is again suggested (cf. the 'param_optim' vignette).
......@@ -7,7 +7,7 @@
This package brings into R the hydrological modelling tools developed at INRAE-Antony (formerly IRSTEA, HYCAR Research Unit, France), including rainfall-runoff models (\strong{GR4H}, \strong{GR5H}, \strong{GR4J}, \strong{GR5J}, \strong{GR6J}, \strong{GR2M}, \strong{GR1A}) and a snow accumulation and melt model (\strong{CemaNeige}). Each model core is coded in Fortran to ensure low computational time. The other package functions (i.e. mainly the calibration algorithm and the computation of the efficiency criteria) are coded in R. \cr\cr
## ---- Functions and objects
## --- Functions and objects
The airGR package has been designed to fulfil two major requirements: facilitate the use by non-expert users and allow flexibility regarding the addition of external criteria, models or calibration algorithms. The names of the functions and their arguments were chosen to this end.
......@@ -19,7 +19,7 @@ The package is mostly based on three families of functions: \cr
In order to limit the risk of mis-use and increase the flexibility of these main functions, we imposed the structure of their arguments and defined their class. Most users will not need to worry about these imposed structures since functions are provided to prepare these arguments for them: \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}. However, advanced users wishing to supplement the package with their own models will need to comply with these imposed structures and refer to the package source codes to get all the specification requirements. \cr\cr
## ---- Models
## --- Models
Seven hydrological models and one snow melt and accumulation model are implemented in airGR. The snow model can also be used alone or with the daily hydrological models, and each hydrological model can either be used alone or together with the snow model. \cr
These models can be called within airGR using the following functions: \cr
......@@ -38,7 +38,7 @@ These models can be called within airGR using the following functions: \cr
- \code{\link{RunModel_CemaNeigeGR6J}}: combined use of GR6J and CemaNeige \cr\cr
## ---- How to get started
## --- How to get started
To learn how to use the functions from the airGR package, it is recommended to follow the five steps described below: \cr
1. refer to the help for \code{\link{RunModel_GR4J}} then run the provided example to assess how to make a simulation; \cr
......@@ -50,7 +50,7 @@ To learn how to use the functions from the airGR package, it is recommended to f
For more information and to get started with the package, you can refer to the vignette (\code{vignette("airGR")}) and go on the \href{}{airGR website}. \cr\cr
## ---- References
## --- References
- Ficchi, A. (2017). An adaptive hydrological model for multiple time-steps: Diagnostics and improvements based on fluxes consistency. PhD thesis, Irstea (Antony), GRNE (Paris), France.
- Ficchi, A., C. Perrin and V. Andréassian (2019). Hydrological modelling at multiple sub-daily time steps: model improvement via flux-matching. Journal of Hydrology, 575, 1308-1327. doi: 10.1016/j.jhydrol.2019.05.084. \cr
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment