Commit 4447886d authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

Version 0.8.1.2

parent 284f572d
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateCalibOptions.R
\encoding{UTF-8}
\name{CreateCalibOptions}
......@@ -66,7 +66,7 @@ CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_HBAN,
Creation of the CalibOptions object required to the Calibration functions.
}
\details{
Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not included in
Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not included in
the package must create their own CalibOptions object accordingly.
}
\examples{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateInputsCrit.R
\encoding{UTF-8}
\name{CreateInputsCrit}
......@@ -39,7 +39,7 @@ CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions, Qobs, BoolCrit = NULL,
Creation of the InputsCrit object required to the ErrorCrit functions.
}
\details{
Users wanting to use FUN_CRIT functions that are not included in
Users wanting to use FUN_CRIT functions that are not included in
the package must create their own InputsCrit object accordingly.
}
\examples{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateInputsModel.R
\encoding{UTF-8}
\name{CreateInputsModel}
......@@ -47,7 +47,7 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
Creation of the InputsModel object required to the RunModel functions.
}
\details{
Users wanting to use FUN_MOD functions that are not included in
Users wanting to use FUN_MOD functions that are not included in
the package must create their own InputsModel object accordingly.
}
\examples{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateRunOptions.R
\encoding{UTF-8}
\name{CreateRunOptions}
......@@ -50,7 +50,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
Creation of the RunOptions object required to the RunModel functions.
}
\details{
Users wanting to use FUN_MOD functions that are not included in
Users wanting to use FUN_MOD functions that are not included in
the package must create their own RunOptions object accordingly.
##### Initialisation options #####
......@@ -63,7 +63,7 @@ A default configuration is used for initialisation if these vectors are not defi
(1) Default initialisation options:
\itemize{
\item \emph{IndPeriod_WarmUp} default setting ensures a one-year warm-up using the time-steps preceding the \emph{IndPeriod_Run}.
\item \emph{IndPeriod_WarmUp} default setting ensures a one-year warm-up using the time-steps preceding the \emph{IndPeriod_Run}.
The actual length of this warm-up might be shorter depending on data availability (no missing value being allowed on model input series).
\item \emph{IniStates} and \emph{IniResLevels} are automatically set to initialise all the model states at 0, except for the production and routing stores which are initialised at 50\% of their capacity. This initialisation is made at the very beginning of the model call (i.e. at the beginning of \emph{IndPeriod_WarmUp} or at the beginning of IndPeriod_Run if the warm-up period is disabled).
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/DataAltiExtrapolation_HBAN.R
\encoding{UTF-8}
\name{DataAltiExtrapolation_HBAN}
......@@ -29,7 +29,7 @@ DataAltiExtrapolation_HBAN(DatesR, Precip, TempMean, TempMin = NULL,
}
\value{
list containing the extrapolated series of precip. and air temp. on each elevation layer
\tabular{ll}{
\tabular{ll}{
\emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm] \cr
\emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [degC] \cr
\emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [degC] \cr
......@@ -42,7 +42,7 @@ list containing the extrapolated series of precip. and air temp. on each elevati
Function which extrapolates the precipitation and air temperature series for different elevation layers (method from Valery, 2010).
}
\details{
Elevation layers of equal surface are created the 101 elevation quantiles (\emph{HypsoData})
Elevation layers of equal surface are created the 101 elevation quantiles (\emph{HypsoData})
and the number requested elevation layers (\emph{NLayers}). \cr
Forcing data (precipitation and air temperature) are extrapolated using gradients from Valery (2010).
(e.g. gradP=0.0004 [m-1] for France and gradT=0.434 [degreC/100m] for January, 1st). \cr
......@@ -52,10 +52,10 @@ This function is used by the \emph{CreateInputsModel} function. \cr
Laurent Coron, Pierre Brigode (June 2014)
}
\references{
Turcotte, R., L.-G. Fortin, V. Fortin, J.-P. Fortin and J.-P. Villeneuve (2007),
Operational analysis of the spatial distribution and the temporal evolution of the snowpack water equivalent
Turcotte, R., L.-G. Fortin, V. Fortin, J.-P. Fortin and J.-P. Villeneuve (2007),
Operational analysis of the spatial distribution and the temporal evolution of the snowpack water equivalent
in southern Quebec, Canada, Nordic Hydrology, 38(3), 211, doi:10.2166/nh.2007.009. \cr
Valéry, A. (2010), Modélisation précipitations-débit sous influence nivale ? : Elaboration d'un module neige
Valéry, A. (2010), Modélisation précipitations-débit sous influence nivale ? : Elaboration d'un module neige
et évaluation sur 380 bassins versants, PhD thesis (in french), AgroParisTech, Paris, France. \cr
USACE (1956), Snow Hydrology, pp. 437, U.S. Army Coprs of Engineers (USACE) North Pacific Division, Portland, Oregon, USA.
}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit.R
\encoding{UTF-8}
\name{ErrorCrit}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_KGE.R
\encoding{UTF-8}
\name{ErrorCrit_KGE}
......@@ -30,8 +30,8 @@ ErrorCrit_KGE(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the KGE formula proposed by Gupta et al. (2009).
}
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
......@@ -41,7 +41,7 @@ the use of the function for model calibration: the product CritValue*Multiplier
Laurent Coron (June 2014)
}
\references{
Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
Decomposition of the mean squared error and NSE performance criteria: Implications
for improving hydrological modelling, Journal of Hydrology, 377(1-2), 80-91, doi:10.1016/j.jhydrol.2009.08.003. \cr
}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_KGE2.R
\encoding{UTF-8}
\name{ErrorCrit_KGE2}
......@@ -30,8 +30,8 @@ ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the KGE' formula proposed by Kling et al. (2012).
}
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
......@@ -41,10 +41,10 @@ the use of the function for model calibration: the product CritValue*Multiplier
Laurent Coron (June 2014)
}
\references{
Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
Decomposition of the mean squared error and NSE performance criteria: Implications
for improving hydrological modelling, Journal of Hydrology, 377(1-2), 80-91, doi:10.1016/j.jhydrol.2009.08.003. \cr
Kling, H., Fuchs, M. and Paulin, M. (2012),
Kling, H., Fuchs, M. and Paulin, M. (2012),
Runoff conditions in the upper Danube basin under an ensemble of climate change scenarios,
Journal of Hydrology, 424-425, 264-277, doi:10.1016/j.jhydrol.2012.01.011.
}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_NSE.R
\encoding{UTF-8}
\name{ErrorCrit_NSE}
......@@ -28,8 +28,8 @@ ErrorCrit_NSE(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the NSE formula proposed by Nash & Sutcliffe (1970).
}
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
......@@ -39,7 +39,7 @@ the use of the function for model calibration: the product CritValue*Multiplier
Laurent Coron (June 2014)
}
\references{
Nash, J.E. and Sutcliffe, J.V. (1970),
Nash, J.E. and Sutcliffe, J.V. (1970),
River flow forecasting through conceptual models part 1.
A discussion of principles, Journal of Hydrology, 10(3), 282-290, doi:10.1016/0022-1694(70)90255-6. \cr
}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_RMSE.R
\encoding{UTF-8}
\name{ErrorCrit_RMSE}
......@@ -28,8 +28,8 @@ ErrorCrit_RMSE(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the root mean square error (RMSE).
}
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/PEdaily_Oudin.R
\encoding{UTF-8}
\name{PEdaily_Oudin}
......@@ -21,7 +21,7 @@ PEdaily_Oudin(JD, Temp, LatRad)
Function which computes daily PE using the formula from Oudin et al. (2005).
}
\examples{
require(airGR)
require(airGR)
data(L0123001)
PotEvap <- PEdaily_Oudin(JD=as.POSIXlt(BasinObs$DatesR)$yday,Temp=BasinObs$T,LatRad=0.8)
}
......@@ -30,8 +30,8 @@ Laurent Coron (December 2013)
}
\references{
Oudin, L., F. Hervieu, C. Michel, C. Perrin, V. Andréassian, F. Anctil and C. Loumagne (2005),
Which potential evapotranspiration input for a lumped rainfall-runoff model?: Part 2-Towards a
simple and efficient potential evapotranspiration model for rainfall-runoff modelling, Journal of Hydrology,
Which potential evapotranspiration input for a lumped rainfall-runoff model?: Part 2-Towards a
simple and efficient potential evapotranspiration model for rainfall-runoff modelling, Journal of Hydrology,
303(1-4), 290-306, doi:10.1016/j.jhydrol.2004.08.026.
}
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel.R
\encoding{UTF-8}
\name{RunModel}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeige.R
\encoding{UTF-8}
\name{RunModel_CemaNeige}
......@@ -13,14 +13,14 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 2 parameters
\tabular{ll}{
\tabular{ll}{
CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr
}}
}
\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{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
......@@ -32,7 +32,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & degC] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -73,11 +73,11 @@ plot_OutputsModel(OutputsModel=OutputsModel)
Laurent Coron (January 2014)
}
\references{
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR4J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR4J}
......@@ -13,7 +13,7 @@ RunModel_CemaNeigeGR4J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 6 parameters
\tabular{ll}{
\tabular{ll}{
GR4J X1 \tab production store capacity [mm] \cr
GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR4J X3 \tab routing store capacity [mm] \cr
......@@ -23,8 +23,8 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
}}
}
\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/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
......@@ -50,7 +50,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & HU levels [mm], CemaNeige states [mm & degC] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -97,14 +97,14 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
Perrin, C., C. Michel and V. Andréassian (2003),
Improvement of a parsimonious model for streamflow simulation,
Perrin, C., C. Michel and V. Andréassian (2003),
Improvement of a parsimonious model for streamflow simulation,
Journal of Hydrology, 279(1-4), 275-289, doi:10.1016/S0022-1694(03)00225-7. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR5J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR5J}
......@@ -13,7 +13,7 @@ RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 7 parameters
\tabular{ll}{
\tabular{ll}{
GR5J X1 \tab production store capacity [mm] \cr
GR5J X2 \tab intercatchment exchange coefficient 1 [mm/d] \cr
GR5J X3 \tab routing store capacity [mm] \cr
......@@ -24,8 +24,8 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
}}
}
\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/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
......@@ -51,7 +51,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & HU levels [mm], CemaNeige states [mm & degC] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -98,16 +98,16 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
Le Moine, N. (2008), Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances
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 (french), UPMC, Paris, France. \cr
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR6J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR6J}
......@@ -13,7 +13,7 @@ RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 8 parameters
\tabular{ll}{
\tabular{ll}{
GR6J X1 \tab production store capacity [mm] \cr
GR6J X2 \tab intercatchment exchange coefficient 1 [mm/d] \cr
GR6J X3 \tab routing store capacity [mm] \cr
......@@ -25,8 +25,8 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
}}
}
\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/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
......@@ -54,7 +54,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & HU levels [mm], CemaNeige states [mm & degC] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -101,14 +101,14 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Valéry, A., V. Andréassian and C. Perrin (2014),
"As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR1A.R
\encoding{UTF-8}
\name{RunModel_GR1A}
......@@ -13,18 +13,18 @@ RunModel_GR1A(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}{
GR1A X1 \tab model parameter [mm] \cr
}}
}
\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
\emph{$Qsim } \tab [numeric] series of Qsim [mm/h] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -80,7 +80,7 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (March 2015)
}
\references{
Mouelhi S. (2003),
Mouelhi S. (2003),
Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier,
PhD thesis (in French), ENGREF, Cemagref Antony, France. \cr
}
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR2M.R
\encoding{UTF-8}
\name{RunModel_GR2M}
......@@ -13,14 +13,14 @@ RunModel_GR2M(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}{
GR2M X1 \tab production store capacity [mm] \cr
GR2M X2 \tab groundwater exchange coefficient [mm/month] \cr
}}
}
\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
......@@ -37,7 +37,7 @@ GR2M X2 \tab groundwater exchange coefficient [mm/month] \cr
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -91,7 +91,7 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (March 2015)
}
\references{
Mouelhi S. (2003),
Mouelhi S. (2003),
Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier,
PhD thesis (in French), ENGREF, Cemagref Antony, France. \cr
Mouelhi, S., C. Michel, C. Perrin and V. Andréassian (2006),
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR4H.R
\encoding{UTF-8}
\name{RunModel_GR4H}
......@@ -13,7 +13,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
......@@ -21,8 +21,8 @@ GR4H X4 \tab unit hydrograph time constant [h]
}}
}
\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
......@@ -39,7 +39,7 @@ GR4H X4 \tab unit hydrograph time constant [h]
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -83,8 +83,8 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (July 2014)
}
\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.
}
\seealso{
......
% Generated by roxygen2 (4.1.1): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR4J.R
\encoding{UTF-8}
\name{RunModel_GR4J}
......@@ -13,7 +13,7 @@ RunModel_GR4J(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}{
GR4J X1 \tab production store capacity [mm] \cr
GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR4J X3 \tab routing store capacity [mm] \cr
......@@ -21,8 +21,8 @@ GR4J X4 \tab unit hydrograph time constant [d]
}}
}
\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/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
......@@ -39,7 +39,7 @@ GR4J X4 \tab unit hydrograph time constant [d]
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
}
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
......@@ -83,8 +83,8 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
Perrin, C., C. Michel and V. Andréassian (2003),
Improvement of a parsimonious model for streamflow simulation,
Perrin, C., C. Michel and V. Andréassian (2003),
Improvement of a parsimonious model for streamflow simulation,
Journal of Hydrology, 279(1-4), 275-289, doi:10.1016/S0022-1694(03)00225-7.
}
\seealso{
......
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