Man pages for HYPEtools
Tools for Processing and Analyzing Files from the Hydrological Catchment Model HYPE

AllDownstreamSubidsFind All Downstream SUBIDs
AllUpstreamSubidsFind All Upstream SUBIDs
AnnualRegimeCalculate annual regimes
BarplotUpstreamClassesBar plots of upstream-averaged classes of HYPE sub-basins
BoxplotSLCClassesBox plots of SLC distributions
CleanSLCClassesClean Soil-Landuse classes (SLCs) from small fractions
CompareFilesCompare HYPE model files to identify any differences.
ConvertDischargeCalculate Specific runoff from volumetric discharge and vice...
CreateOptparCreate an optpar list
CustomColorsCustom color ramp palettes
DirectUpstreamSubidsFind Direct Upstream SUBIDs, with Flow Fractions
distinctColorPaletteGenerate optimally distinct color palettes
EquallySpacedObsCreate an equally spaced time series from irregular...
ExtractFreqExtract quantiles for use in a frequency distribution plot,...
ExtractStatsExtract statistics from time series
GOFGoodness of Fit Functions
GroupSLCClassesCalculate grouped sums for SLC classes in a GeoData file
GwRetentionCalculate groundwater retention of nutrients
HeadwaterSubidsFind all headwater SUBIDs of a model domain
HypeAttrAccessQuickly query and set HYPE-specific attributes
HypeDataExportWrite HYPE data files
HypeDataImportRead HYPE data files
HypeGeoDataHypeGeoData data frames
HypeMultiVarHypeMultiVar arrays
HypeSingleVarHypeSingleVar arrays
HypeSubidChecksCheck HYPE SUBID properties
HYPEtools-packageHYPEtools: Tools for Processing and Analyzing Files from the...
HypeXobsHypeXobs data frames
InfoManipulationFunctions to Manipulate HYPE Info Files
MapRegionalSourcesMap regional irrigation source connection as spatial lines
mergeMerge HypeGeoData object
MergeObsMerge two HYPE observation data frames
MergeXobsMerge two Xobs data frames
NSE.HypeSingleVarNash-Sutcliffe Efficiency
OptimisedClassesGet optimized classes from an imported optpar.txt file
OutletIdsFind Outlet IDs
OutletNearObsFind outlet-near observations in HYPE observation data files.
OutletSubidsFind all Outlet SUBIDs of a model domain
PartyParrotCreate a Party Parrot.
pbias.HypeSingleVarPercent bias
PlotAnnualRegimePlot annual regimes
PlotBasinOutputPlot a suite of time series plots from a HYPE basin output...
PlotBasinSummaryPlot a summary of model results for a single sub-basin
PlotDurationCurvePlot duration curves
PlotMapOutputPlot function for HYPE map results.
PlotMapPointsPlot function for mapped point information
PlotPerformanceByAttributePlot model performance by SUBID attributes
PlotSimObsRegimePlot annual regimes of simulated and observed variables
PlotSubbasinRoutingPlot HYPE model subbasin routing.
rPearson product-moment correlation coefficient r
ReadBasinOutputRead a Basin Output File
ReadClassDataRead a 'ClassData.txt' File
ReadDescriptionRead a 'description.txt' file
ReadGeoClassRead a 'GeoClass.txt' File
ReadGeoDataRead a 'GeoData.txt' file
ReadInfoRead an 'info.txt' file
ReadMapOutputRead a Map Output File
ReadObsRead HYPE observation data files
ReadOptparRead an 'optpar.txt' file
ReadParRead a 'par.txt' file
ReadPmsfRead a 'pmsf.txt' file
ReadSimassRead a 'simass.txt' file
ReadSubassRead a 'subassX.txt' file
ReadTimeOutputRead a Time Output File
ReadWsOutputRead optimization simulation results
ReadXobsRead an 'Xobs.txt' file
RescaleSLCClassesRe-scale SLC classes in a GeoData data frame
ScaleAquiferDataScale 'AquiferData.txt' files to different model time steps
ScaleFloodDataScale 'FloodData.txt' files to different model time steps
ScaleParScale 'par.txt' files to different model time step
SimToParHYPE Calibration Outputs to par.txt
SortGeoDataSort a GeoData dataframe in downstream order
SubidAttributeSummarySummarize subbasin attributes
SumSLCClassesCalculate sums of SLC classes in a GeoData file
SumUpstreamAreaCalculate upstream area sums
UpstreamGeoDataCalculate upstream sums and averages of selected GeoData...
UpstreamGroupSLCClassesCalculate area-weighted upstream averages of grouped SLC...
UpstreamPointSourcesSummarize point source emissions of all upstream areas
UpstreamSLCClassesCalculate SLC class fractions of all upstream areas
VariableLookupLookup Functions For HYPE Variables
VisualizeMapOutputShiny App for visualizing HYPE MapOutputs.
VisualizeMapPointsShiny App for visualizing Mapped Point Information.
WriteBasinOutputWrite a basin output '[SUBID].txt' file
WriteGeoClassWrite a 'GeoClass.txt' file
WriteGeoDataWrite a 'GeoData.txt' file
WriteHarmonizedDataWrite a Harmonized Data File
WriteHarmonizedSpatialDescriptionWrite a Harmonized Spatial Description File
WriteInfoWrite a 'info.txt' File
WriteMapOutputWrite a 'mapXXXX.txt' file
WriteObsWrite 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other...
WriteOptparWrite an 'optpar.txt' File
WriteParWrite a 'par.txt' File
WritePmsfWrite a 'pmsf.txt' file
WriteTimeOutputWrite a 'timeXXXX.txt' file
WriteXobsWrite an 'Xobs.txt' File
HYPEtools documentation built on Sept. 11, 2024, 8:34 p.m.