diff --git a/DESCRIPTION b/DESCRIPTION index 0f8979ca2d57d3fd7be9b203d50f417b7dc9a5c3..ef5b5b8abf60da6f26a7e1890be08b8856bdb073 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.4.3.26 +Version: 1.4.3.27 Date: 2019-12-19 Authors@R: c( person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")), diff --git a/NEWS.md b/NEWS.md index 5d40befd8e43f017f83dc26f40c7343d9e61c20d..54b124dfa9f9af350664b6f4041d94dedc87048e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ -### 1.4.3.26 Release Notes (2019-12-19) +### 1.4.3.27 Release Notes (2019-12-19) #### New features diff --git a/man/CreateIniStates.Rd b/man/CreateIniStates.Rd index 0c5af076db59ea3f8d42e2700f5fb0021f0ca428..e1ff5627e477be7e252125d0692b1d0bf0fa1d1c 100644 --- a/man/CreateIniStates.Rd +++ b/man/CreateIniStates.Rd @@ -25,11 +25,11 @@ CreateIniStates(FUN_MOD, InputsModel, IsHyst = FALSE, IsIntStore = FALSE, \item{IsHyst}{[boolean] boolean indicating if the hysteresis version of CemaNeige is used. See details} -\item{IsIntStore}{[boolean] boolean indicating if the interception store is used. See details} +\item{IsIntStore}{[boolean] boolean indicating if the interception store is used in GR5H. See details} -\item{ProdStore}{[numeric] production store level [mm]} +\item{ProdStore}{[numeric] production store level [mm] for all GR models except GR1A} -\item{RoutStore}{[numeric] routing store level [mm]} +\item{RoutStore}{[numeric] routing store level [mm] for all GR models except GR1A} \item{ExpStore}{(optional) [numeric] series of exponential store level (negative) [mm] for the GR6J model} @@ -57,7 +57,7 @@ CreateIniStates(FUN_MOD, InputsModel, IsHyst = FALSE, IsIntStore = FALSE, \tabular{ll}{ \emph{$Store } \tab [numeric] list of store levels (\emph{$Prod}, \emph{$Rout} and \emph{$Exp}) \cr \emph{$UH } \tab [numeric] list of unit hydrographs levels (\emph{$UH1} and \emph{$UH2}) \cr - \emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (\emph{$G} and \emph{$eTG}) + \emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (\emph{$G}, \emph{$eTG}, \emph{$GthrCemaNeigeLayers} and \emph{$GlocmaxCemaNeigeLayers}) } } @@ -67,10 +67,10 @@ Creation of the \emph{IniStates} object possibly required by the \code{\link{Cre } \details{ -20 numeric values are required for UH1 and 40 numeric values are required for UH2 if GR4J, GR5J or GR6J are used (respectively 20*24 and 40*24 for the hourly model GR4H).Please note that depending on the X4 parameter value that will be provided when running the model, not all the values may be used (only the first int(X4)+1 values are used for UH1 and the first 2*int(X4)+1 for UH2). \cr -\code{GCemaNeigeLayers} and \code{eTGCemaNeigeLayers} require each numeric values as many as given in \code{\link{CreateInputsModel}} with the \code{NLayersargument}. \code{eTGCemaNeigeLayers} values can be negatives.\cr -The structure of the object of class \code{IniStates} returned is always exactly the same for all models (except for the unit hydrographs levels that contain more values with GR4H), even if some states do nt exist (e.g. \emph{$UH$UH1} for GR2M). \cr -If CemaNeige is not used, \emph{$CemaNeigeLayers$G} and \emph{$CemaNeigeLayers$eTG} are set to \code{NA}. \cr +20 numeric values are required for UH1 and 40 numeric values are required for UH2 if GR4J, GR5J or GR6J are used (respectively 20*24 and 40*24 for the hourly models GR4H and GR5H). Please note that depending on the X4 parameter value that will be provided when running the model, not all the values may be used (only the first int(X4)+1 values are used for UH1 and the first 2*int(X4)+1 for UH2). \cr +\code{GCemaNeigeLayers} and \code{eTGCemaNeigeLayers} require each numeric values as many as given in \code{\link{CreateInputsModel}} with the \code{NLayers} argument. \code{eTGCemaNeigeLayers} values can be negative.\cr +The structure of the object of class \code{IniStates} returned is always exactly the same for all models (except for the unit hydrographs levels that contain more values with GR4H and GR5H), even if some states do not exist (e.g. \emph{$UH$UH1} for GR2M). \cr +If CemaNeige is not used, \emph{$CemaNeigeLayers$G}, \emph{$CemaNeigeLayers$eTG} \emph{$CemaNeigeLayers$GthrCemaNeigeLayers} and \emph{$CemaNeigeLayers$GlocmaxCemaNeigeLayers} are set to \code{NA}. \cr Nota: the \code{StateEnd} objects from the outputs of \code{RunModel*} functions already respect the format given by the \code{CreateIniStates} function. }