Skip to main content

Python implementation of the Water Table Fluctuation (WTF) Method

Project description

gwtf logo

gwtf: Groundwater Table Fluctuation Method in Python

PyPI version GitHub License DOI Tests

What is gwtf?

gwtf is an open-source Python package for estimating and analyzing groundwater recharge using the Water Table Fluctuation (WTF) method. The package provides tools for event extraction, recharge estimation, and uncertainty analysis, all in a user-friendly and extensible framework.


Code Example

import gwtf

wt = pd.read_csv("head.csv", parse_dates=["date"], index_col="date")

ml = wtf.Model(wt, name="Wagna", mcr=wtf.MCR())
ml.mcr.fit_mcr(wt)

r2= ml.estimate_recharge(rise_rule="rises", sy=0.15)
r.resample("YE").sum().plot(kind="bar", figsize=(10, 2))

Documentation & Examples


Get in Touch


Quick Installation Guide

gwtf requires Python 3.9 or higher. We recommend using Anaconda for easy management of dependencies, but any other Python distribution should work. Check pyproject.toml for the dependencies on other Python packages.

Stable version

pip install gwtf

Update

pip install gwtf --upgrade

Development version

pip install git+https://github.com/raoulcollenteur/gwtf.git@main#egg=gwtf


How to cite gwtf

If you use gwtf in your research, please cite:

Collenteur, R.A. (2025). gwtf: Python implementation of the Water Table Fluctuation (WTF) Method. Zenodo. https://doi.org/10.5281/zenodo.XXXXXXX


License

gwtf is licensed under the GNU General Public License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gwtf-0.2.0.tar.gz (47.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gwtf-0.2.0-py3-none-any.whl (32.7 kB view details)

Uploaded Python 3

File details

Details for the file gwtf-0.2.0.tar.gz.

File metadata

  • Download URL: gwtf-0.2.0.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gwtf-0.2.0.tar.gz
Algorithm Hash digest
SHA256 092287f55d9fb8cb0b9c283955abf64c40cd39f9a99d533f9afef8192aa6651d
MD5 5ab5b170f1cc55081e08df2d676e41ce
BLAKE2b-256 af43c64ec8b9a09a8bbe0f8f8c664e8a6f3ce1ff6955610de120923b46aca3fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for gwtf-0.2.0.tar.gz:

Publisher: python-publish.yml on raoulcollenteur/gwtf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gwtf-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: gwtf-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 32.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gwtf-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4b588d8524ff4363075141325b75c33c54ae6f233f979d3f970191d3f5527e7
MD5 6cf6f5a6b66c54f60f9ab13e3003e662
BLAKE2b-256 f25820a40dc2f7f7a4022aae91e93db1da0c1fc98e72e10c4d327dda1b0bf898

See more details on using hashes here.

Provenance

The following attestation bundles were made for gwtf-0.2.0-py3-none-any.whl:

Publisher: python-publish.yml on raoulcollenteur/gwtf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page