Learn R Programming

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")

Copy Link

Version

Install

install.packages('HYPEtools')

Monthly Downloads

630

Version

1.6.6

License

LGPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Rene Capell

Last Published

August 19th, 2025

Functions in HYPEtools (1.6.6)

GwRetention

Calculate groundwater retention of nutrients
HypeAttrAccess

Quickly query and set HYPE-specific attributes
GOF

Goodness of Fit Functions
ExtractStats

Extract statistics from time series
DirectUpstreamSubids

Find Direct Upstream SUBIDs, with Flow Fractions
HeadwaterSubids

Find all headwater SUBIDs of a model domain
EquallySpacedObs

Create an equally spaced time series from irregular observations
GroupSLCClasses

Calculate grouped sums for SLC classes in a GeoData file
ExtractFreq

Extract quantiles for use in a frequency distribution plot, e.g. a flow duration curve
HYPEtools-package

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

Write HYPE data files
HypeXobs

HypeXobs data frames
HypeMultiVar

HypeMultiVar arrays
HypeSingleVar

HypeSingleVar arrays
HypeDataImport

Read HYPE data files
HypeGeoData

HypeGeoData data frames
MergeObs

Merge two HYPE observation data frames
HypeSubidChecks

Check HYPE SUBID properties
MapRegionalSources

Map regional irrigation source connection as spatial lines
InfoManipulation

Functions to Manipulate HYPE Info Files
NSE.HypeSingleVar

Nash-Sutcliffe Efficiency
MergeXobs

Merge two Xobs data frames
OutletIds

Find Outlet IDs
PlotBasinSummary

Plot a summary of model results for a single sub-basin
PartyParrot

Create a Party Parrot.
PlotBasinOutput

Plot a suite of time series plots from a HYPE basin output file
PlotAnnualRegime

Plot annual regimes
OutletSubids

Find all Outlet SUBIDs of a model domain
OptimisedClasses

Get optimized classes from an imported optpar.txt file
OutletNearObs

Find outlet-near observations in HYPE observation data files.
ReadDescription

Read a 'description.txt' file
PlotSimObsRegime

Plot annual regimes of simulated and observed variables
PlotDurationCurve

Plot duration curves
ReadBasinOutput

Read a Basin Output File
ReadGeoClass

Read a 'GeoClass.txt' File
ReadClassData

Read a 'ClassData.txt' File
PlotMapPoints

Plot function for mapped point information
PlotPerformanceByAttribute

Plot model performance by SUBID attributes
PlotSubbasinRouting

Plot HYPE model subbasin routing.
PlotMapOutput

Plot function for HYPE map results.
ReadPar

Read a 'par.txt' file
ReadMapOutput

Read a Map Output File
ReadOptpar

Read an 'optpar.txt' file
ReadSubass

Read a 'subassX.txt' file
ReadInfo

Read an 'info.txt' file
ReadGeoData

Read a 'GeoData.txt' file
ReadObs

Read HYPE observation data files
ReadPmsf

Read a 'pmsf.txt' file
ReadSimass

Read a 'simass.txt' file
ReadTimeOutput

Read a Time Output File
RescaleSLCClasses

Re-scale SLC classes in a GeoData data frame
ScaleAquiferData

Scale 'AquiferData.txt' files to different model time steps
ReadXobs

Read an 'Xobs.txt' file
ScaleFloodData

Scale 'FloodData.txt' files to different model time steps
ReadWsOutput

Read optimization simulation results
SubidAttributeSummary

Summarize subbasin attributes
RunHYPE

Run HYPE model
SimToPar

HYPE Calibration Outputs to par.txt
SortGeoData

Sort a GeoData dataframe in downstream order
ScalePar

Scale 'par.txt' files to different model time step
VariableLookup

Lookup Functions For HYPE Variables
UpstreamSLCClasses

Calculate SLC class fractions of all upstream areas
VisualizeMapOutput

Shiny App for visualizing HYPE MapOutputs.
UpstreamPointSources

Summarize point source emissions of all upstream areas
UpstreamGeoData

Calculate upstream sums and averages of selected GeoData contents
SumUpstreamArea

Calculate upstream area sums
SumSLCClasses

Calculate sums of SLC classes in a GeoData file
WriteBasinOutput

Write a basin output '[SUBID].txt' file
UpstreamGroupSLCClasses

Calculate area-weighted upstream averages of grouped SLC class fractions.
VisualizeMapPoints

Shiny App for visualizing Mapped Point Information.
WriteInfo

Write a 'info.txt' File
WritePar

Write a 'par.txt' File
WritePmsf

Write a 'pmsf.txt' file
WriteOptpar

Write an 'optpar.txt' File
WriteGeoClass

Write a 'GeoClass.txt' file
WriteGeoData

Write a 'GeoData.txt' file
WriteHarmonizedSpatialDescription

Write a Harmonized Spatial Description File
WriteHarmonizedData

Write a Harmonized Data File
WriteObs

Write 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other observation data files
WriteMapOutput

Write a 'mapXXXX.txt' file
pbias.HypeSingleVar

Percent bias
r

Pearson product-moment correlation coefficient r
WriteTimeOutput

Write a 'timeXXXX.txt' file
merge

Merge HypeGeoData object
WriteXobs

Write an 'Xobs.txt' File
distinctColorPalette

Generate optimally distinct color palettes
AnnualRegime

Calculate annual regimes
BoxplotSLCClasses

Box plots of SLC distributions
AllDownstreamSubids

Find All Downstream SUBIDs
CreateOptpar

Create an optpar list
ConvertDischarge

Calculate Specific runoff from volumetric discharge and vice versa
CompareFiles

Compare HYPE model files to identify any differences.
BarplotUpstreamClasses

Bar plots of upstream-averaged classes of HYPE sub-basins
CustomColors

Custom color ramp palettes
AllUpstreamSubids

Find All Upstream SUBIDs
CleanSLCClasses

Clean Soil-Landuse classes (SLCs) from small fractions