Package: airGRiwrm 0.7.0.9000

David Dorchies

airGRiwrm: 'airGR' Integrated Water Resource Management

Semi-distributed Precipitation-Runoff Modeling based on 'airGR' package models integrating human infrastructures and their managements.

Authors:David Dorchies [aut, cre], Olivier Delaigue [ctb], Guillaume Thirel [ctb]

airGRiwrm_0.7.0.9000.tar.gz
airGRiwrm_0.7.0.9000.zip(r-4.7)airGRiwrm_0.7.0.9000.zip(r-4.6)airGRiwrm_0.7.0.9000.zip(r-4.5)
airGRiwrm_0.7.0.9000.tgz(r-4.6-any)airGRiwrm_0.7.0.9000.tgz(r-4.5-any)
airGRiwrm_0.7.0.9000.tar.gz(r-4.7-any)airGRiwrm_0.7.0.9000.tar.gz(r-4.6-any)
airGRiwrm_0.7.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
airGRiwrm/json (API)

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

Bug tracker:https://github.com/inrae/airgriwrm/issues

Pkgdown/docs site:https://inrae.github.io

Datasets:
  • Severn - Catchment attributes and hydro-meteorological timeseries for some gauging stations on the Severn River

On CRAN:

Conda:

6.63 score 1 stars 1 packages 45 scripts 817 downloads 29 exports 20 dependencies

Last updated from:06b900c634 (on dev). Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK252
source / vignettesOK325
linux-release-x86_64OK157
macos-release-arm64OK99
macos-oldrel-arm64OK107
windows-develOK137
windows-releaseOK120
windows-oldrelOK142
wasm-releaseOK108

Exports:as.Qm3sCalibrationConvertMeteoSDCreateCalibOptionsCreateControllerCreateGRiwrmCreateInputsCritCreateInputsModelCreateRunOptionsCreateSupervisorextractParamgetAllNodesPropertiesgetDefaultAprioriIdsgetNextTimeStepsgetNodePropertiesgetNodeRankinggetNoSD_IdsgetSD_IdsisNodeDownstreamisNodeUpstreammermaidmermaid_gen_linkplot.GRiwrmplot.mermaidplot.Qm3sreduceGRiwrmRunModelRunModel_ReservoirtransferGRparams

Dependencies:airGRclidplyrgenericsgluejsonlitelifecyclemagrittrpillarpkgconfigpngR6Rcpprlangtibbletidyselectutf8vctrswithrzlib

Severn_06: Modeling a regulated diversion
The study case | Network | GRiwrmInputsModel object | Implementation of the regulation controller | The supervisor | The control logic function | The controller | Running the simulation | Exploring results
Rendered fromV06_Modelling_regulated_diversion.Rmdusingknitr::rmarkdown

Last update: 2024-11-29
Started: 2022-10-27

Severn_05: Modeling ungauged stations
Why modeling Ungauged station in a semi-distributed model? | Presentation of the study case | Using Ungauged stations in the airGRiwrm model | Generation of the GRiwrmInputsModel object | Calibration of the model integrating ungauged nodes | Run the model with the optimized model parameters | References
Rendered fromV05_Modelling_ungauged_nodes.Rmdusingknitr::rmarkdown

Last update: 2024-09-22
Started: 2022-08-10

Severn_03: Calibration of an open-loop influenced flow model network
Presentation of the study case | Conversion of a gauging station into a release spot | Modification of the GRiwrm object | Generation of the GRiwrmInputsModel object | Calibration of the new model | Run of the model with this newly calibrated parameters | Plotting of the results | References
Rendered fromV03_Open-loop_influenced_flow.Rmdusingknitr::rmarkdown

Last update: 2024-08-01
Started: 2020-12-28

Severn_04: Modeling a regulated withdrawal (closed-loop control)
Presentation of the case study | Network configuration | Irrigation objectives and flow demand at intakes | Restriction of irrigation in case of water scarcity | Minimal environmental flow at the intakes | Restriction rules | Implementation of the model | Implementation of the regulation controller | The supervisor | The control logic function | The controller | Running the simulation | References
Rendered fromV04_Closed-loop_regulated_withdrawal.Rmdusingknitr::rmarkdown

Last update: 2024-08-01
Started: 2021-03-07

Severn_02: Calibration of a GR4J semi-distributed model network
Load library | Preparation of function inputs | GRiwrmInputsModel object | GRiwrmRunOptions object | GRiwrmInputsCrit object | GRiwrmCalibOptions object | Calibration | Run the model with the optimized model parameters | Plot the results for each basin
Rendered fromV02_Calibration_SD_model.Rmdusingknitr::rmarkdown

Last update: 2024-07-31
Started: 2020-12-28

Get started with the airGRiwrm package
For getting started several materials are available: | A slide-show of a training on airGRiwrm in French | The vignettes provided with the package with example of use on the Severn River (UK) | An example of use on a large network of 25 nodes on the Seine River (France)
Rendered fromairGRiwrm.Rmdusingknitr::rmarkdown

Last update: 2024-07-28
Started: 2022-07-18

Severn_01: Set up of a semi-distributed GR model network
Description of the example used in this tutorial | Semi-distributed network description | Observation time series | Generation of the GRiwrmInputsModel object | References
Rendered fromV01_Structure_SD_model.Rmdusingknitr::rmarkdown

Last update: 2022-07-18
Started: 2020-12-28

Readme and manuals

Help Manual

Help pageTopics
Coerce data.frame or content of a data.frame into a _Qm3s_ object ready for plottingas.Qm3s
Calibration of the parameters of one catchment or a network of sub-catchmentsCalibration Calibration.GRiwrmInputsModel Calibration.InputsModel
Conversion of meteorological data from basin scale to sub-basin scaleConvertMeteoSD ConvertMeteoSD.character ConvertMeteoSD.GRiwrm ConvertMeteoSD.matrix
Creation of the CalibOptions objectCreateCalibOptions CreateCalibOptions.character CreateCalibOptions.function CreateCalibOptions.GRiwrmInputsModel CreateCalibOptions.InputsModel CreateCalibOptions.RunModel_Reservoir
Creation and adding of a controller in a supervisorCreateController
Generation of a network description containing all hydraulic nodes and the description of their connectionsCreateGRiwrm GRiwrm
Creation of the InputsCrit object required to the 'ErrorCrit' functionsCreateInputsCrit CreateInputsCrit.GRiwrmInputsModel CreateInputsCrit.InputsModel
Generic function for creating 'InputsModel' object for either *airGR* or *airGRiwrm*CreateInputsModel CreateInputsModel.default
Creation of an InputsModel object for an *airGRiwrm* networkCreateInputsModel.GRiwrm
Creation of the RunOptions objectCreateRunOptions CreateRunOptions.character CreateRunOptions.function CreateRunOptions.GRiwrmInputsModel CreateRunOptions.InputsModel
Creation of a Supervisor for handling regulation in a modelCreateSupervisor
Extract calibrated parametersextractParam extractParam.GRiwrmOutputsCalib extractParam.GRiwrmOutputsModel
Get default AprioriIds from direct upstream nodes of each nodegetDefaultAprioriIds
Get the next time steps date/time of a simulationgetNextTimeSteps
Properties of GRiwrm nodesgetAllNodesProperties getNodeProperties
Sorting of the nodes from upstream to downstream for RunModel and CalibrationgetNodeRanking
Function to get the IDs of sub-basins using SD model or notgetNoSD_Ids getSD_Ids
Check if a node is downstream or upstream another oneisNodeDownstream isNodeDownstream.GRiwrm isNodeDownstream.GRiwrmInputsModel isNodeUpstream isNodeUpstream.GRiwrm isNodeUpstream.GRiwrmInputsModel
Merge Two outputs of airGR simulationsmerge.GRiwrmOutputsModel merge.OutputsModel
Plot a mermaid diagrammermaid mermaid_gen_link plot.mermaid
Plot of a diagram representing the network structure of a GRiwrm objectplot.GRiwrm
Function which creates screen plots giving an overview of the model outputs in the GRiwrm networkplot.GRiwrmOutputsModel
Plot simulated reservoir volume, inflows and released flows time series on a reservoir nodeplot.OutputsModelReservoir
Plot of a 'Qm3s' object (time series of simulated flows)plot.Qm3s
Reduce the size of a GRiwrm by selecting the subset of nodes corresponding to a downstream nodereduceGRiwrm
RunModel function for both *airGR* InputsModel and GRiwrmInputsModel objectRunModel
Run with a reservoir modelRunModel_Reservoir
RunModel function for _GRiwrmInputsModel_ objectRunModel.GRiwrmInputsModel
RunModel for hot restart after a previous simulation periodRunModel.GRiwrmOutputsModel
Wrapper for airGR::RunModel for one sub-basinRunModel.InputsModel
RunModel function for a SupervisorRunModel.Supervisor
Catchment attributes and hydro-meteorological timeseries for some gauging stations on the Severn RiverSevern
Sort a GRiwrm network in upstream-downstream order ready for Calibrationsort.GRiwrm
Transfer GR parameters from one donor sub-basin to a receiver sub-basintransferGRparams