From 0bdc58bccdc15cd9bbe1ad4dcd8f658d2fa7e45c Mon Sep 17 00:00:00 2001
From: unknown <olivier.delaigue@ANPI1430.antony.irstea.priv>
Date: Fri, 23 Jun 2017 16:18:57 +0200
Subject: [PATCH] v1.0.9.2 CreateIniStates documentation updated (and links in
RunModel* docs)
---
DESCRIPTION | 2 +-
man/CreateIniStates.Rd | 37 ++++++++++++++++++++---------------
man/RunModel_CemaNeige.Rd | 2 +-
man/RunModel_CemaNeigeGR4J.Rd | 2 +-
man/RunModel_CemaNeigeGR5J.Rd | 2 +-
man/RunModel_CemaNeigeGR6J.Rd | 2 +-
man/RunModel_GR2M.Rd | 2 +-
man/RunModel_GR4H.Rd | 2 +-
man/RunModel_GR4J.Rd | 2 +-
man/RunModel_GR5J.Rd | 2 +-
man/RunModel_GR6J.Rd | 2 +-
11 files changed, 31 insertions(+), 26 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index ad168ee9..5070970e 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.1
+Version: 1.0.9.2
Date: 2017-06-22
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl")),
diff --git a/man/CreateIniStates.Rd b/man/CreateIniStates.Rd
index efb91556..f1426e76 100644
--- a/man/CreateIniStates.Rd
+++ b/man/CreateIniStates.Rd
@@ -5,7 +5,7 @@
\alias{CreateIniStates}
-\title{Creation of the IniStates object possible required to the CreateRunOptions functions}
+\title{Creation of the IniStates object possibly required by the CreateRunOptions functions}
\usage{
@@ -20,21 +20,21 @@ CreateIniStates(FUN_MOD, InputsModel,
\arguments{
\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)}
-\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
+\item{InputsModel}{[object of class \code{InputsModel}] see \code{\link{CreateInputsModel}} for details}
-\item{ProdStore}{[numeric]}
+\item{ProdStore}{[numeric] production store level [mm]}
-\item{RoutStore}{[numeric]}
+\item{RoutStore}{[numeric] routing store level [mm]}
-\item{ExpStore}{[numeric]}
+\item{ExpStore}{(optional) [numeric] series of exponential store level (negative) [mm] for the GR6J model}
-\item{UH1}{[numeric]}
+\item{UH1}{(optional) [numeric] unit hydrograph 1 levels [mm]}
-\item{UH2}{[numeric]}
+\item{UH2}{(optional) [numeric] unit hydrograph 2 levels [mm]}
-\item{GCemaNeigeLayers}{[numeric]}
+\item{GCemaNeigeLayers}{(optional) [numeric] snow pack [mm], possibly used to create the CemaNeige model initial state}
-\item{eTGCemaNeigeLayers}{[numeric]}
+\item{eTGCemaNeigeLayers}{(optional) [numeric] snow pack thermal state [°C], possibly used to create the CemaNeige model initial state}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, \code{default = TRUE}}
@@ -42,21 +42,26 @@ CreateIniStates(FUN_MOD, InputsModel,
\value{
-[list] object of class \emph{IniStates} containing the initial model internal states; it includes the following:
- \itemize{
- \item{Store }{}
- \item{UH }{}
- \item{CemaNeigeLayers}{}
+[list] object of class \code{IniStates} containing the initial model internal states; it includes the following:
+ \tabular{ll}{
+ \emph{$Store } \tab [numeric] list of store levels (always \emph{$Prod}, \emph{$Rout} and \emph{$Exp}) \cr
+ \emph{$UH } \tab [numeric] list of unit hydrographs levels (always \emph{$UH1} and \emph{$UH2} \cr
+ \emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (always \emph{$G} and \emph{$eTG})
}
}
\description{
-Creation of the IniStates object required to XXXX
+Creation of the IniStates object possibly required by the CreateRunOptions functions
}
\details{
-XXXX
+20 floats are required for UH1 and 40 floats are required for UH2 (repectivly 20*24 and 40*24 for the daily model GR4H). \cr
+NLayers floats are required for GCemaNeigeLayers and eTGCemaNeigeLayers. \cr
+The structure of the object of class \code{IniStates} returned is always the exactly same for all models(except for the unit hydrographs more longer with GR4H), even some states don't 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
+
+Nota: the \code{StateEnd} objects from the outputs of \code{RunModel*} functions already respect the format given by the \code{CreateIniStates} function.
}
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index 33507b4c..f77a5794 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -30,7 +30,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/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{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
- \emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & °C] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & °C], \cr\tab 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)
}
diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd
index 38bbb851..63993f9e 100644
--- a/man/RunModel_CemaNeigeGR4J.Rd
+++ b/man/RunModel_CemaNeigeGR4J.Rd
@@ -52,7 +52,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/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{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
- \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab 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)
}
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index 01c53c7e..6ccb4e2d 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -53,7 +53,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/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{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
- \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab 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)
}
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index 77044b7e..19ec23fc 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -56,7 +56,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/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{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
- \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab 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)
}
diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd
index fc3bac20..f697c347 100644
--- a/man/RunModel_GR2M.Rd
+++ b/man/RunModel_GR2M.Rd
@@ -23,7 +23,7 @@ GR2M X2 \tab groundwater exchange coefficient [-] \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/month] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/month] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/month] \cr
- \emph{$StateEnd} \tab [numeric] states at the end of the run (production store level and routing store level) [mm] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (production store level and routing store level) [mm], \cr\tab 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)
}
diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd
index 071760dc..07a9e7dc 100644
--- a/man/RunModel_GR4H.Rd
+++ b/man/RunModel_GR4H.Rd
@@ -36,7 +36,7 @@ GR4H X4 \tab unit hydrograph time constant [h]
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/h] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 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, UH1 levels, UH2 levels) [mm] \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)
}
diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd
index c3f48805..924b112f 100644
--- a/man/RunModel_GR4J.Rd
+++ b/man/RunModel_GR4J.Rd
@@ -40,7 +40,7 @@ GR4J X4 \tab unit hydrograph time constant [d]
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 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, UH1 levels, UH2 levels) [mm] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab 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)
}
diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd
index 803eb869..94f3f486 100644
--- a/man/RunModel_GR5J.Rd
+++ b/man/RunModel_GR5J.Rd
@@ -41,7 +41,7 @@ GR5J X5 \tab intercatchment exchange threshold [-] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 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, UH1 levels, UH2 levels) [mm] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab 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)
}
diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd
index 5586b906..60c30a1d 100644
--- a/man/RunModel_GR6J.Rd
+++ b/man/RunModel_GR6J.Rd
@@ -44,7 +44,7 @@ GR6J X6 \tab coefficient for emptying exponential store [mm]
\emph{$Exp } \tab [numeric] series of exponential store level (negative) [mm] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 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, UH1 levels, UH2 levels) [mm] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab 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)
}
--
GitLab