From 88db83a415ac97742353fc06245c40255535f6e7 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Thu, 21 Jan 2021 17:50:46 +0100
Subject: [PATCH] docs(Fortran): fix references

---
 src/frun_CEMANEIGE.f90 | 15 ++++++++-------
 src/frun_GR1A.f90      | 18 +++++++++---------
 src/frun_GR2M.f90      |  2 +-
 src/frun_GR4H.f90      | 11 ++++++++---
 src/frun_GR4J.f90      | 14 +++++++-------
 src/frun_GR5H.f90      | 17 ++++++-----------
 src/frun_GR5J.f90      |  4 ++--
 src/frun_GR6J.f90      |  2 +-
 src/frun_PE.f90        |  6 +++---
 9 files changed, 45 insertions(+), 44 deletions(-)

diff --git a/src/frun_CEMANEIGE.f90 b/src/frun_CEMANEIGE.f90
index 31d4fa46..2d659015 100644
--- a/src/frun_CEMANEIGE.f90
+++ b/src/frun_CEMANEIGE.f90
@@ -15,19 +15,20 @@
 !------------------------------------------------------------------------------
 ! REFERENCES
 ! Riboust, P., Thirel, G., Le Moine, N. and Ribstein, P. (2019). Revisiting a
-! simple degree-day model for integrating satellite data: implementation of
-! SWE-SCA hystereses. Journal of Hydrology and Hydromechanics,
-! 67, 1, 70–81, doi: 10.2478/johh-2018-0004.
+! simple degree-day model for integrating satellite data: Implementation of
+! SWE-SCA hystereses. Journal of Hydrology and Hydromechanics, 67(1), 70–81,
+! doi: 10.2478/johh-2018-0004.
 !
 ! Valéry, A., Andréassian, V. and Perrin, C. (2014). "As simple as possible but
-! not simpler": what is useful in a temperature-based snow-accounting routine?
-! Part 1 - Comparison of six snow accounting routines on 380 catchments,
-! Journal of Hydrology, doi: 10.1016/j.jhydrol.2014.04.059.
+! not simpler": What is useful in a temperature-based snow-accounting routine?
+! Part 1 - Comparison of six snow accounting routines on 380 catchments.
+! Journal of Hydrology, 517(0), 1166-1175, doi: 10.1016/j.jhydrol.2014.04.059.
 !
 ! Valéry, A., Andréassian, V. and Perrin, C. (2014). "As simple as possible but
 ! not simpler": What is useful in a temperature-based snow-accounting routine?
 ! Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on
-! 380 catchments, Journal of Hydrology, doi: 10.1016/j.jhydrol.2014.04.058.
+! 380 catchments. Journal of Hydrology, 517(0), 1176-1187,
+! doi: 10.1016/j.jhydrol.2014.04.058.!
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
 !         1. frun_cemaneige
diff --git a/src/frun_GR1A.f90 b/src/frun_GR1A.f90
index 7178ddfb..29d01064 100644
--- a/src/frun_GR1A.f90
+++ b/src/frun_GR1A.f90
@@ -14,9 +14,9 @@
 ! Last modified: 25/11/2019
 !------------------------------------------------------------------------------
 ! REFERENCES
-! Mouelhi S. (2003). Vers une chaîne cohérente de modèles pluie-débit 
-! conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et 
-! journalier. PhD thesis (in French), ENGREF, Cemagref Antony, France.
+! Mouelhi S. (2003). Vers une chaîne cohérente de modèles pluie-débit
+! conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et
+! journalier. PhD thesis (in French), ENGREF - Cemagref Antony, France.
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
 !         1. frun_gr1a
@@ -27,7 +27,7 @@
       SUBROUTINE frun_gr1a(LInputs,InputsPrecip,InputsPE,NParam,Param, &
                            NStates,StateStart,NOutputs,IndOutputs, &
                            Outputs,StateEnd)
-! Subroutine that initializes GR1A, get its parameters, performs the call 
+! Subroutine that initializes GR1A, get its parameters, performs the call
 ! to the MOD_GR1A subroutine at each time step, and stores the final states
 ! Inputs
 !       LInputs      ! Integer, length of input and output series
@@ -39,7 +39,7 @@
 !       StateStart   ! Vector of real, state variables used when the model run starts (none here)
 !       NOutputs     ! Integer, number of output series
 !       IndOutputs   ! Vector of integer, indices of output series
-! Outputs      
+! Outputs
 !       Outputs      ! Vector of real, output series
 !       StateEnd     ! Vector of real, state variables at the end of the model run (none here)
 
@@ -60,7 +60,7 @@
       ! out
       doubleprecision, dimension(NStates), intent(out) :: StateEnd
       doubleprecision, dimension(LInputs,NOutputs), intent(out) :: Outputs
-      
+
       !! locals
       integer :: I,K
       integer, parameter :: NMISC=3
@@ -70,7 +70,7 @@
       !--------------------------------------------------------------
       ! Initializations
       !--------------------------------------------------------------
-            
+
       ! parameter values
       ! Param(1) : PE adjustment factor [-]
 
@@ -131,7 +131,7 @@
       integer, parameter :: NMISC=3
       integer, parameter :: NParam=1
       doubleprecision :: tt ! speed-up
-      
+
       !! dummies
       ! in
       doubleprecision, dimension(NParam), intent(in) :: Param
@@ -139,7 +139,7 @@
       ! out
       doubleprecision, dimension(NMISC), intent(out) :: MISC
       doubleprecision, intent(out) :: Q
-      
+
 
 ! Runoff
       ! speed-up
diff --git a/src/frun_GR2M.f90 b/src/frun_GR2M.f90
index 86597910..3bedfebb 100644
--- a/src/frun_GR2M.f90
+++ b/src/frun_GR2M.f90
@@ -16,7 +16,7 @@
 ! REFERENCES
 ! Mouelhi S. (2003). Vers une chaîne cohérente de modèles pluie-débit
 ! conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et
-! journalier. PhD thesis (in French), ENGREF, Cemagref Antony, France.
+! journalier. PhD thesis (in French), ENGREF - Cemagref Antony, France.
 !
 ! Mouelhi, S., Michel, C., Perrin, C. and Andréassian, V. (2006). Stepwise
 ! development of a two-parameter monthly water balance model. Journal of
diff --git a/src/frun_GR4H.f90 b/src/frun_GR4H.f90
index 0b883c3b..48335719 100644
--- a/src/frun_GR4H.f90
+++ b/src/frun_GR4H.f90
@@ -14,9 +14,14 @@
 ! Last modified: 25/11/2019
 !------------------------------------------------------------------------------
 ! REFERENCES
-! Perrin, C., Michel, C. and Andréassian, V. (2003). Improvement of a
-! parsimonious model for streamflow simulation. Journal of Hydrology,
-! 279(1-4), 275-289, doi: 10.1016/S0022-1694(03)00225-7.
+! Mathevet, T. (2005). Quels modèles pluie-débit globaux pour le pas de temps
+! horaire ? Développement empirique et comparaison de modèles sur un large
+! échantillon de bassins versants. PhD thesis (in French), ENGREF - Cemagref
+! Antony, Paris, France.
+!
+! Le Moine, N. (2008). Le bassin versant de surface vu par le souterrain : une
+! voie d'amélioration des performances et du réalisme des modèles pluie-débit ?
+! PhD thesis (in French), UPMC - Cemagref Antony, Paris, France.
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
 !         1. frun_gr4h
diff --git a/src/frun_GR4J.f90 b/src/frun_GR4J.f90
index 3dcfe98b..bfba7078 100644
--- a/src/frun_GR4J.f90
+++ b/src/frun_GR4J.f90
@@ -14,8 +14,8 @@
 ! Last modified: 25/11/2019
 !------------------------------------------------------------------------------
 ! REFERENCES
-! Perrin, C., Michel, C. and Andréassian, V. (2003). Improvement of a 
-! parsimonious model for streamflow simulation. Journal of Hydrology, 
+! Perrin, C., Michel, C. and Andréassian, V. (2003). Improvement of a
+! parsimonious model for streamflow simulation. Journal of Hydrology,
 ! 279(1-4), 275-289, doi: 10.1016/S0022-1694(03)00225-7.
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
@@ -27,7 +27,7 @@
       SUBROUTINE frun_gr4j(LInputs,InputsPrecip,InputsPE,NParam,Param, &
                            NStates,StateStart,NOutputs,IndOutputs, &
                            Outputs,StateEnd)
-! Subroutine that initializes GR4J, get its parameters, performs the call 
+! Subroutine that initializes GR4J, get its parameters, performs the call
 ! to the MOD_GR4J subroutine at each time step, and stores the final states
 ! Inputs
 !       LInputs      ! Integer, length of input and output series
@@ -39,7 +39,7 @@
 !       StateStart   ! Vector of real, state variables used when the model run starts (store levels [mm] and Unit Hydrograph (UH) storages [mm])
 !       NOutputs     ! Integer, number of output series
 !       IndOutputs   ! Vector of integer, indices of output series
-! Outputs      
+! Outputs
 !       Outputs      ! Vector of real, output series
 !       StateEnd     ! Vector of real, state variables at the end of the model run (store levels [mm] and Unit Hydrograph (UH) storages [mm])
 
@@ -60,7 +60,7 @@
       ! out
       doubleprecision, dimension(NStates), intent(out) :: StateEnd
       doubleprecision, dimension(LInputs,NOutputs), intent(out) :: Outputs
-      
+
       !! locals
       integer :: I,K
       integer, parameter :: NH=20,NMISC=30
@@ -98,7 +98,7 @@
       ! computation of UH ordinates
       OrdUH1 = 0.
       OrdUH2 = 0.
-      
+
       D=2.5
       CALL UH1(OrdUH1,Param(4),D)
       CALL UH2(OrdUH2,Param(4),D)
@@ -209,7 +209,7 @@
         Sr = St(1)/A
         ER=St(1)*(2.-Sr)*TWS/(1.+(1.-Sr)*TWS)
         ! ER=X(2)*(2.-X(2)/A)*tanHyp(WS)/(1.+(1.-X(2)/A)*tanHyp(WS))
-        ! end speed-up  
+        ! end speed-up
         AE=ER+P1
         St(1)=St(1)-ER
         PS=0.
diff --git a/src/frun_GR5H.f90 b/src/frun_GR5H.f90
index ee267c98..2027f47c 100644
--- a/src/frun_GR5H.f90
+++ b/src/frun_GR5H.f90
@@ -14,18 +14,13 @@
 ! Last modified: 26/11/2019
 !------------------------------------------------------------------------------
 ! REFERENCES
-! Ficchì, A., Perrin, C. and Andréassian, V. (2019). Hydrological modelling at
-! multiple sub-daily time steps: model improvement via flux-matching, Journal
-! of Hydrology, 575, 1308-1327, doi: 10.1016/j.jhydrol.2019.05.084.
-!
-! Le Moine, N. (2008). Le bassin versant de surface vu par le souterrain : une
-! voie d'amélioration des performances et du réalisme des modèles
-! pluie-débit ? PhD thesis (French), UPMC, Paris, France.
+! Ficchi, A. (2017). An adaptive hydrological model for multiple time-steps:
+! Diagnostics and improvements based on fluxes consistency. PhD thesis,
+! UPMC - Irstea Antony, Paris, France.
 !
-! Pushpalatha, R., Perrin, C., Le Moine, N., Mathevet, T. and Andréassian, V.
-! (2011). A downward structural sensitivity analysis of hydrological models to
-! improve low-flow simulation. Journal of Hydrology, 411(1-2), 66-76,
-! doi: 10.1016/j.jhydrol.2011.09.034.
+! Ficchi, A., Perrin, C. and Andréassian, V. (2019). Hydrological modelling at
+! multiple sub-daily time steps: model improvement via flux-matching. Journal
+! of Hydrology, 575, 1308-1327, doi: 10.1016/j.jhydrol.2019.05.084.
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
 !         1. frun_gr5h
diff --git a/src/frun_GR5J.f90 b/src/frun_GR5J.f90
index 3c47e4f3..47d3c796 100644
--- a/src/frun_GR5J.f90
+++ b/src/frun_GR5J.f90
@@ -15,8 +15,8 @@
 !------------------------------------------------------------------------------
 ! REFERENCES
 ! Le Moine, N. (2008). Le bassin versant de surface vu par le souterrain : une
-! voie d'amélioration des performances et du réalisme des modèles
-! pluie-débit ? PhD thesis (French), UPMC, Paris, France.
+! voie d'amélioration des performances et du réalisme des modèles pluie-débit ?
+! PhD thesis (in French), UPMC - Cemagref Antony, Paris, France.
 !
 ! Pushpalatha, R., Perrin, C., Le Moine, N., Mathevet, T. and Andréassian, V.
 ! (2011). A downward structural sensitivity analysis of hydrological models to
diff --git a/src/frun_GR6J.f90 b/src/frun_GR6J.f90
index 2f6cf48c..f5a6e8a9 100644
--- a/src/frun_GR6J.f90
+++ b/src/frun_GR6J.f90
@@ -16,7 +16,7 @@
 ! REFERENCES
 ! Pushpalatha, R., Perrin, C., Le Moine, N., Mathevet, T. and Andréassian, V.
 ! (2011). A downward structural sensitivity analysis of hydrological models to
-! improve low-flow simulation. Journal of Hydrology, 411(1-2), 66-76.
+! improve low-flow simulation. Journal of Hydrology, 411(1-2), 66-76,
 ! doi: 10.1016/j.jhydrol.2011.09.034.
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
diff --git a/src/frun_PE.f90 b/src/frun_PE.f90
index 5c70b8fb..123191b9 100644
--- a/src/frun_PE.f90
+++ b/src/frun_PE.f90
@@ -16,9 +16,9 @@
 ! REFERENCES
 ! Oudin, L., Hervieu, F., Michel, C., Perrin, C., Andréassian, V.,
 ! Anctil, F. and Loumagne, C. (2005). Which potential evapotranspiration
-! input for a rainfall-runoff model? Part 2 - Towards a simple and
-! efficient PE model for rainfall-runoff modelling. Journal of Hydrology
-! 303(1-4), 290-306.
+! input for a lumped rainfall-runoff model? Part 2 - Towards a simple and
+! efficient potential evapotranspiration model for rainfall-runoff modelling.
+! Journal of Hydrology, 303(1-4), 290-306, doi: 10.1016/j.jhydrol.2004.08.026.
 !------------------------------------------------------------------------------
 ! Quick description of public procedures:
 !         1. frun_pe_oudin
-- 
GitLab