Preprints
https://doi.org/10.5194/gmd-2021-336
https://doi.org/10.5194/gmd-2021-336

Submitted as: development and technical paper 19 Nov 2021

Submitted as: development and technical paper | 19 Nov 2021

Review status: this preprint is currently under review for the journal GMD.

RavenR v2.1.4: an open source R package to support flexible hydrologic modelling

Robert Chlumsky1, James R. Craig1, Simon G. M. Lin1, Sarah Grass2, Leland Scantlebury1,3, Genevieve Brown4, and Rezgar Arabzadeh1 Robert Chlumsky et al.
  • 1Department of Civil and Environmental Engineering, University of Waterloo, Waterloo, ON, Canada
  • 2Geoprocess Research Associates, Edmonton, AB, Canada
  • 3Department of Land, Air and Water Resources, University of California, Davis, CA, United States
  • 4Northwest Hydraulic Consultants Ltd., North Vancouver, BC, Canada

Abstract. In recent decades, advances in the flexibility and complexity of hydrologic models has enhanced their utility in scientific studies and practice alike. However, the increasing complexity of these tools leads to a number of challenges, including steep learning curves for new users and in the reproducibility of modelling studies. Here, we present the RavenR package, an R package that leverages the power of scripting to both enhance the usability of the Raven hydrologic modelling framework and provide complimentary analyses that are useful for modellers. The RavenR package contains functions that may be useful in each step of the model-building process, particularly for preparing input files and analyzing model outputs, and these tools may be useful even for non-Raven users. The utility of the RavenR package is demonstrated with the presentation of six use cases for a model of the Liard River basin in Canada. These use cases provide examples of visually reviewing the model configuration, preparing input files for observation and forcing data, simplifying the model discretization, performing reality checks on the model output, and evaluating the performance of the model. All of the use cases are fully reproducible, with additional reproducible examples of RavenR functions included with the package distribution itself. It is anticipated that the RavenR package will continue to evolve with the Raven project, and will provide a useful tool to new and experienced users of Raven alike.

Robert Chlumsky et al.

Status: open (until 14 Jan 2022)

Comment types: AC – author | RC – referee | CC – community | EC – editor | CEC – chief editor | : Report abuse

Robert Chlumsky et al.

Data sets

RavenR_manuscript_2021 code and data repository Robert Chlumsky, James R. Craig, Simon G. M. Lin, Sarah Grass, Leland Scantlebury, Genevieve Brown, Rezgar Arabzadeh https://zenodo.org/record/5534818

Model code and software

RavenR v.2.1.4 archived package software Robert Chlumsky, James R. Craig, Simon G. M. Lin, Sarah Grass, Leland Scantlebury, Genevieve Brown, Rezgar Arabzadeh https://doi.org/10.5281/zenodo.5525041

Robert Chlumsky et al.

Viewed

Total article views: 416 (including HTML, PDF, and XML)
HTML PDF XML Total BibTeX EndNote
321 90 5 416 4 5
  • HTML: 321
  • PDF: 90
  • XML: 5
  • Total: 416
  • BibTeX: 4
  • EndNote: 5
Views and downloads (calculated since 19 Nov 2021)
Cumulative views and downloads (calculated since 19 Nov 2021)

Viewed (geographical distribution)

Total article views: 413 (including HTML, PDF, and XML) Thereof 413 with geography defined and 0 with unknown origin.
Country # Views %
  • 1
1
 
 
 
 
Latest update: 29 Nov 2021
Download
Short summary
We introduce the open source RavenR package, which has been built to support the use of the hydrologic modelling framework Raven. The R package contains many functions that may be useful in each step of the model-building process, including preparing model input files, running the model, and analyzing the outputs. We present six reproducible use cases of the RavenR package for the Liard River basin in Canada to demonstrate how it may be deployed.