From 946f3a8d1234bd90ef7c6f5cefa0b4e6fb953f15 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.priv>
Date: Mon, 1 Apr 2019 17:18:15 +0200
Subject: [PATCH] v1.2.13.4 DOC: Riboust et al., 2019 ref added in the bib file
 and the cemaNeige_hysteresis vignette

---
 DESCRIPTION                            |  2 +-
 NEWS.rmd                               | 12 ++++++------
 vignettes/V00_airgr_ref.bib            | 17 +++++++++++++++++
 vignettes/V04_cemaneige_hysteresis.Rmd | 11 +++++------
 4 files changed, 29 insertions(+), 13 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 63943ec0..1fcb69b3 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.2.13.3
+Version: 1.2.13.4
 Date: 2019-04-01
 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 a22284f4..3794f1d6 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -13,7 +13,7 @@ output:
 
 
 
-### 1.2.13.3 Release Notes (2019-04-01) 
+### 1.2.13.4 Release Notes (2019-04-01) 
 
 
 
@@ -41,17 +41,17 @@ output:
 
 - <code>CreateInputsCrit()</code> now returns a <code>idLayer</code> element to indicate which layer to use for SCA or SWE aggregation.
 
-- <code>CreateRunOptions()</code>, <code>CreateIniStates()</code> and <code>CreateCalibOptions()</code> now present a <code>IsHyst</code> argument to give the possibility to use the hysteresis with CemaNeige. 
+- <code>CreateRunOptions()</code>, <code>CreateIniStates()</code> and <code>CreateCalibOptions()</code> now present a <code>IsHyst</code> argument to give the possibility to use the Linear Hysteresis with CemaNeige. 
 
 - <code>CreateRunOptions()</code> now presents a <code>warnings</code> argument to replace the verbose action (the <code>verbose</code> argument is kept to print messages).
 
-- <code>CreateCalibOptions()</code> now presents a <code>IsHyst</code> argument to give the possibility to use the hysteresis with CemaNeige.
+- <code>CreateCalibOptions()</code> now presents a <code>IsHyst</code> argument to give the possibility to use the Linear Hysteresis with CemaNeige.
 
-- Added <code>TransfoParam_CemaNeigeHyst()</code> function in order to take into account transformation of the parameters of the CemaNeige module when the hysteresis is used.
+- Added <code>TransfoParam_CemaNeigeHyst()</code> function in order to take into account transformation of the parameters of the CemaNeige module when the Linear Hysteresis is used.
 
-- Added the <code>X0310010</code> dataset to run the examples using the hysteresis with CemaNeige.
+- Added the <code>X0310010</code> dataset to run the examples using the Linear Hysteresis with CemaNeige.
 
-- Added the cemaneige_hysteresis vignette to explain how to manage the use of the hysteresis with CemaNeige.
+- Added the cemaneige_hysteresis vignette to explain how to manage the use of the Linear Hysteresis with CemaNeige.
 
 
 #### Major user-visible changes
diff --git a/vignettes/V00_airgr_ref.bib b/vignettes/V00_airgr_ref.bib
index fea3ee5c..d03ec6b9 100644
--- a/vignettes/V00_airgr_ref.bib
+++ b/vignettes/V00_airgr_ref.bib
@@ -133,4 +133,21 @@
 	month = oct,
 	year = {2014},
 	pages = {8356--8366}
+}
+
+@article{riboust_revisiting_2019,
+	title = {Revisiting a {Simple} {Degree}-{Day} {Model} for {Integrating} {Satellite} {Data}: {Implementation} of {Swe}-{Sca} {Hystereses}},
+	volume = {67},
+	issn = {0042-790X},
+	shorttitle = {Revisiting a {Simple} {Degree}-{Day} {Model} for {Integrating} {Satellite} {Data}},
+	url = {http://content.sciendo.com/view/journals/johh/67/1/article-p70.xml},
+	doi = {10.2478/johh-2018-0004},
+	number = {1},
+	urldate = {2019-02-18},
+	journal = {Journal of Hydrology and Hydromechanics},
+	author = {Riboust, Philippe and Thirel, Guillaume and Moine, Nicolas Le and Ribstein, Pierre},
+	month = mar,
+	year = {2019},
+	keywords = {airGRcite},
+	pages = {70--81}
 }
\ No newline at end of file
diff --git a/vignettes/V04_cemaneige_hysteresis.Rmd b/vignettes/V04_cemaneige_hysteresis.Rmd
index 5cdd867a..432382bc 100644
--- a/vignettes/V04_cemaneige_hysteresis.Rmd
+++ b/vignettes/V04_cemaneige_hysteresis.Rmd
@@ -20,12 +20,12 @@ library(airGR)
 
 Rainfall-runoff models that include a snow accumulation and melt module are still often calibrated using only discharge observations.
   
-After the work of Riboust et al. (2019), we propose now in **airGR** an improved version of the degree-day CemaNeige snow and accumulation module. This new version is based on a more accurate representation of the relationship that exists at the basin scale between the Snow Water Equivalent (SWE) and the Snow Cover Area (SCA). To do so, a linear SWE-SCA hysteresis, which represents the fact that snow accumulation is rather homogeneous and snow melt is more heterogeneous, was implemented.
+After the work of @riboust_revisiting_2019, we propose now in **airGR** an improved version of the degree-day CemaNeige snow and accumulation module. This new version is based on a more accurate representation of the relationship that exists at the basin scale between the Snow Water Equivalent (SWE) and the Snow Cover Area (SCA). To do so, a linear SWE-SCA hysteresis, which represents the fact that snow accumulation is rather homogeneous and snow melt is more heterogeneous, was implemented.
   
 This new CemaNeige version presents two more parameters to calibrate. It also presents the advantage of allowing using satellite snow data to constrain the calibration in addition to discharge. 
-Riboust et al. (2019) show that while the simulated discharge is not significantly improved, the snow simulation is much improved. In addition, they show that the model is more robust (i.e. transferable) in terms of discharge, which has many implications for climate change impact studies.
+@riboust_revisiting_2019 show that while the simulated discharge is not significantly improved, the snow simulation is much improved. In addition, they show that the model is more robust (i.e. transferable) in terms of discharge, which has many implications for climate change impact studies.
   
-The configuration that was identified as optimal by Riboust et al. (2019) includes a CemaNeige module run on 5 elevation bands and an objective function determine by a composite function of KGE' calculated on discharge (75 % weight) and KGE' calculated on each elevation band (5 % for each).
+The configuration that was identified as optimal by @riboust_revisiting_2019 includes a CemaNeige module run on 5 elevation bands and an objective function determine by a composite function of KGE' calculated on discharge (75 % weight) and KGE' calculated on each elevation band (5 % for each).
   
 In this page, we show how to use and calibrate this new CameNeige version. 
   
@@ -94,7 +94,7 @@ CalibOptions <- CreateCalibOptions(FUN_MOD = RunModel_CemaNeigeGR4J,
                                    IsHyst = TRUE)
 ```
 
-In order to calibrate and assess the model performance, we will follow the recommendations of Riboust et al. (2019). This is now possible in **airGR** with the added functionality that permits calculated composite criteria by combining different metrics. 
+In order to calibrate and assess the model performance, we will follow the recommendations of @riboust_revisiting_2019. This is now possible in **airGR** with the added functionality that permits calculated composite criteria by combining different metrics. 
 
 
 ```{r, warning=FALSE}
@@ -242,6 +242,5 @@ We can see below that the performance of the initial model is similar to the new
 However, over the validation period, we see that the discharge simulated by the new version brings better performance (in addition to improved SCA also). This shows the interests of the combined use of an hysteresis and of SCA data for calibration in CemaNeige. 
 
 
-Reference
 
-Riboust, P., Thirel, G., Le Moine, N., and Ribstein, P.: Revisiting a simple degree-day model for integrating satellite data: implementation of SWE-SCA hystereses. Journal of Hydrology and Hydromechanics, DOI: 10.2478/johh-2018-0004, 67, 1, 70–81, 2019.
\ No newline at end of file
+# References
-- 
GitLab