R hydrological modelling packages

class: title-slide, left, middle

<h1> Hydrological modelling with R packages </h1>

<br>

<h3> Guillaume Thirel <br> <em>INRAE, HYCAR Research Unit, France</em> </h3>
<br>
<br>
.small[<svg aria-hidden="true" role="img" viewBox="0 0 576 512" style="height:1em;width:1.12em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:lightgrey;overflow:visible;position:relative;"><path d="M280.37 148.26L96 300.11V464a16 16 0 0 0 16 16l112.06-.29a16 16 0 0 0 15.92-16V368a16 16 0 0 1 16-16h64a16 16 0 0 1 16 16v95.64a16 16 0 0 0 16 16.05L464 480a16 16 0 0 0 16-16V300L295.67 148.26a12.19 12.19 0 0 0-15.3 0zM571.6 251.47L488 182.56V44.05a12 12 0 0 0-12-12h-56a12 12 0 0 0-12 12v72.61L318.47 43a48 48 0 0 0-61 0L4.34 251.47a12 12 0 0 0-1.6 16.9l25.5 31A12 12 0 0 0 45.15 301l235.22-193.74a12.19 12.19 0 0 1 15.3 0L530.9 301a12 12 0 0 0 16.9-1.6l25.5-31a12 12 0 0 0-1.7-16.93z"/></svg> [https://webgr.inrae.fr](webgr.inrae.fr)  
<svg aria-hidden="true" role="img" viewBox="0 0 512 512" style="height:1em;width:1em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:lightgrey;overflow:visible;position:relative;"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg> [@G_Thirel](https://twitter.com/G_Thirel)
]

.title-logo-box[![](./static/img/rhydro_logo_alt.png)]

---
layout: true

<div class="my-header">Hydrological modelling with R </div>

<div class="my-footer"><span> Guillaume Thirel, INRAE @G_Thirel   </span></div>

---
class: left

# Context

Thousands of R packages exist.

Slater et al. (2019):

- an overview of interesting packages in the hydrological workflow 
- but there was no space for going into much details

We focus here on hydrological modelling

It is a primordial step in the hydrological workflow

---

# Rationale of this work

Hundreds of hydrological models exist, some are available in R

From the user point of view, there is a need for guidance in choosing a package:
- hydrological models fit different purposes
- packages present different functionalities 
- uneven quality of documentation

In this work, we focused on:
- the differences between models
- the necessary model inputs
- the documentation
- the implementation

And we propose simple R codes to run these packages

---

# Aims of this presentation

To give an overview of:

- 8 available hydrological modelling R packages

- available hydrological models in these R packages

# What you will not get from this presentation but only from reading the paper

- how to run each package/model  
  (see the supplementary material of the paper)

- an in-depth explanation of all hydrological models

---

# Collaborative international work led by Paul C. Astagneau

---
class: center

# List of packages selected and the models they propose

| Package      | Repository | Hydrological models | Snow model|
|:-----------  |------      |------               |-----|
| airGR        | <center><image src = "static\img\Rlogo.svg" width="45px" ></image></center>       | GR models | `\(\checkmark\)`|
| dynatopmodel | <center><image src = "static\img\Rlogo.svg" width="45px" ></image></center>       | Dynamic TOPMODEL | |
| HBV.IANIGLA  | <center><image src = "static\img\Rlogo.svg" width="45px" ></image></center>       | HBV |  `\(\checkmark\)`|
| hydromad     | <center><image src = "static\img\GitHub_Logo.png" width="40px" ></image></center>      | IHACRES&nbsp;AWBM&nbsp;GR4J&nbsp;Sacramento | `\(\checkmark\)`|
|      sacsmaR | <center><image src = "static\img\GitHub_Logo.png" width="40px"></image></center>      | Sacramento | `\(\checkmark\)`|
|     topmodel | <center><image src = "static\img\Rlogo.svg" width="45px" ></image></center>       | TOPMODEL 1995 | |
|     TUWmodel | <center><image src = "static\img\Rlogo.svg" width="45px" ></image></center>       | Modified HBV | `\(\checkmark\)`|
|       WALRUS | <center><image src = "static\img\GitHub_Logo.png" width="40px" ></image></center>      | WALRUS | `\(\checkmark\)`|

---
class: inverse, middle, center

# Analysis from a modeller perspective

---
class: left, middle

# Differences in spatial resolution

The snow models

---
class: left, middle

# Differences in spatial resolution

The hydrological models

|Package     | Model                | Lumped | HRUs | Sub-catchments | Routing between HRUs and/or subcatchments |
|:-----------|:------               | :------: | :----: | :-----------: | :------: |
|airGR       | GR4J                 | `\(\checkmark\)`       |      | `\(\checkmark\)`               | |
|dynatopmodel| TOPMODEL (dynamic)   |        | `\(\checkmark\)`     |                | `\(\checkmark\)` |
|HBV.IANIGLA | HBV                  | `\(\checkmark\)`       |      |                | |
|hydromad    | GR4J                 | `\(\checkmark\)`       |      |                | |
|hydromad    | IHACRES-CMD          | `\(\checkmark\)`       |      |                | |
|hydromad    | Sacramento           | `\(\checkmark\)`       |      |                | |
|sacsmaR     | Sacramento           | `\(\checkmark\)`       | `\(\checkmark\)`     | `\(\checkmark\)`     | `\(\checkmark\)`|
|topmodel    | TOPMODEL (1995)      | `\(\sim\)` | `\(\sim\)` |                | `\(\checkmark\)`|  
|TUWmodel    | Modified HBV         | `\(\checkmark\)`       | `\(\sim\)` | `\(\sim\)` | `\(\checkmark\)`|
|WALRUS      | WALRUS               | `\(\checkmark\)`       |      |                | ||

---

# Unified diagrams of models

---
class: inverse, middle, center

# Analysis from a package user perspective

---
class: left, middle

# Models inputs

---
class: left, middle

# Models outputs

|Package                 | Model(s)   | TS of AET and TS of RC    | TS of internal fluxes          | TS of store levels     |  Spatially distributed|
|:------------   |:------         |:------:          |:-----:        |:------------:      |:------:|
| airGR         | GR models     | `\(\checkmark\)` | `\(\checkmark\)`   | `\(\checkmark\)`     |   |
| dynatopmodel  | Dynamic TOPMODEL      | `\(\checkmark\)` |  `\(\sim\)`             | `\(\checkmark\)`     |  `\(\checkmark\)` |
| HBV.IANIGLA   | HBV           | `\(\checkmark\)` | `\(\sim\)` |  `\(\checkmark\)`     |   |
| hydromad     | GR4J          | `\(\checkmark\)` | `\(\sim\)` | `\(\checkmark\)`      ||
|                        | IHACRES-CMD   | `\(\checkmark\)` | `\(\sim\)` |  `\(\checkmark\)`       | 
|                        | Sacramento    | `\(\checkmark\)` |     |       `\(\checkmark\)`        |       |
| sacsmaR       | Sacramento    |   |     |          
| topmodel      | TOPMODEL 1995 | `\(\checkmark\)` | `\(\sim\)` |                  | `\(\checkmark\)`  |
| TUWmodel      | Modified HBV  | `\(\checkmark\)` | `\(\sim\)` |  `\(\checkmark\)`     | `\(\checkmark\)`  | 
| WALRUS        | WALRUS        | `\(\checkmark\)` | `\(\checkmark\)`   | `\(\checkmark\)`     |    | | 
 
---
class: left, middle

# Package functionalities

---
class: left, middle

#CPU times

---
class: left, middle

# Running the hydrological models

Example codes are provided at https://doi.org/10.15454/3PPKCL