Metadata-Version: 2.4
Name: timflow
Version: 0.2.0
Summary: Analytic element modeling of groundwater flow
Author: Mark Bakker, Davíd Brakenhoff
Maintainer-email: Mark Bakker <markbak@gmail.com>, Davíd Brakenhoff <d.brakenhoff@artesia-water.nl>
License: MIT License
        
        Copyright (c) 2026 timflow-org
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/timflow-org/timflow
Project-URL: repository, https://github.com/timflow-org/timflow
Project-URL: documentation, https://timflow.readthedocs.io/en/latest/
Keywords: hydrology,groundwater,model,analytic element method
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: numba
Requires-Dist: matplotlib
Requires-Dist: pandas
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Provides-Extra: parallel
Requires-Dist: tqdm; extra == "parallel"
Provides-Extra: optional
Requires-Dist: timflow[parallel]; extra == "optional"
Requires-Dist: lmfit; extra == "optional"
Provides-Extra: ci
Requires-Dist: timflow[lint,optional]; extra == "ci"
Requires-Dist: pytest; extra == "ci"
Requires-Dist: pytest-cov; extra == "ci"
Requires-Dist: pytest-xdist; extra == "ci"
Requires-Dist: nbval; extra == "ci"
Requires-Dist: jupyter; extra == "ci"
Requires-Dist: shapely; extra == "ci"
Provides-Extra: docs
Requires-Dist: timflow[ci]; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: myst_nb; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: sphinx-autoapi; extra == "docs"
Provides-Extra: dev
Requires-Dist: timflow[docs]; extra == "dev"
Dynamic: license-file

<img src="./docs/_static/timflow_logo.jpeg" width="300">

[![PyPI - Version](https://img.shields.io/pypi/v/timflow)](https://pypi.org/project/timflow/)
[![General](https://github.com/timflow-org/timflow/actions/workflows/ci-general.yml/badge.svg)](https://github.com/timflow-org/timflow/actions/workflows/ci-general.yml)
[![Steady](https://github.com/timflow-org/timflow/actions/workflows/ci-steady.yml/badge.svg)](https://github.com/timflow-org/timflow/actions/workflows/ci-steady.yml)
[![Transient](https://github.com/timflow-org/timflow/actions/workflows/ci-transient.yml/badge.svg)](https://github.com/timflow-org/timflow/actions/workflows/ci-transient.yml)
[![Documentation Status](https://readthedocs.org/projects/timflow/badge/?version=latest)](https://timflow.readthedocs.io/en/latest/?badge=latest)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/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](https://timflow.readthedocs.io).

## History

`timflow` combines the old packages [`TimML`](https://github.com/mbakker7/timml)
and [`TTim`](https://github.com/mbakker7/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:
  * Bakker, M., and O.D.L. Strack. 2003. Analytic Elements for Multiaquifer Flow.
  Journal of Hydrology, 271(1-4), 119-129. [https://doi.org/10.1016/S0022-1694(02)00319-0](https://doi.org/10.1016/S0022-1694(02)00319-0)
* 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](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](https://github.com/mbakker7/timflow/blob/master/papers/2013_bakker_ttim_theory.pdf).

