Commit b0dd9cc7 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.6.9.17 docs(man): add text and hyperlink in Runmodel_CemaNeige* and...

v1.6.9.17 docs(man): add text and hyperlink in Runmodel_CemaNeige* and Runmodel_GR4H to inform users about the presence of hydrological model diagrams
parent f1899cf9
Pipeline #19099 passed with stages
in 12 minutes and 23 seconds
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.6.9.16
Version: 1.6.9.17
Date: 2021-01-12
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -2,7 +2,7 @@
### 1.6.9.16 Release Notes (2021-01-12)
### 1.6.9.17 Release Notes (2021-01-12)
#### New features
......
......@@ -83,6 +83,9 @@ It is advised to run the GR5H model with an interception store (see Ficchi et al
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
\cr
\cr
See \code{\link{RunModel_GR4J}} to look at the diagram of the hydrological model.
}
......
......@@ -81,6 +81,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
\cr
\cr
See \code{\link{RunModel_GR4J}} to look at the diagram of the hydrological model.
}
......
......@@ -84,6 +84,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
\cr
\cr
See \code{\link{RunModel_GR5H}} to look at the diagram of the hydrological model.
}
......
......@@ -82,6 +82,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
\cr
\cr
See \code{\link{RunModel_GR5J}} to look at the diagram of the hydrological model.
}
......
......@@ -85,6 +85,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
\cr
\cr
See \code{\link{RunModel_GR6J}} to look at the diagram of the hydrological model.
}
......
......@@ -24,7 +24,7 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
\tabular{ll}{
\tabular{ll}{
GR4H X1 \tab production store capacity [mm] \cr
GR4H X2 \tab groundwater exchange coefficient [mm/h] \cr
GR4H X3 \tab routing store capacity [mm] \cr
......@@ -34,8 +34,8 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/h] \cr
......@@ -56,14 +56,17 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], see \code{\link{CreateIniStates}} for more details \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\details{
For further details on the model, see the references section.
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
\cr
\cr
See \code{\link{RunModel_GR4J}} to look at the diagram of the hydrological model.
}
......@@ -105,13 +108,13 @@ Laurent Coron, Charles Perrin, Thibaut Mathevet, Olivier Delaigue, Guillaume Thi
\references{
Mathevet, T. (2005).
Quels modèles pluie-débit globaux pour le pas de temps horaire ?
Développement empirique et comparaison de modèles sur un large échantillon de bassins versants.
Mathevet, T. (2005).
Quels modèles pluie-débit globaux pour le pas de temps horaire ?
Développement empirique et comparaison de modèles sur un large échantillon de bassins versants.
PhD thesis (in French), ENGREF - Cemagref Antony, Paris, France.
\cr\cr
Le Moine, N. (2008).
Le bassin versant de surface vu par le souterrain :
Le Moine, N. (2008).
Le bassin versant de surface vu par le souterrain :
une voie d'amélioration des performances et du réalisme des modèles pluie-débit ?
PhD thesis (in French), UPMC - Cemagref Antony, Paris, France.
}
......
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