README.md 1.82 KB
Newer Older
Dorchies David's avatar
Dorchies David committed
1
2
# IRMaRA

3
4
5
6
7
8
Interactive Reservoir MAnagement Risk assessment (IRMaRA) is a R Shiny interface providing probability of failure of flood and drought objective at key locations downstream of the 4 lakes regulating the Seine River.

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->

9
10
## Installation

Dorchies David's avatar
Dorchies David committed
11
### Requirements
12

13
A database of reservoir management risk assessment must have been created with the 'rvgest' package. See documentation of 'rvgest' for further information.
Dorchies David's avatar
Dorchies David committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27

### Local installation steps

Installation of the package from source should be done in 3 steps:

- download sources
- run `roxygen` for generating `NAMESPACE` file and documentation from sources
- install the package

### Download sources

First possibility, clone the repository with git (recommended):

If you have configured a SSH key for gitlab (See: https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html): `git clone git@gitlab-ssh.irstea.fr:in-wop/irmara.git`
28

Dorchies David's avatar
Dorchies David committed
29
30
31
32
33
34
35
36
37
38
Otherwise, use HTTPS: `git clone https://gitlab.irstea.fr/in-wop/irmara.git`

Second possibility, download the source code at https://gitlab.irstea.fr/in-wop/irmara/-/archive/master/irmara-master.zip

### Build and install the package

Open the project file `irmara.Rproj` in RStudio and type:

```
roxygen2::roxygenise()
39
remotes::install_local()
Dorchies David's avatar
Dorchies David committed
40
```
41
42
43

## Usage

44
The "inst/cdf" folder must be populated by sqlite file(s) with risk data. See 'rvgest' package to produce them.
45

46
Run the Shiny interface with:
Dorchies David's avatar
Dorchies David committed
47

48
49
50
```r
irmara::run_app()
```
Dorchies David's avatar
Dorchies David committed
51

52
53
54
## Code of Conduct

Please note that the irmara project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.