peterson-tim-j/HydroSight

Open-source data-driven hydrogeological insights
855 Downloads
Updated 29 Mar 2023

HydroSight: Open-source data-driven hydrogeological insights

Testing Codecov GitHub release View HydroSight on File Exchange Github All Releases GitHub license GitHub forks GitHub stars

HydroSight is statistical toolbox for data-driven insights into groundwater dynamics and aquifer properties. Many hundreds of bores can be easily analysed, all without any programming, to quantify:

Installation Options

HydroSight is operating system independent and has been tested on Windows 10+ and Linux (Ubuntu 20.04 LTS). There are four installation options:

  1. Stand-alone app within Windows. The latest .exe is available here.
  2. Install Hydrosight Matlab source code by (i) downloading the source code, (ii) unzipping the downloaded file, (ii) setting the Matlab Current Folder to where the file was unzipped and (iv) entering HydroSight into the Matlab Command Window.
  3. Install Hydrosight from within Matlab using the Add-Ons menu item and searching for HydroSight. From the Add button select Add to Matlab. Once installed, enter HydroSight into the Matlab Command Window.
  4. Compile your own stand-alone app from within Matlab by (i) downloading the source code and (ii) running the command: makeStandaloneHydroSight()

For futher details see the installation wiki page.

Examples

Multiple examples are built into the HydroSight GUI, each highlighting aspects of the above papers. Soon, each example will be supported by online videos. In the meantime major aspects of the graphical interface and the algorithms are outlined on the wiki page.

HydroSight can also be run from the Matlab command window. For an example of this see here.

What does HydroSight look like?

The HydroSight graphical interface includes tabs for each step in the modelling of groundwater hydrographs:

  1. Project documentation.
  2. Hydrograph outlier detection.
  3. Time-series model construction, specifically defining the data and the form of the model.
  4. Model calibration and tools to examine the internal dynamics of the calibrated model, e.g. recharge. The screenshot below shows this tab and an estimate of the annual groundwater recharge.
  5. Model simulations, allowing hydrograph decomposition, exploration of scenarios (e.g. different climate or pumping), hindcasting and interpolation.

HydroSight Recharge estimation

Contributing

HydroSight is an ongoing research project and that depends upon your support. Two easy ways to support us are:

  1. Give us a GitHub ⭐.
  2. Cite the relevant papers (using the "Cite Project" option within the GUI).

And, if HydroSight doesn't do what you need then Support gives more options.

Cite As

Tim Peterson (2024). peterson-tim-j/HydroSight (https://github.com/peterson-tim-j/HydroSight/releases/tag/V1.41.4), GitHub. Retrieved .

Shapoori, V., et al. “Decomposing Groundwater Head Variations into Meteorological and Pumping Components: a Synthetic Study.” Hydrogeology Journal, vol. 23, no. 7, Springer Science and Business Media LLC, May 2015, pp. 1431–48, doi:10.1007/s10040-015-1269-7.

View more styles
MATLAB Release Compatibility
Created with R2022a
Compatible with R2018b and later releases
Platform Compatibility
Windows macOS Linux
Categories
Find more on Oceanography and Hydrology in Help Center and MATLAB Answers

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

GUI

GUI/icons

GUI/models

GUI/questdlg_timer

GUI/rdir

GUI/splash

GUI/uical

algorithms

algorithms/HPCoffload

algorithms/calibration/CMA_ES

algorithms/calibration/DREAM

algorithms/calibration/DREAM/diagnostics

algorithms/calibration/SP_UCI

algorithms/calibration/Utilities

algorithms/calibration/Utilities/InterPointDistanceMatrix

algorithms/models

algorithms/models/ExpSmooth

algorithms/models/TransferNoise

algorithms/models/TransferNoise/Example_model

algorithms/models/TransferNoise/ForcingTransformation

algorithms/models/TransferNoise/ForcingTransformation/derivedTransformations

algorithms/models/TransferNoise/ForcingTransformation/stochasticTransformations

algorithms/models/TransferNoise/ResponseFunctions

algorithms/models/TransferNoise/ResponseFunctions/DerivedFunctions

algorithms/outlierDetection

algorithms/utilities

testing

Versions that use the GitHub default branch cannot be downloaded

Version Published Release Notes
1.41.4.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/V1.41.4

1.41.2.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/v1.41.2

1.41.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/v1.41.0

1.40.2.1

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/v1.40.2.1

1.40.2

Major update of the GUI and model performance.
* Outlier detection now over an order of magnitude faster.
* All calibration schemes, including DREAM, and now operational.
* Efficient creation of models and the extensive examination of model results.

1.35.0

This release refines the TFN soil moisture modules and resolves the some important bugs/weaknesses. See https://github.com/peterson-tim-j/HydroSight/releases for details.

1.27.0.0

GitHub link updated.

1.3.5.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.3.5

1.3.1.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.3.1

1.2.7.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.2.7

1.2.6.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.2.6

1.2.5.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.2.5

1.2.2.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.2.2

1.2.1.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/1.2.1

1.2.0.0

See release notes for this release on GitHub: https://github.com/peterson-tim-j/HydroSight/releases/tag/v1.2

1.1.0.0

Package renamed to "HydroSight".
Highly flexible GUI added. The GUI can also be ran as a standalone application.

1.0.0.0

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.