gwrefpy

January 15, 2026 · View on GitHub

gwrefpy

gwrefpy

PyPI version Python versions License Documentation Build status Ruff GitHub stars

A Python package for detection of deviations in groundwater time series.

Features

  • Manage reference and observation wells with ease
  • Programmatically fit observation wells to reference wells
  • Visualize fits and deviations
  • Save your work, share and pick up later with a custom .gwref file format
  • Review statistics on fits and deviations

Installation

Using uv or pip:

uv install gwrefpy
# or
pip install gwrefpy

Documentation

See the documentation for more information on how to use gwrefpy.

Contributing

Contributions are welcome! File an issue or submit a pull request on GitHub. We recommend uv for development.

git clone https://github.com/sgfsweden/gwrefpy.git
cd gwrefpy

uv sync --all-groups

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Thanks to Svenska Geotekniska Förening for funding the development of this package.