ttim


Namettim JSON
Version 0.6.6 PyPI version JSON
download
home_page
SummaryTransient multi-layer AEM Model
upload_time2024-02-14 11:54:52
maintainer
docs_urlNone
authorMark Bakker
requires_python>=3.8
licenseThe MIT License (MIT) Copyright (c) 2015 mbakker7 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.
keywords hydrology groundwater model analytic element method
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![ttim](https://github.com/mbakker7/ttim/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/mbakker7/ttim/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/mbakker7/ttim/badge.svg?branch=master)](https://coveralls.io/github/mbakker7/ttim?branch=master)
![PyPI](https://img.shields.io/pypi/v/ttim?color=green)

# TTim, A Multi-Layer, Transient, Analytic Element Model

## Introduction

TTim is a computer program for the modeling of transient multi-layer flow with analytic elements.
TTim 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.
TTim 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 TTim 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.
TTim is coded in Python and uses numba to speed up evaluation of the line elements and inverse laplace transforms.

## Latest version
New in version 0.6.6:
* Many documentation improvements: new look, better organization, tutorials, how-to guides, etc. Check it out [here](https://ttim.readthedocs.io)!

## Installation

**Python versions and dependencies**

TTim requires Python >= 3.8 and can be installed from PyPI.

Required packages: 
* numpy
* scipy
* matplotlib 
* numba
* lmfit

**Installation:**

To install TTim, open a command prompt or the anaconda prompt and type:

    pip install ttim

To update TTim type:

    pip install ttim --upgrade

To uninstall TTim type:

    pip uninstall ttim
    
## Documentation

* The documentation is hosted on [readthedocs](https://ttim.readthedocs.io).
* Example Notebooks are available from the notebooks directory on github, of from [here](https://github.com/mbakker7/ttim/tree/master/notebooks).

## Citation

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

* M. Bakker. 2013. Semi-analytic modeling of transient multi-layer flow with TTim. Hydrogeology Journal, 21: 935�943.
* 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.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ttim",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Mark Bakker <markbak@gmail.com>, Dav\u00edd Brakenhoff <d.brakenhoff@artesia-water.nl>",
    "keywords": "hydrology,groundwater,model,analytic element method",
    "author": "Mark Bakker",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/fd/24/d82e28b9deda87911dfe573c5f86f1ec3830ced6205a780e7a0f8acfd282/ttim-0.6.6.tar.gz",
    "platform": null,
    "description": "[![ttim](https://github.com/mbakker7/ttim/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/mbakker7/ttim/actions/workflows/ci.yml)\n[![Coverage Status](https://coveralls.io/repos/github/mbakker7/ttim/badge.svg?branch=master)](https://coveralls.io/github/mbakker7/ttim?branch=master)\n![PyPI](https://img.shields.io/pypi/v/ttim?color=green)\n\n# TTim, A Multi-Layer, Transient, Analytic Element Model\n\n## Introduction\n\nTTim is a computer program for the modeling of transient multi-layer flow with analytic elements.\nTTim is based on the Laplace-transform analytic element method. The solution is computed analytically\nin the Laplace domain and converted back to the time domain numerically usig the algorithm of De Hoog, Stokes, and Knight.\nTTim may be applied to an arbitrary number of aquifers and leaky layers.\nThe head, flow, and leakage between aquifers may be computed semi-analytically at any point in space and time.\nThe design of TTim is object-oriented and has been kept simple and flexible.\nNew analytic elements may be added to the code without making any changes in the existing part of the code.\nTTim is coded in Python and uses numba to speed up evaluation of the line elements and inverse laplace transforms.\n\n## Latest version\nNew in version 0.6.6:\n* Many documentation improvements: new look, better organization, tutorials, how-to guides, etc. Check it out [here](https://ttim.readthedocs.io)!\n\n## Installation\n\n**Python versions and dependencies**\n\nTTim requires Python >= 3.8 and can be installed from PyPI.\n\nRequired packages: \n* numpy\n* scipy\n* matplotlib \n* numba\n* lmfit\n\n**Installation:**\n\nTo install TTim, open a command prompt or the anaconda prompt and type:\n\n    pip install ttim\n\nTo update TTim type:\n\n    pip install ttim --upgrade\n\nTo uninstall TTim type:\n\n    pip uninstall ttim\n    \n## Documentation\n\n* The documentation is hosted on [readthedocs](https://ttim.readthedocs.io).\n* Example Notebooks are available from the notebooks directory on github, of from [here](https://github.com/mbakker7/ttim/tree/master/notebooks).\n\n## Citation\n\nSome of the papers that you may want to cite when using TTim are:\n\n* M. Bakker. 2013. Semi-analytic modeling of transient multi-layer flow with TTim. Hydrogeology Journal, 21: 935\ufffd943.\n* 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.\n\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2015 mbakker7  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.  ",
    "summary": "Transient multi-layer AEM Model",
    "version": "0.6.6",
    "project_urls": {
        "documentation": "http://mbakker7.github.io/ttim/docs/builddocs/html/index.html",
        "homepage": "https://github.com/mbakker7/ttim",
        "repository": "https://github.com/mbakker7/ttim"
    },
    "split_keywords": [
        "hydrology",
        "groundwater",
        "model",
        "analytic element method"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1078f419eaf01062fbe9c455f8182b073e9789fc3cea893ff2af16fffbf9dee3",
                "md5": "4a013c056af87a24f700981a0d3ca4d0",
                "sha256": "5f658dce02aa0791576caaa590c6eec7b6368e2d935ac13d340ea579f0eb714a"
            },
            "downloads": -1,
            "filename": "ttim-0.6.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4a013c056af87a24f700981a0d3ca4d0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 73670,
            "upload_time": "2024-02-14T11:54:51",
            "upload_time_iso_8601": "2024-02-14T11:54:51.470780Z",
            "url": "https://files.pythonhosted.org/packages/10/78/f419eaf01062fbe9c455f8182b073e9789fc3cea893ff2af16fffbf9dee3/ttim-0.6.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd24d82e28b9deda87911dfe573c5f86f1ec3830ced6205a780e7a0f8acfd282",
                "md5": "6d9e97f9d6132e180b312dafea488c11",
                "sha256": "fd241124b6267b5e122f36a7fe71df69f3b9943226e20aa50db60a553a7ce226"
            },
            "downloads": -1,
            "filename": "ttim-0.6.6.tar.gz",
            "has_sig": false,
            "md5_digest": "6d9e97f9d6132e180b312dafea488c11",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 65809,
            "upload_time": "2024-02-14T11:54:52",
            "upload_time_iso_8601": "2024-02-14T11:54:52.809969Z",
            "url": "https://files.pythonhosted.org/packages/fd/24/d82e28b9deda87911dfe573c5f86f1ec3830ced6205a780e7a0f8acfd282/ttim-0.6.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-14 11:54:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mbakker7",
    "github_project": "ttim",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "ttim"
}
        
Elapsed time: 0.18833s