Commit 330b8fbe authored by Dorchies David's avatar Dorchies David
Browse files

release: v0.4.0

- Update README.md and DESCRIPTION
Showing with 25 additions and 11 deletions
+25 -11
Package: airGRiwrm
Title: airGR Integrated Water Resource Management
Version: 0.3.4
Version: 0.4.0
Authors@R: c(
person("David", "Dorchies", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-6595-7984"), email = "david.dorchies@inrae.fr"),
person("Olivier", "Delaigue", role = c("ctb"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
......@@ -19,9 +19,9 @@ Imports:
Suggests:
knitr,
rmarkdown,
lattice,
DiagrammeR,
testthat
testthat,
htmltools
VignetteBuilder: knitr
URL: https://gitlab.irstea.fr/in-wop/airGRiwrm
Depends:
......
......@@ -2,34 +2,48 @@
**airGRiwrm** is an extension of the **airGR** R package for managing semi-distributive hydrological model on an anthropized catchment.
This package is developed as part of the IN-WOP project (http://www.waterjpi.eu/joint-calls/joint-call-2018-waterworks-2017/booklet/in-wop) by the mixed research unit G-EAU (https://g-eau.fr).
This package is developed as part of the IN-WOP project (http://www.waterjpi.eu/joint-calls/joint-call-2018-waterworks-2017/booklet/in-wop) by the mixed research unit G-EAU (https://g-eau.fr) and the HYDRO team of the INRAE HYCAR research unit (https://www6.jouy.inrae.fr/hycar/Equipes-de-recherche/HYDRO).
## Installation
### Requirements
This package depends on **airGR** version 1.6. or more which is currently under development. To install it, use the following instruction:
This package depends on R packages installed on CRAN. To install these package use the following instruction in a R console:
```r
install.packages(c("remotes", "dplyr", "roxygen2"))
```
This package also depends on **airGR** version 1.6 and above which is currently under development. To install it, use the following instruction in R console:
```r
remotes::install_gitlab("HYCAR-Hydro/airgr@dev", host = "gitlab.irstea.fr")
```
To run the tutorial vignettes, some other dependencies should also be installed:
```r
install.packages(c("knitr", "rmarkdown", "DiagrammeR", "testthat", "htmltools"))
```
Note: the 'DiagrammeR' package is necessary for running `DiagramGRiwrm` function. This last can also be useful outside the vignettes.
### Local installation
Installation of the package from source should be done in three steps:
Installation of the package from source should be done in four steps:
- download sources
- run `roxygen` for generating `NAMESPACE` file and documentation
- run `roxygen` for generating `NAMESPACE` file and documentation from sources
- install the package
Open a terminal and type:
```shell
git clone git@gitlab-ssh.irstea.fr:in-wop/griwrm.git
cd griwrm
Rscript -e "install.packages(\"roxygen2\");roxygen2::roxygenise()"
git clone https://gitlab.irstea.fr/in-wop/airGRiwrm.git
cd airGRiwrm
Rscript -e "roxygen2::roxygenise()"
cd ..
R CMD INSTALL griwrm
R CMD INSTALL airGRiwrm
```
## Get started
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment