diff --git a/DESCRIPTION b/DESCRIPTION index 04e9dc3797ffd1a94c70d7ec71e786918ef1ecc3..ad168ee913c01e53aed40887da3eb00ea5c22251 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: airGR Type: Package Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling -Version: 1.0.9.0 +Version: 1.0.9.1 Date: 2017-06-22 Authors@R: c( person("Laurent", "Coron", role = c("aut", "trl")), diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd index 0d5346d27d0b20a9e9a2f5181d30f528373607b9..c7c54160d09d1e2c4389f9737982b298e480fd4b 100644 --- a/man/CreateRunOptions.Rd +++ b/man/CreateRunOptions.Rd @@ -74,14 +74,14 @@ The actual length of this warm-up might be shorter depending on data availabilit \item \code{IndPeriod_WarmUp} can be used to specify the indices of the warm-up period (within the time-series prepared in InputsModel). \cr - remark 1: for most common cases, indices corresponding to one or several years preceding \code{IndPeriod_Run} are used (e.g. \code{IndPeriod_WarmUp = 1000:1365} and \code{IndPeriod_Run = 1366:5000)}. \cr However, it is also possible to perform a long-term initialisation if other indices than the warm-up ones are set in \code{IndPeriod_WarmUp} (e.g. \code{IndPeriod_WarmUp <- c(1:5000 , 1:5000 , 1:5000 , 1000:1365)}). \cr -- remark 2: it is also possible to completely disable the warm-up period when using \code{IndPeriod_WarmUp = 0L}. +- remark 2: it is also possible to completely disable the warm-up period when using \code{IndPeriod_WarmUp = 0L}. This is necessary if you want \code{IniStates} and / or \code{IniResLevels} to be the actual initial values of the model variables from your simulation (e.g. to perform a forecast form a given initial state). \item \code{IniStates} and \code{IniResLevels} can be used to specify the initial model states. \cr -- remark 1: \code{IniStates} and \code{IniResLevels} can not be used with GR1A. +- remark 1: \code{IniStates} and \code{IniResLevels} can not be used with GR1A. \cr - remark 2: \code{IniStates} can be set to the \code{$StateEnd} output of a previous \code{RunModel} call. \cr - remark 3: if \code{IniStates} is used, all model states must be provided: \itemize{ - \item 7 values: production store level [mm], routing store level [mm], exponential store level [mm] (only with GR6J, 0 otherwise), and the 4 other values have to be set to 0; + \item 7 values: production store level [mm], routing store level [mm], exponential store level [mm] (only with GR6J, 0 otherwise), and the 4 other values have to be set to 0; \item 60 floats [mm] are required for GR4J, GR5J and GR6J; 60+2*NLayers floats [mm] are required for \code{CemaNeigeGR4J}, \code{CemaNeigeGR5J} and \emph{CemaNeigeGR6J}; see fortran source code for details). } - remark 4: in addition to \code{IniStates}, \code{IniResLevels} allows to set the filling rate of the production and routing stores for the GR models. For instance for GR4J, GR5J and GR6J: \code{IniResLevels <- c(0.3, 0.5)} should be used to obtain initial fillings of 30\% and 50\% for the production and routing stores, respectively. \code{IniResLevels} is optional and can only be used if \code{IniStates} is also defined (the state values corresponding to these two stores in \code{IniStates} are not used in such case). \cr \cr @@ -122,6 +122,6 @@ OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsMode Laurent Coron, Olivier Delaigue, Guillaume Thirel } \seealso{ -\code{\link{RunModel}}, \code{\link{CreateInputsModel}}, \code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}} +\code{\link{RunModel}}, \code{\link{CreateInputsModel}}, \code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}, \code{\link{CreateIniStates}} }