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

343

Version

1.6.8

License

LGPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Rene Capell

Last Published

September 2nd, 2026

Functions in HYPEtools (1.6.8)

AnnualRegime

Calculate annual regimes
AllDownstreamSubids

Find All Downstream SUBIDs
CleanSLCClasses

Clean Soil-Landuse classes (SLCs) from small fractions
ConvertDischarge

Calculate Specific runoff from volumetric discharge and vice versa
AllUpstreamSubids

Find All Upstream SUBIDs
CalculateRiverDistance

Calculate River Distance Between Two SUBIDs
BoxplotSLCClasses

Box plots of SLC distributions
BarplotUpstreamClasses

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

Create an optpar list
CompareFiles

Compare HYPE model files to identify any differences.
DirectUpstreamSubids

Find Direct Upstream SUBIDs, with Flow Fractions
CustomColors

Custom color ramp palettes
HeadwaterSubids

Find all headwater SUBIDs of a model domain
ExtractStats

Extract statistics from time series
GOF

Goodness of Fit Functions
HYPEtools-package

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

Calculate groundwater retention of nutrients
EquallySpacedObs

Create an equally spaced time series from irregular observations
ExtractFreq

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

Calculate grouped sums for SLC classes in a GeoData file
HypeGeoData

HypeGeoData data frames
LakeDataOutlets

Identify LakeData Outlet SUBIDs
HypeMultiVar

HypeMultiVar arrays
HypeDataExport

Write HYPE data files
HypeSubidChecks

Check HYPE SUBID properties
HypeAttrAccess

Quickly query and set HYPE-specific attributes
HypeDataImport

Read HYPE data files
InfoManipulation

Functions to Manipulate HYPE Info Files
HypeSingleVar

HypeSingleVar arrays
HypeXobs

HypeXobs data frames
OptimisedClasses

Get optimized classes from an imported optpar.txt file
OutletSubids

Find all Outlet SUBIDs of a model domain
MergeXobs

Merge two Xobs data frames
OutletIds

Find Outlet IDs
PartyParrot

Create a Party Parrot.
NSE.HypeSingleVar

Nash-Sutcliffe Efficiency
MapRegionalSources

Map regional irrigation source connection as spatial lines
MergeObs

Merge two HYPE observation data frames
PlotAnnualRegime

Plot annual regimes
OutletNearObs

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

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

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

Plot HYPE model subbasin routing.
PlotEvaluationMaps

Function for plotting up to two HYPE simulation results in maps.
PlotDurationCurve

Plot duration curves
PlotParValues

Plot HYPE model parameter values.
PlotMapOutput

Plot function for HYPE map results.
PlotPerformanceByAttribute

Plot model performance by SUBID attributes
PlotSimObsRegime

Plot annual regimes of simulated and observed variables
PlotMapPoints

Plot function for mapped point information
ReadOptpar

Read an 'optpar.txt' file
ReadBasinOutput

Read a Basin Output File
ReadPar

Read a 'par.txt' file
ReadDescription

Read a 'description.txt' file
ReadClassData

Read a 'ClassData.txt' File
ReadMapOutput

Read a Map Output File
ReadInfo

Read an 'info.txt' file
ReadObs

Read HYPE observation data files
ReadGeoClass

Read a 'GeoClass.txt' File
ReadGeoData

Read a 'GeoData.txt' file
ReadXobs

Read an 'Xobs.txt' file
ReadTimeOutput

Read a Time Output File
ScaleAquiferData

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

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

Read a 'simass.txt' file
RescaleSLCClasses

Re-scale SLC classes in a GeoData data frame
ReadWsOutput

Read optimization simulation results
ReadSubass

Read a 'subassX.txt' file
RunHYPE

Run HYPE model
ReadPmsf

Read a 'pmsf.txt' file
UpstreamGroupSLCClasses

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

Calculate sums of SLC classes in a GeoData file
UpstreamPointSources

Summarize point source emissions of all upstream areas
UpstreamSLCClasses

Calculate SLC class fractions of all upstream areas
SortGeoData

Sort a GeoData dataframe in downstream order
SumUpstreamArea

Calculate upstream area sums
SimToPar

HYPE Calibration Outputs to par.txt
SubidAttributeSummary

Summarize subbasin attributes
ScalePar

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

Calculate upstream sums and averages of selected GeoData contents
WriteBasinOutput

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

Shiny App for visualizing HYPE MapOutputs.
WriteHarmonizedData

Write a Harmonized Data File
WriteGeoClass

Write a 'GeoClass.txt' file
WriteInfo

Write a 'info.txt' File
VariableLookup

Lookup Functions For HYPE Variables
WriteHarmonizedSpatialDescription

Write a Harmonized Spatial Description File
WriteMapOutput

Write a 'mapXXXX.txt' file
VisualizeMapPoints

Shiny App for visualizing Mapped Point Information.
WriteGeoData

Write a 'GeoData.txt' file
merge

Merge HypeGeoData object
distinctColorPalette

Generate optimally distinct color palettes
WriteObs

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

Percent bias
WriteOptpar

Write an 'optpar.txt' File
WritePmsf

Write a 'pmsf.txt' file
WriteTimeOutput

Write a 'timeXXXX.txt' file
WritePar

Write a 'par.txt' File
WriteXobs

Write an 'Xobs.txt' File
r

Pearson product-moment correlation coefficient r