From e25d6bc43f04e4137b3d377aae4d4d2b9e01da72 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Wed, 6 Jan 2021 08:00:45 +0100
Subject: [PATCH] v1.6.3.76 docs(man): improve description of SnowPack Output
from RunModel_CemaNeige functions Refs #79
---
DESCRIPTION | 4 ++--
NEWS.md | 2 +-
man/RunModel_CemaNeige.Rd | 2 +-
man/RunModel_CemaNeigeGR4H.Rd | 42 +++++++++++++++++------------------
man/RunModel_CemaNeigeGR4J.Rd | 42 +++++++++++++++++------------------
man/RunModel_CemaNeigeGR5H.Rd | 2 +-
man/RunModel_CemaNeigeGR5J.Rd | 42 +++++++++++++++++------------------
man/RunModel_CemaNeigeGR6J.Rd | 2 +-
8 files changed, 69 insertions(+), 69 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 40e4e2c4..15b30dac 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,8 +1,8 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.6.3.75
-Date: 2021-01-04
+Version: 1.6.3.76
+Date: 2021-01-05
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
diff --git a/NEWS.md b/NEWS.md
index c60eaf79..3462add7 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -4,7 +4,7 @@
-### 1.6.3.75 Release Notes (2021-01-04)
+### 1.6.3.76 Release Notes (2021-01-05)
#### New features
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index f430f813..0d0afd20 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -40,7 +40,7 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/time step] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/time step] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState} \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/time step] \cr
diff --git a/man/RunModel_CemaNeigeGR4H.Rd b/man/RunModel_CemaNeigeGR4H.Rd
index e97b5cd3..0204920e 100644
--- a/man/RunModel_CemaNeigeGR4H.Rd
+++ b/man/RunModel_CemaNeigeGR4H.Rd
@@ -40,29 +40,29 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\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{$Prod } \tab [numeric] series of production store level [mm] \cr
- \emph{$Pn } \tab [numeric] series of net rainfall [mm/h] \cr
- \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/h] \cr
- \emph{$AE } \tab [numeric] series of actual evapotranspiration [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/h] \cr
- \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h] \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{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \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{$Prod } \tab [numeric] series of production store level [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall [mm/h] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/h] \cr
+ \emph{$AE } \tab [numeric] series of actual evapotranspiration [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/h] \cr
+ \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h] \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{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent)[mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/h] \cr
diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd
index 99e09453..7c2aef74 100644
--- a/man/RunModel_CemaNeigeGR4J.Rd
+++ b/man/RunModel_CemaNeigeGR4J.Rd
@@ -40,29 +40,29 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\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/d] \cr
- \emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \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/d] \cr
- \emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
- \emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
- \emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
- \emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
- \emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
- \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \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/d] \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 simulated discharge [mm/d] \cr
- \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \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/d] \cr
+ \emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
+ \emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
+ \emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
+ \emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
+ \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \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/d] \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 simulated discharge [mm/d] \cr
+ \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
diff --git a/man/RunModel_CemaNeigeGR5H.Rd b/man/RunModel_CemaNeigeGR5H.Rd
index f7059f4c..3e9353a0 100644
--- a/man/RunModel_CemaNeigeGR5H.Rd
+++ b/man/RunModel_CemaNeigeGR5H.Rd
@@ -65,7 +65,7 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/h] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/h] \cr
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index 6f5b2bf4..3572376e 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -41,29 +41,29 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\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/d] \cr
- \emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \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/d] \cr
- \emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
- \emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
- \emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
- \emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
- \emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
- \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \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/d] \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 simulated discharge [mm/d] \cr
- \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \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/d] \cr
+ \emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
+ \emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
+ \emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
+ \emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
+ \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \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/d] \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 simulated discharge [mm/d] \cr
+ \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index f1d936c9..9e1fee57 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -66,7 +66,7 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
--
GitLab