Package: airGR 1.7.8

Olivier Delaigue

airGR: Suite of GR Hydrological Models for Precipitation-Runoff Modelling

Hydrological modelling tools developed at INRAE-Antony (HYCAR Research Unit, France). The package includes several conceptual rainfall-runoff models (GR4H, GR5H, GR4J, GR5J, GR6J, GR2M, GR1A) that can be applied either on a lumped or semi-distributed way. A snow accumulation and melt model (CemaNeige) and the associated functions for the calibration and evaluation of models are also included. Use help(airGR) for package description and references.

Authors:Laurent Coron [aut, trl], Olivier Delaigue [aut, cre], Guillaume Thirel [aut, ths], David Dorchies [aut], Charles Perrin [aut, ths], Claude Michel [aut, ths], Vazken Andréassian [ctb, ths], François Bourgin [ctb], Pierre Brigode [ctb], Nicolas Le Moine [ctb], Thibaut Mathevet [ctb], Safouane Mouelhi [ctb], Ludovic Oudin [ctb], Raji Pushpalatha [ctb], Audrey Valéry [ctb]

airGR_1.7.8.tar.gz
airGR_1.7.8.tar.gz(r-4.7-arm64)airGR_1.7.8.tar.gz(r-4.7-x86_64)airGR_1.7.8.tar.gz(r-4.6-arm64)airGR_1.7.8.tar.gz(r-4.6-x86_64)
airGR_1.7.8.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
airGR/json (API)

# Install 'airGR' in R:
install.packages('airGR', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/hydrogr/airgr/issues

Datasets:
  • BasinInfo - Data sample: characteristics of a different catchments
  • BasinInfo - Data sample: characteristics of a different catchments
  • BasinInfo - Data sample: characteristics of a different catchments
  • BasinInfo - Data sample: characteristics of a different catchments
  • BasinObs - Data sample: time series of observations of different catchments
  • BasinObs - Data sample: time series of observations of different catchments
  • BasinObs - Data sample: time series of observations of different catchments
  • BasinObs - Data sample: time series of observations of different catchments
  • Param_Sets_GR4J - Generalist parameter sets for the GR4J model
  • simCNGR4J - Default preview of model outputs
  • simGR4J - Default preview of model outputs

On CRAN:

Conda:

6.77 score 4 stars 5 packages 239 scripts 1.4k downloads 1 mentions 45 exports 0 dependencies

Last updated from:6a98ff9d7b. Checks:6 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64OK209
linux-devel-x86_64OK226
source / vignettesOK328
linux-release-arm64OK240
linux-release-x86_64OK228
wasm-releaseOK449

Exports:CalibrationCalibration_MichelCreateCalibOptionsCreateErrorCrit_GAPXCreateIniStatesCreateInputsCritCreateInputsCrit_LavenneCreateInputsModelCreateRunOptionsDataAltiExtrapolation_ValeryErrorCritErrorCrit_KGEErrorCrit_KGE2ErrorCrit_NSEErrorCrit_RMSEImaxPE_Oudinplot.OutputsModelRunModelRunModel_CemaNeigeRunModel_CemaNeigeGR4HRunModel_CemaNeigeGR4JRunModel_CemaNeigeGR5HRunModel_CemaNeigeGR5JRunModel_CemaNeigeGR6JRunModel_GR1ARunModel_GR2MRunModel_GR4HRunModel_GR4JRunModel_GR5HRunModel_GR5JRunModel_GR6JRunModel_LagSeriesAggregTransfoParamTransfoParam_CemaNeigeTransfoParam_CemaNeigeHystTransfoParam_GR1ATransfoParam_GR2MTransfoParam_GR4HTransfoParam_GR4JTransfoParam_GR5HTransfoParam_GR5JTransfoParam_GR6JTransfoParam_Lag

Dependencies:

Get Started with airGR
Introduction | Loading data | Preparation of functions inputs | InputsModel object | RunOptions object | InputsCrit object | CalibOptions object | Criteria | Calibration | Control | Simulation | Simulation run | Results preview | Efficiency criterion | Features diagram | References
Rendered fromV01_get_started.Rmdusingknitr::rmarkdown

Last update: 2025-12-12
Started: 2017-11-10

Parameter estimation within a Bayesian MCMC framework
Introduction | Scope | Standard Least Squares (SLS) Bayesian inference | MCMC algorithm for Bayesian inference | Estimation of the best-fit parameters as a starting point | Running 3 chains for convergence assessment | MCMC diagnostics and visualisation tools | Exploring further possibilities
Rendered fromV02.2_param_mcmc.Rmdusingknitr::rmarkdown

Last update: 2025-12-12
Started: 2017-11-10

Plugging in new calibration algorithms in airGR
Introduction | Scope | Definition of the necessary function | Local optimization | Global optimization | Differential Evolution | Particle Swarm | MA-LS-Chains | Results | Multiobjective optimization | caRamel
Rendered fromV02.1_param_optim.Rmdusingknitr::rmarkdown

Last update: 2025-12-12
Started: 2017-11-10

Simulated vs observed upstream flows in calibration of semi-distributed GR4J model
Introduction | Scope | Model description | Calibration of the upstream subcatchment | Calibration of the downstream subcatchment | Creation of the InputsModel objects | Calibration with upstream flow observations | Calibration with upstream simulated flow | Calibration with upstream simulated flow and parameter regularisation | Discussion | Identification of Velocity parameter | Value of the performance criteria with theoretical calibration | Parameters and performance of each subcatchment for all calibrations | References
Rendered fromV05_sd_model.Rmdusingknitr::rmarkdown

Last update: 2025-12-12
Started: 2021-01-22

Using satellite snow cover area data for calibrating and improving CemaNeige
Introduction | Scope | Data preparation | loading catchment data | Object model preparation | Calibration and evaluation of the new CemaNeige module | Comparison with the performance of the initial CemaNeige version | References
Rendered fromV04_cemaneige_hysteresis.Rmdusingknitr::rmarkdown

Last update: 2025-12-12
Started: 2019-04-03

Generalist parameter sets for the GR4J model
Introduction | Scope | Data preparation | Object model preparation | Calibration of the GR4J model with the generalist parameter sets | Calibration of the GR4J model with the built-in Calibration_Michel function | GR4J parameter distributions quantiles used in the grid-screening step | GR4J parameter sets used in the grid-screening step | References
Rendered fromV03_param_sets_GR4J.Rmdusingknitr::rmarkdown

Last update: 2023-10-26
Started: 2017-11-10

Readme and manuals

Help Manual

Help pageTopics
Suite of GR Hydrological Models for Precipitation-Runoff ModellingairGR-package airGR
Data sample: characteristics of a different catchmentsBasinInfo
Data sample: time series of observations of different catchmentsBasinObs L0123001 L0123002 L0123003 X0310010
Calibration algorithm that optimises the error criterion selected as objective function using the provided functionsCalibration
Calibration algorithm that optimises the error criterion selected as objective function using the Irstea procedure described by C. MichelCalibration_Michel
Creation of the CalibOptions object required but the Calibration* functionsCreateCalibOptions
Creation of the ErrorCrit_GAPX functionCreateErrorCrit_GAPX
Creation of the IniStates object possibly required by the CreateRunOptions functionsCreateIniStates
Creation of the InputsCrit object required to the ErrorCrit functionsCreateInputsCrit
Creation of the InputsCrit object for Lavenne CriterionCreateInputsCrit_Lavenne
Creation of the InputsModel object required to the RunModel functionsCreateInputsModel [.InputsModel
Creation of the RunOptions object required to the RunModel functionsCreateRunOptions
Altitudinal extrapolation of precipitation and temperature series described by A. ValeryDataAltiExtrapolation_Valery
Error criterion using the provided functionErrorCrit
Error criterion based on the KGE formulaErrorCrit_KGE
Error criterion based on the KGE' formulaErrorCrit_KGE2
Error criterion based on the NSE formulaErrorCrit_NSE
Error criterion based on the RMSEErrorCrit_RMSE
Computation of the maximum capacity of the GR5H interception storeImax
Generalist parameter sets for the GR4J modelParam_Sets_GR4J
Computation of series of potential evapotranspiration at the daily or hourly time steps with Oudin's formulaPE_Oudin
Default preview of model outputsexampleSimPlot plot plot.OutputsModel simCNGR4J simGR4J
Run with the provided hydrological model functionRunModel
Run with the CemaNeige snow moduleRunModel_CemaNeige
Run with the CemaNeigeGR4H hydrological modelRunModel_CemaNeigeGR4H
Run with the CemaNeigeGR4J hydrological modelRunModel_CemaNeigeGR4J
Run with the CemaNeigeGR5H hydrological modelRunModel_CemaNeigeGR5H
Run with the CemaNeigeGR5J hydrological modelRunModel_CemaNeigeGR5J
Run with the CemaNeigeGR6J hydrological modelRunModel_CemaNeigeGR6J
Run with the GR1A hydrological modelRunModel_GR1A
Run with the GR2M hydrological modelRunModel_GR2M
Run with the GR4H hydrological modelRunModel_GR4H
Run with the GR4J hydrological modelRunModel_GR4J
Run with the GR5H hydrological modelRunModel_GR5H
Run with the GR5J hydrological modelRunModel_GR5J
Run with the GR6J hydrological modelRunModel_GR6J
Run with the Lag modelRunModel_Lag
Conversion of time series to another time step (aggregation only) and regime computationSeriesAggreg SeriesAggreg.data.frame SeriesAggreg.InputsModel SeriesAggreg.list SeriesAggreg.OutputsModel
Transformation of the parameters using the provided functionTransfoParam TransfoParam_CemaNeige TransfoParam_CemaNeigeHyst TransfoParam_GR1A TransfoParam_GR2M TransfoParam_GR4H TransfoParam_GR4J TransfoParam_GR5H TransfoParam_GR5J TransfoParam_GR6J TransfoParam_Lag