Adding Snow Hysteresis and Icemelt model

docs/source/api/models.rst

@@ -187,3 +187,167 @@ Class documentation
 .. autoclass:: rrmpg.models.CemaneigeGR4J
   :members:
   :inherited-members:
+
+CemaneigeGR4JIce
+----------------
+This model couples the Cemaneige snow routine and Ice-Melt model with the GR4J model into one model.
+
+.. code-block:: none
+
+  Valéry, A. "Modélisation précipitations – débit sous influence nivale.
+  Élaboration d’un module neige et évaluation sur 380 bassins versants".
+  PhD thesis, Cemagref (Antony), AgroParisTech (Paris), 405 pp. (2010)
+
+  Nepal, S., Chen, J., Penton, D. J., Neumann, L. E., Zheng, H., & Wahid, S. 
+  "Spatial GR4J conceptualization of the Tamor glaciated alpine catchment in Eastern Nepal: 
+  evaluation of GR4JSG against streamflow and MODIS snow extent." Hydrol. Process., 31, 51–68. (2017)
+
+Explanation of the model parameters:
+""""""""""""""""""""""""""""""""""""
+
+* CTG: snow-pack inertia factor
+* Kf: day-degree factor
+* x1: maximum capacity of the production store [mm]
+* x2: groundwater exchange coefficient [mm]
+* x3: one day ahead maximum capacity of the routing store [mm]
+* x4: time base of the unit hydrograph UH1 [days]
+* DDF: degree-day factor for ice melt
+
+
+Model inputs for simulation:
+""""""""""""""""""""""""""""
+
+* prec: Array of daily precipitation sum [mm]
+* mean_temp: Array of the mean temperature [C]
+* min_temp: Array of the minimum temperature [C]
+* max_temp: Array of the maximum temperature [C]
+* etp: Array mean potential evapotranspiration [mm]
+* frac_ice: Array of the fraction of glaciated area in each elevation band. [0 - 1]
+* met_station_height: Height of the meteorological station [m]
+* snow_pack_init: (optional) Initial value of the snow pack storage
+* thermal_state_init: (optional) Initial value of the thermal state of the snow pack
+* s_init: (optional) Initial value of the production storage as fraction of x1. 
+* r_init: (optional) Initial value of the routing storage as fraction of x3.
+* altitudes: (optional) List of median altitudes of each elevation layer [m]
+* return_storages: (optional) Boolean, indicating if the model storages should also be returned
+* params: (optional) Numpy array of parameter sets
+
+
+Class documentation
+"""""""""""""""""""
+
+.. autoclass:: rrmpg.models.CemaneigeGR4JIce
+  :members:
+  :inherited-members:
+
+CemaneigeHystGR4J
+-----------------
+This model couples the Cemaneige snow routine (with Hysteresis) with the GR4J model into one model.
+
+.. code-block:: none
+
+  Valéry, A. "Modélisation précipitations – débit sous influence nivale.
+  Élaboration d’un module neige et évaluation sur 380 bassins versants".
+  PhD thesis, Cemagref (Antony), AgroParisTech (Paris), 405 pp. (2010)
+
+  Riboust, P., Thirel, G., Le Moine, N., Ribstein, P. "Revisiting a simple degree-day model for
+  integrating satellite data: implementation of SWE-SCA hystereses". Jounral of Hydrology and Hydromenchanics,
+  vol. 67, pp. 70-81. (2019)
+
+Explanation of the model parameters:
+""""""""""""""""""""""""""""""""""""
+
+* CTG: snow-pack inertia factor
+* Kf: day-degree factor
+* Thacc: accumulation threshold [mm]
+* Rsp: ratio of melt threshold and mean annual precipitation [0-1]
+* x1: maximum capacity of the production store [mm]
+* x2: groundwater exchange coefficient [mm]
+* x3: one day ahead maximum capacity of the routing store [mm]
+* x4: time base of the unit hydrograph UH1 [days]
+
+
+Model inputs for simulation:
+""""""""""""""""""""""""""""
+
+* prec: Array of daily precipitation sum [mm]
+* mean_temp: Array of the mean temperature [C]
+* min_temp: Array of the minimum temperature [C]
+* max_temp: Array of the maximum temperature [C]
+* etp: Array mean potential evapotranspiration [mm]
+* met_station_height: Height of the meteorological station [m]. 
+* snow_pack_init: (optional) Initial value of the snow pack storage
+* thermal_state_init: (optional) Initial value of the thermal state of the snow pack
+* sca_init: (optional) Initial value of the snow covered area.
+* s_init: (optional) Initial value of the production storage as fraction of x1. 
+* r_init: (optional) Initial value of the routing storage as fraction of x3.
+* altitudes: (optional) List of median altitudes of each elevation layer [m]
+* return_storages: (optional) Boolean, indicating if the model storages should also be returned
+* params: (optional) Numpy array of parameter sets
+
+
+Class documentation
+"""""""""""""""""""
+
+.. autoclass:: rrmpg.models.CemaneigeHystGR4J
+  :members:
+  :inherited-members:
+
+CemaneigeHystGR4JIce
+--------------------
+This model couples the Cemaneige snow routine (with Hysteresis) and Ice-Melt with the GR4J model into one model.
+
+.. code-block:: none
+
+  Valéry, A. "Modélisation précipitations – débit sous influence nivale.
+  Élaboration d’un module neige et évaluation sur 380 bassins versants".
+  PhD thesis, Cemagref (Antony), AgroParisTech (Paris), 405 pp. (2010)
+
+  Riboust, P., Thirel, G., Le Moine, N., Ribstein, P. "Revisiting a simple degree-day model for
+  integrating satellite data: implementation of SWE-SCA hystereses". Jounral of Hydrology and Hydromenchanics,
+  vol. 67, pp. 70-81. (2019)
+
+  Nepal, S., Chen, J., Penton, D. J., Neumann, L. E., Zheng, H., & Wahid, S. 
+  "Spatial GR4J conceptualization of the Tamor glaciated alpine catchment in Eastern Nepal: 
+  evaluation of GR4JSG against streamflow and MODIS snow extent." Hydrol. Process., 31, 51–68. (2017)
+
+Explanation of the model parameters:
+""""""""""""""""""""""""""""""""""""
+
+* CTG: snow-pack inertia factor
+* Kf: day-degree factor
+* Thacc: accumulation threshold [mm]
+* Rsp: ratio of melt threshold and mean annual precipitation [0-1]
+* x1: maximum capacity of the production store [mm]
+* x2: groundwater exchange coefficient [mm]
+* x3: one day ahead maximum capacity of the routing store [mm]
+* x4: time base of the unit hydrograph UH1 [days]
+* DDF: degree-day factor for ice melt
+
+
+Model inputs for simulation:
+""""""""""""""""""""""""""""
+
+* prec: Array of daily precipitation sum [mm]
+* mean_temp: Array of the mean temperature [C]
+* min_temp: Array of the minimum temperature [C]
+* max_temp: Array of the maximum temperature [C]
+* etp: Array mean potential evapotranspiration [mm]
+* frac_ice: Array of the fraction of glaciated area in each elevation band. [0 - 1]
+* met_station_height: Height of the meteorological station [m]. 
+* snow_pack_init: (optional) Initial value of the snow pack storage
+* thermal_state_init: (optional) Initial value of the thermal state of the snow pack
+* sca_init: (optional) Initial value of the snow covered area.
+* s_init: (optional) Initial value of the production storage as fraction of x1. 
+* r_init: (optional) Initial value of the routing storage as fraction of x3.
+* altitudes: (optional) List of median altitudes of each elevation layer [m]
+* return_storages: (optional) Boolean, indicating if the model storages should also be returned
+* params: (optional) Numpy array of parameter sets
+
+
+Class documentation
+"""""""""""""""""""
+
+.. autoclass:: rrmpg.models.CemaneigeHystGR4JIce
+  :members:
+  :inherited-members:

docs/source/conf.py

@@ -202,4 +202,7 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+}
+