airGRdatassim: Ensemble-Based Data Assimilation with GR Hydrological Models
In airGRdatassim: Ensemble-Based Data Assimilation with GR Hydrological Models
Description
Add-on to the 'airGR' package which provides the tools to assimilate observed discharges in daily GR hydrological models. The package consists in two functions allowing to perform the assimilation of observed discharges via the Ensemble Kalman filter or the Particle filter as described in Piazzi et al. (2021) <doi:10.1029/2020WR028390>. airGRdatassim currently runs on daily hydrological models (GR4J, GR5J and GR6J, with and without the CemaNeige snow model). The package is developed at INRAE-Antony (Catchment Hydrology research group of the HYCAR Research Unit, France). More information about the efficiency of these data assimilation schemes with GR5J can be found in Piazzi et al. (accepted).
## — Functions and objects
The airGRdatassim package allows users of GR hydrological models to assimilate discharge observations with the aim of improving streamflow simulations.
The package has been designed to allow the choice between two sequential ensemble-based data assimilation (DA) techniques, namely the Ensemble Kalman filter (EnKF) and the Particle filter (PF).
The functions are coded in R and both their names and arguments are consistent with the airGR package.
With the aim of providing a user-friendly package, airGRdatassim relies on two main functions:
- CreateInputsPert generates the probabilistic model inputs to perform ensemble-based DA when accounting for the uncertainty in meteorological forcings;
- RunModel_DA performs streamflow ensemble simulations with the assimilation of observed discharges through the EnKF or the PF schemes.
Consistently with the airGR package, both structure and class of function arguments are specifically defined to prevent from mis-use and to ensure the flexibility of functions. Advanced users wishing to apply the package to their own models will need to comply with these imposed structures and refer to the package source codes to get all the specification requirements.
## — Models
DA schemes are designed to be coupled with GR daily hydrological models, which are implemented in the airGR package. These models can be called within the airGRdatassim package using the following airGR functions (use the command '?airGR' to get the references of the GR models):
- RunModel_GR4J: four-parameter daily lumped hydrological model
- RunModel_GR5J: five-parameter daily lumped hydrological model
- RunModel_GR6J: six-parameter daily lumped hydrological model
- RunModel_CemaNeigeGR4J: combined use of GR4J and CemaNeige
- RunModel_CemaNeigeGR5J: combined use of GR5J and CemaNeige
- RunModel_CemaNeigeGR6J: combined use of GR6J and CemaNeige
## — How to get started
Because airGRdatassim is an airGR-based package, specific airGR functions should be jointly used to ensure the proper use of the airGRdatassim tools. Indeed, before performing the DA-based streamflow simulations, the hydrological model needs to be calibrated through the airGR calibration function. Therefore, the following steps are recommended:
1. refer to the help for Calibration_Michel in the airGR package, run the provided example and then refer to the help for CreateCalibOptions to understand how a model calibration is prepared/made;
2. refer to the help for CreateInputsPert to understand how the probabilistic model inputs are generated, if the uncertainty in meteorological forcings is taken into account;
3. refer to the help for RunModel_DA to understand how to perform the DA-based streamflow simulations;
4. refer to the help for ErrorCrit_NSE and CreateInputsCrit in the airGR package to understand how the computation of an error criterion is prepared/made.
For more information and to get started with the package, you can refer to the vignette:
vignette("get_started", package = "airGRdatassim").
## — References
- Piazzi, G., Thirel, G., Perrin, C. and Delaigue, O. (accepted). Sequential data assimilation for streamflow forecasting: assessing the sensitivity to uncertainties and updated variables of a conceptual hydrological model. Water Resources Research, doi: 10.1029/2020WR028390.
airGRdatassim documentation built on Feb. 11, 2021, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description
Add-on to the 'airGR' package which provides the tools to assimilate observed discharges in daily GR hydrological models. The package consists in two functions allowing to perform the assimilation of observed discharges via the Ensemble Kalman filter or the Particle filter as described in Piazzi et al. (2021) <doi:10.1029/2020WR028390>. airGRdatassim currently runs on daily hydrological models (GR4J, GR5J and GR6J, with and without the CemaNeige snow model). The package is developed at INRAE-Antony (Catchment Hydrology research group of the HYCAR Research Unit, France). More information about the efficiency of these data assimilation schemes with GR5J can be found in Piazzi et al. (accepted).
## — Functions and objects
The airGRdatassim package allows users of GR hydrological models to assimilate discharge observations with the aim of improving streamflow simulations.
The package has been designed to allow the choice between two sequential ensemble-based data assimilation (DA) techniques, namely the Ensemble Kalman filter (EnKF) and the Particle filter (PF).
The functions are coded in R and both their names and arguments are consistent with the airGR package.
With the aim of providing a user-friendly package, airGRdatassim relies on two main functions:
- CreateInputsPert generates the probabilistic model inputs to perform ensemble-based DA when accounting for the uncertainty in meteorological forcings;
- RunModel_DA performs streamflow ensemble simulations with the assimilation of observed discharges through the EnKF or the PF schemes.
Consistently with the airGR package, both structure and class of function arguments are specifically defined to prevent from mis-use and to ensure the flexibility of functions. Advanced users wishing to apply the package to their own models will need to comply with these imposed structures and refer to the package source codes to get all the specification requirements.
## — Models
DA schemes are designed to be coupled with GR daily hydrological models, which are implemented in the airGR package. These models can be called within the airGRdatassim package using the following airGR functions (use the command '?airGR' to get the references of the GR models):
- RunModel_GR4J: four-parameter daily lumped hydrological model
- RunModel_GR5J: five-parameter daily lumped hydrological model
- RunModel_GR6J: six-parameter daily lumped hydrological model
- RunModel_CemaNeigeGR4J: combined use of GR4J and CemaNeige
- RunModel_CemaNeigeGR5J: combined use of GR5J and CemaNeige
- RunModel_CemaNeigeGR6J: combined use of GR6J and CemaNeige
## — How to get started
Because airGRdatassim is an airGR-based package, specific airGR functions should be jointly used to ensure the proper use of the airGRdatassim tools. Indeed, before performing the DA-based streamflow simulations, the hydrological model needs to be calibrated through the airGR calibration function. Therefore, the following steps are recommended:
1. refer to the help for Calibration_Michel in the airGR package, run the provided example and then refer to the help for CreateCalibOptions to understand how a model calibration is prepared/made;
2. refer to the help for CreateInputsPert to understand how the probabilistic model inputs are generated, if the uncertainty in meteorological forcings is taken into account;
3. refer to the help for RunModel_DA to understand how to perform the DA-based streamflow simulations;
4. refer to the help for ErrorCrit_NSE and CreateInputsCrit in the airGR package to understand how the computation of an error criterion is prepared/made.
For more information and to get started with the package, you can refer to the vignette:
vignette("get_started", package = "airGRdatassim").
## — References
- Piazzi, G., Thirel, G., Perrin, C. and Delaigue, O. (accepted). Sequential data assimilation for streamflow forecasting: assessing the sensitivity to uncertainties and updated variables of a conceptual hydrological model. Water Resources Research, doi: 10.1029/2020WR028390.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.