README.md

In HYPEtools: Tools for Processing and Analyzing Files from the Hydrological Catchment Model HYPE

HYPEtools

Summary

HYPEtools provides functions to work with the hydrological model HYPE. HYPE and HYPEtools are projects developed by the Swedish Meteorological and Hydrological Institute (SMHI).

License

HYPEtools is licensed under the LGPL-3.0 license.

Changelog

See the HYPEtools changelog here.

Installation

HYPEtools is on CRAN and can be downloaded with:

install.packages("HYPEtools")

If, however, you would like to install the latest development version of HYPEtools from GitHub, then you can do so with:

# install.packages("devtools")
devtools::install_github("rcapell/HYPEtools") # Install Without Vignettes
devtools::install_github("rcapell/HYPEtools", build_vignettes = T) # Install With Vignettes

More detailed instructions on installing the provided sources or package in R can be found here.

Vignettes

Browse HYPEtools Vignettes with:

browseVignettes("HYPEtools")

Citation

Publication

To cite HYPEtools in publications, please use the following publication reference:

Brendel, C., R. Capell, and A. Bartosova. (2024) Rational gaze: Presenting the open-source HYPEtools R package for analysis, visualization, and interpretation of hydrological models and datasets. Environmental Modelling & Software, 178, 106094. https://doi.org/10.1016/j.envsoft.2024.106094

Software

The HYPEtools software itself can also be cited in publications using the output from running the following in R:

citation("HYPEtools")

HYPEtools documentation built on Sept. 11, 2024, 8:34 p.m.