From 9733b25bb38fdd11d6d06e9fd724879e4c74fda4 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.priv>
Date: Tue, 21 May 2019 17:19:11 +0200
Subject: [PATCH] v1.3.1.1 DOC: DataAltiExtrapolationValery, Runmodel_CemaNeige
and airGR doc now explain that CemaNeige can run with hourly time step
---
DESCRIPTION | 2 +-
NEWS.rmd | 2 +-
man/DataAltiExtrapolation_Valery.Rd | 14 +++++++-------
man/RunModel_CemaNeige.Rd | 6 +++---
man/airGR.Rd | 1 +
5 files changed, 13 insertions(+), 12 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 9157f824..c7f9da59 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.3.1.0
+Version: 1.3.1.1
Date: 2019-05-21
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
diff --git a/NEWS.rmd b/NEWS.rmd
index fb7a8507..9b11edc2 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -14,7 +14,7 @@ output:
-### 1.3.1.0 Release Notes (2019-05-21)
+### 1.3.1.1 Release Notes (2019-05-21)
#### New features
diff --git a/man/DataAltiExtrapolation_Valery.Rd b/man/DataAltiExtrapolation_Valery.Rd
index df6162d7..2b406a57 100644
--- a/man/DataAltiExtrapolation_Valery.Rd
+++ b/man/DataAltiExtrapolation_Valery.Rd
@@ -18,7 +18,7 @@ DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = TRUE,
\arguments{
\item{DatesR}{[POSIXt] vector of dates}
-\item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm/d]}
+\item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm/time step]}
\item{PrecipScale}{(optional) [boolean] indicating if the mean of the precipitation interpolated on the elevation layers must be kept or not, required to create CemaNeige module inputs, default = \code{TRUE} (the mean of the precipitation is kept to the original value)}
@@ -39,12 +39,12 @@ DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = TRUE,
\value{
list containing the extrapolated series of precip. and air temp. on each elevation layer
\tabular{ll}{
- \emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm/d] \cr
- \emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [°C] \cr
- \emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [°C] \cr
- \emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [°C] \cr
- \emph{$LayerFracSolidPrecip} \tab [list] list of time series of daily solid precip. fract. (layer average) [-] \cr
- \emph{$ZLayers } \tab [numeric] vector of median elevation for each layer \cr
+ \emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm/time step] \cr
+ \emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [°C] \cr
+ \emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [°C] \cr
+ \emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [°C] \cr
+ \emph{$LayerFracSolidPrecip} \tab [list] list of time series of daily solid precip. fract. (layer average) [-] \cr
+ \emph{$ZLayers } \tab [numeric] vector of median elevation for each layer \cr
}
}
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index 99262cb3..495cae56 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -21,7 +21,7 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param)
\item{Param}{[numeric] vector of 2 (or 4 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
\tabular{ll}{
CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
+CemaNeige X2 \tab degree-day melt coefficient [mm/°C/time step] \cr
CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
}}
@@ -51,12 +51,12 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\description{
-Function which performs a single run for the CemaNeige daily snow module.
+Function which performs a single run for the CemaNeige snow module at the daily or hourly time step.
}
\details{
-The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
+The choice of the CemaNeige version (i.e. with or without hysteresis) 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}}.
}
diff --git a/man/airGR.Rd b/man/airGR.Rd
index 9266747c..9d310504 100644
--- a/man/airGR.Rd
+++ b/man/airGR.Rd
@@ -30,6 +30,7 @@ These models can be called within airGR using the following functions: \cr
- \code{\link{RunModel_GR2M}}: two-parameter monthly lumped hydrological model (Mouelhi, 2003 ; Mouelhi \emph{et al.}, 2006a) \cr
- \code{\link{RunModel_GR1A}}: one-parameter yearly lumped hydrological model (Mouelhi, 2003 ; Mouelhi \emph{et al.}, 2006b) \cr
- \code{\link{RunModel_CemaNeige}}: two-parameter degree-day snow melt and accumulation daily model (Valéry \emph{et al.}, 2014) \cr
+ - \code{\link{RunModel_CemaNeigeGR4H}}: combined use of GR4H and CemaNeige \cr
- \code{\link{RunModel_CemaNeigeGR4J}}: combined use of GR4J and CemaNeige \cr
- \code{\link{RunModel_CemaNeigeGR5J}}: combined use of GR5J and CemaNeige \cr
- \code{\link{RunModel_CemaNeigeGR6J}}: combined use of GR6J and CemaNeige \cr\cr
--
GitLab