FAKE FAKE unused badge to avoid problems unused badge to avoid problems

Package Package airGR airGR License License GPL 2 GPL 2 DOI DOI 10.1016/j.envsoft.2017.05.002 10.1016/j.envsoft.2017.05.002

Package Package airGRteaching airGRteaching License License GPL 2 GPL 2



new                        airGRteaching                        new                        free on CRAN                        new

The airGRteaching package has been especially developed to teach hydrological modelling
with the GR rainfall-runoff models ('Shiny' interface included)
Free download on the CRAN
airGRteaching logo

new                        airGRteaching                        new                        free on CRAN                        new

1 What is the airGR package?

1.1 Presentation

airGR logo

airGR is a package which brings into the R software the hydrological modelling tools used and developed at the Catchment Hydrology Research Group of Irstea (France), including the GR rainfall-runoff models and a snowmelt and accumulation model, CemaNeige. Each model core is coded in Fortran to ensure low computational time. The other package functions (i.e. mainly the calibration algorithm and the efficiency criteria calculation) are coded in R.

The airGR package has been designed to fulfill two major requirements: to facilitate the use by non-expert users and to allow flexibility regarding the addition of external criteria, models or calibration algorithms. The names of the functions and their arguments were chosen to this end. airGR also contains basics plotting facilities.

1.2 The airGR hydrological models

Six hydrological models and one snowmelt and accumulation model are implemented in airGR. The snow model can be used alone or together with the daily hydrological models.

The models can be called within airGR using the following functions:

  • RunModel_GR4H(): four-parameter hourly lumped hydrological model (Mathevet 2005)
  • RunModel_GR4J(): four-parameter daily lumped hydrological model (Perrin, Michel, and Andréassian 2003)
  • RunModel_GR5J(): five-parameter daily lumped hydrological model (Le Moine 2008)
  • RunModel_GR6J(): six-parameter daily lumped hydrological model (Pushpalatha et al. 2011)
  • RunModel_GR2M(): two-parameter monthly lumped hydrological model (Mouelhi 2003; Mouelhi et al. 2006a)
  • RunModel_GR1A(): one-parameter yearly lumped hydrological model (Mouelhi 2003; Mouelhi et al. 2006b)
  • RunModel_CemaNeige(): two-parameter degree-day snowmelt and accumulation model (Valéry, Andréassian, and Perrin 2014)
  • RunModel_CemaNeigeGR4J(): combined use of GR4J and CemaNeige
  • RunModel_CemaNeigeGR5J(): combined use of GR5J and CemaNeige
  • RunModel_CemaNeigeGR6J(): combined use of GR6J and CemaNeige

The GRP forecasting model and the Otamin predictive uncertainty tool are not available in airGR.

2 What is the airGRteaching package?

2.1 Presentation

airGRteaching logo

airGRteaching is an add-on package to the airGR package. It simplifies its use and is more specifically oriented towards teaching than airGR. It provides access to the GR rainfall-runoff models (GR4H, GR4J, GR5J, GR6J, GR2M, GR1A) and a snow melt and accumulation model (CemaNeige) with limited programming skills. This package also provides a graphical interface to help students exploring data and model results.

The airGRteaching package has been designed to fulfil a major requirement: facilitating the use of the airGR functionalities by students. The names of the functions and their arguments were chosen to this end.

2.2 Main features of airGRteaching

The package is mostly based on three new families of functions:

  • the functions that allow to complete very simply a hydrological modelling exercise
  • plotting functions to help students to explore observed data and to interpret the results of calibration and simulation of the GR models
  • a function which runs a ‘Shiny’ graphical interface that allows for displaying in real-time model parameters impacts on hydrographs

3 Installation

You can install the two packages with the following command (for airGRteaching, replace airGR with airGRteaching):

install.packages("airGR")

If you use RStudio, you can use the Packages interface :

You can download the airGR source, Windows binaries or Mac OS X binaries on the CRAN.

4 Misc

4.1 How to cite the packages

To cite the airGR and the airGRteaching packages in your scientific document, please use the references returned by the citation() function (replace airGR with airGRteaching for the latter):

citation("airGR")

To cite airGR in publications use these two references:

  Coron, L., Thirel, G., Delaigue, O., Perrin, C. and Andréassian, V. (2017). The Suite of Lumped
  GR Hydrological Models in an R package. Environmental Modelling and Software, 94, 166-171. DOI:
  10.1016/j.envsoft.2017.05.002.

  Coron, L., Perrin, C., Delaigue, O., Thirel, G. and Michel, C. (2018). airGR: Suite of GR
  Hydrological Models for Precipitation-Runoff Modelling. R package version 1.0.10.11. URL:
  https://webgr.irstea.fr/en/airGR/.

To see these entries in BibTeX format, use 'print(<citation>, bibtex=TRUE)', 'toBibtex(.)', or set
'options(citation.bibtex.max=999)'.

To retrieve a “.bib” format for LaTeX documents, you can use the following command:

toBibtex(citation("airGR"))
@Article{,
  title = {The Suite of Lumped {GR} Hydrological Models in an {R} package},
  author = {L. Coron and G. Thirel and O. Delaigue and C. Perrin and V. Andréassian},
  journal = {Environmental Modelling and Software},
  year = {2017},
  pages = {166-171},
  volume = {94},
  doi = {10.1016/j.envsoft.2017.05.002},
}

@Manual{,
  title = {{airGR}: Suite of {GR} Hydrological Models for Precipitation-Runoff Modelling},
  author = {L. Coron and C. Perrin and O. Delaigue and G. Thirel and C. Michel},
  journal = {R News},
  year = {2018},
  note = {R package version 1.0.10.11},
  url = {https://webgr.irstea.fr/en/airGR/},
}

4.2 Known places where airGR is used