diff --git a/DESCRIPTION b/DESCRIPTION index 9f0e35eff7bc4c170cc892819f53b640cf2e0ac3..291af1cd4843f0652357ab1fe47c47b2102fe085 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.1.22 +Version: 1.4.1.23 Date: 2019-12-10 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 3dcdda28fcd0cfb4962f43c387487d1342d3dbb0..3a87809ba2acea2b2fbc7a53292aeda01d57b8a3 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ -### 1.4.1.22 Release Notes (2019-12-10) +### 1.4.1.23 Release Notes (2019-12-10) #### New features diff --git a/man/RunModel_GR5H.Rd b/man/RunModel_GR5H.Rd new file mode 100644 index 0000000000000000000000000000000000000000..167b7f724fce9acd082da80820cef8f5c7adc91b --- /dev/null +++ b/man/RunModel_GR5H.Rd @@ -0,0 +1,128 @@ +\encoding{UTF-8} + + +\name{RunModel_GR5H} +\alias{RunModel_GR5H} + + +\title{Run with the GR5H hydrological model} + + +\usage{ +RunModel_GR5H(InputsModel, RunOptions, Param) +} + + +\arguments{ +\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details} + +\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details} + +\item{Param}{[numeric] vector of 4 parameters + \tabular{ll}{ + GR5H X1 \tab production store capacity [mm] \cr + GR5H X2 \tab groundwater exchange coefficient [mm/h] \cr + GR5H X3 \tab routing store capacity [mm] \cr + GR5H X4 \tab unit hydrograph time constant [h] \cr + GR5H X5 \tab intercatchment exchange threshold [-] \cr + }} +} + + +\value{ +[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{Interc } \tab [numeric] series of interception store level [mm] \cr + \emph{$Prod } \tab [numeric] series of production store level [mm] \cr + \emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr + \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr + \emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/h] \cr + \emph{$EI } \tab [numeric] series of evapotranspiration from rainfall neutralisation or interception store [mm/h] \cr + \emph{$ES } \tab [numeric] series of evapotranspiration from production store [mm/h] \cr + \emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/h] \cr + \emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/h] \cr + \emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/h] \cr + \emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/h] \cr + \emph{$Rout } \tab [numeric] series of routing store level [mm] \cr + \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr + \emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr + \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr + \emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/h] \cr + \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 simulated discharge [mm/h] \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) +} + + +\description{ +Function which performs a single run for the GR5H hourly lumped model. +} + + +\details{ +For further details on the model, see the references section. +For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. +} + + +\examples{ +library(airGR) + +## load of catchment data +data(L0123003) + +## preparation of the InputsModel object +InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR5H, DatesR = BasinObs$DatesR, + Precip = BasinObs$P, PotEvap = BasinObs$E) + +## run period selection +Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2004-03-01 00:00"), + which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2008-12-31 23:00")) + +## preparation of the RunOptions object +RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR5H, + InputsModel = InputsModel, IndPeriod_Run = Ind_Run) + +## simulation +Param <- c(X1 = 680.673, X2 = -0.255, X3 = 197.651, X4 = 2.384, X5 = 0.174) +OutputsModel <- RunModel_GR5H(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param) + +## results preview +plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) + +## efficiency criterion: Nash-Sutcliffe Efficiency +InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, + RunOptions = RunOptions, Obs = BasinObs$Qmm[Ind_Run]) +OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) +} + + +\author{ +Guillaume Thirel, Olivier Delaigue, Laurent Coron, Andrea Ficchi +} + + +\references{ + +Ficchi, A. (2017). + An adaptive hydrological model for multiple time-steps: + Diagnostics and improvements based on fluxes consistency. + PhD thesis, Irstea (Antony), GRNE (Paris), France. +\cr\cr +Ficchi, A., C. Perrin and V. Andréassian (2019). + Hydrological modelling at multiple sub-daily time steps: model improvement via flux-matching. + Journal of Hydrology, 575, 1308-1327. doi: https://doi.org/10.1016/j.jhydrol.2019.05.084. +} + + +\seealso{ +\code{\link{RunModel_GR4J}}, + \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}. +} +