timflow

A Python package for the modeling of multi-layer groundwater flow with analytic elements.
https://github.com/timflow-org/timflow

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

analytic-element-method groundwater hydrology modeling python

Keywords from Contributors

pastas modflow arctic data-management observations

Last synced: about 9 hours ago
JSON representation

Repository metadata

Analytic element modeling of groundwater flow

README.md

PyPI - Version
General
Steady
Transient
Documentation Status
Ruff

timflow, a multi-layer analytic element model

timflow is a Python package for the modeling of multi-layer groundwater flow with analytic
elements. The package is split into two main submodules: timflow.steady for steady-state flow
and timflow.transient for modeling transient flow. Both modules may be applied to an
arbitrary number of aquifers and leaky layers. The head, flow, and leakage between
aquifers may be computed semi-analytically at any point in space and time.

The design
of timflow is object-oriented and has been kept simple and flexible.
New analytic elements may be added to the code without making any changes in the
existing part of the code. timflow is coded in Python and uses numba to speed up
evaluation of the line elements and inverse Laplace transforms.
The transient submodule is based on the Laplace-transform analytic element
method. The solution is computed analytically in the Laplace domain and converted back
to the time domain numerically usig the algorithm of De Hoog, Stokes, and Knight.

Installation

timflow requires Python >= 3.11 and can be installed from PyPI:

pip install timflow

To install all optional dependencies (for running tests and building docs):

pip install timflow[dev]

Documentation

The documentation is hosted on readthedocs.

History

timflow combines the old packages TimML
and TTim. Git history is maintained within this new package, but the old repositories are still available for searching through old issues, pull requests, and other information.

Citation

Some of the papers that you may want to cite when using timflow are:

  • Steady-state flow:
  • Transient flow:
    • M. Bakker. 2013. Semi-analytic modeling of transient multi-layer flow with TTim.
      Hydrogeology Journal, 21: 935-943. https://doi.org/10.1007/s10040-013-0975-2
    • M .Bakker. 2013. Analytic modeling of transient multi-layer flow. In: Advances in
      Hydrogeology, edited by P Mishra and K Kuhlman, Springer, Heidelberg, 95-114. Available here.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Bakker"
    given-names: "Mark"
    orcid: "https://orcid.org/0000-0002-5629-2861"
title: "timflow"
url: "https://github.com/timflow-org/timflow"

references:
  - type: article
    authors:
      - family-names: "Bakker"
        given-names: "Mark"
        orcid: "https://orcid.org/0000-0002-5629-2861"
      - family-names: "Strack"
        given-names: "Otto D.L."
    doi: "10.1016/S0022-1694(02)00319-0"
    journal: "Journal of Hydrology"
    title: "Analytic elements for multiaquifer flow"
    volume: 271
    number: 1
    start: 119
    end: 129
    year: 2003
  - type: article
    authors:
      - family-names: "Bakker"
        given-names: "Mark"
        orcid: "https://orcid.org/0000-0002-5629-2861"
    doi: "10.1007/s10040-013-0975-2"
    journal: "Hydrogeology Journal"
    title: "Semi-analytic modeling of transient multi-layer flow with TTim"
    volume: 21
    start: 935
    end: 943
    year: 2013

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 1,120
Total Committers: 11
Avg Commits per committer: 101.818
Development Distribution Score (DDS): 0.479

Commits in past year: 350
Committers in past year: 7
Avg Commits per committer in past year: 50.0
Development Distribution Score (DDS) in past year: 0.337

Name Email Commits
Mark Bakker m****k@g****m 583
dbrakenhoff d****f@a****l 488
Mattijs Borst 4****t 18
Justin Jent j****r@g****m 9
xzyang43 5****3 8
Huite h****a@g****m 4
Raoul Collenteur r****r@g****m 3
Hannah Heesen H****n@s****l 3
BasdeRidder b****2@g****m 2
JoerivanEngelen j****n@h****m 1
Hugo Lapré g****b@t****l 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 61
Total pull requests: 38
Average time to close issues: about 1 month
Average time to close pull requests: 3 days
Total issue authors: 12
Total pull request authors: 7
Average comments per issue: 0.87
Average comments per pull request: 1.63
Merged pull request: 29
Bot issues: 0
Bot pull requests: 0

Past year issues: 61
Past year pull requests: 38
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 3 days
Past year issue authors: 12
Past year pull request authors: 7
Past year average comments per issue: 0.87
Past year average comments per pull request: 1.63
Past year merged pull request: 29
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/timflow-org/timflow

Top Issue Authors

  • dbrakenhoff (29)
  • mbakker7 (20)
  • MattBrst (2)
  • rubencalje (2)
  • raoulcollenteur (1)
  • justuskrantz (1)
  • ougx (1)
  • Sietse-AG (1)
  • jholst-delta (1)
  • yslinnemann (1)
  • Huite (1)
  • tomvansteijn (1)

Top Pull Request Authors

  • dbrakenhoff (16)
  • mbakker7 (13)
  • HsHeesen (3)
  • raoulcollenteur (2)
  • MattBrst (2)
  • BasdeRidder (1)
  • martinvonk (1)

Top Issue Labels

  • steady (24)
  • enhancement (18)
  • transient (17)
  • documentation (6)
  • bug (3)

Top Pull Request Labels

  • enhancement (4)
  • bug (3)
  • documentation (2)

Package metadata

pypi.org: timflow

Analytic element modeling of groundwater flow

  • Homepage:
  • Documentation: https://timflow.readthedocs.io/
  • Licenses: MIT License
  • Latest release: 0.3.0 (published 11 days ago)
  • Last Synced: 2026-06-19T20:00:56.442Z (2 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1,756 Last month
  • Rankings:
    • Dependent packages count: 7.872%
    • Average: 26.189%
    • Dependent repos count: 44.505%
  • Maintainers (2)

Score: 14.43417554251133