| Name | timml JSON |
| Version |
6.6.0
JSON |
| download |
| home_page | None |
| Summary | Steady multi-layer AEM Model |
| upload_time | 2024-12-20 12:43:16 |
| maintainer | None |
| docs_url | None |
| author | Mark Bakker |
| requires_python | >=3.10 |
| license | The MIT License (MIT) Copyright (c) 2015 Mark Bakker 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 |
|
[](https://github.com/mbakker7/timml/actions/workflows/ci.yml)
[](https://coveralls.io/github/mbakker7/timml?branch=master)
# TimML, A Multi-Layer, Analytic Element Model
## Introduction
TimML is a computer program for the modeling of steady-state multi-layer flow with analytic elements
and consists of a library of Python scripts and FORTRAN extensions.
TimML may be applied to an arbitrary number of aquifers and leaky layers.
The head, flow, and leakage between aquifers may be computed analytically at any point in the aquifer system.
The design of TimML 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.
TimML is coded in Python and uses numba to speed up evaluation of the bessel line elements.
## Installation
**Python versions:**
TimML requires Python >= 3.8 and can be installed from PyPI.
**Dependencies:**
TimML requires:
* numpy
* scipy
* matplotlib
* numba
**Installation:**
To install TimML, open a command prompt and type:
pip install timml
To update TimML type:
pip install timml --upgrade
To uninstall TimML type:
pip uninstall timml
## Documentation
* The documentation is hosted on [readthedocs](https://timml.readthedocs.io/).
* Example Notebooks are available from the notebooks directory on github, of from [here](https://github.com/mbakker7/timml/tree/master/notebooks).
## Latest release
TimML 0.6.5
* Improved documentation: new look, better organization, tutorials, how-to guides etc. Check it out [here](https://timml.readthedocs.io/)!
* New elements
* Building pit elements for 3D (multi-layer single aquifer) models.
* Large diamater wells (only for radial flow).
* Enhancements
* Building pit leaky wall resistance can be set per layer and per side (for modeling leaks or gaps).
* Return integrated normal flux per layer and per line segment.
## TimML Versions
* TimML version 0.6 has the same functionality as version 5, but doesn't depend on a fortran extension anymore, so installation is easy on all platforms.
* TimML version 0.5
* is a total rewrite and is not backwards compatible with previous TimML versions.
* is intended to be compatible with TTim.
* has many new features and elements, the code base is Python 3, and the object oriented design is much simpler.
* TimML version 0.4 remains available through the timml4 branch.
## Citation
Some of the papers that you may want to cite when using TimML are
* Bakker, M., and O.D.L. Strack. 2003. Analytic Elements for Multiaquifer Flow. Journal of Hydrology, 271(1-4), 119-129.
* Bakker, M. 2006. An analytic element approach for modeling polygonal inhomogeneities in multi-aquifer systems. Advances in Water Resources, 29(10), 1546-1555.
Raw data
{
"_id": null,
"home_page": null,
"name": "timml",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"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": null,
"download_url": "https://files.pythonhosted.org/packages/24/09/882d36f118c8bd5f96b10fa24be94db35917d28249c7e32681c63b4fb7ce/timml-6.6.0.tar.gz",
"platform": null,
"description": "[](https://github.com/mbakker7/timml/actions/workflows/ci.yml)\n[](https://coveralls.io/github/mbakker7/timml?branch=master)\n\n\n# TimML, A Multi-Layer, Analytic Element Model\n\n## Introduction\n\nTimML is a computer program for the modeling of steady-state multi-layer flow with analytic elements\nand consists of a library of Python scripts and FORTRAN extensions.\nTimML may be applied to an arbitrary number of aquifers and leaky layers.\nThe head, flow, and leakage between aquifers may be computed analytically at any point in the aquifer system.\nThe design of TimML 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.\nTimML is coded in Python and uses numba to speed up evaluation of the bessel line elements.\n\n## Installation\n\n**Python versions:**\n\nTimML requires Python >= 3.8 and can be installed from PyPI.\n\n**Dependencies:**\n\nTimML requires:\n* numpy \n* scipy\n* matplotlib\n* numba\n\n**Installation:**\n\nTo install TimML, open a command prompt and type:\n\n pip install timml\n\nTo update TimML type:\n\n pip install timml --upgrade\n\nTo uninstall TimML type:\n\n pip uninstall timml\n\n\n## Documentation\n\n* The documentation is hosted on [readthedocs](https://timml.readthedocs.io/).\n* Example Notebooks are available from the notebooks directory on github, of from [here](https://github.com/mbakker7/timml/tree/master/notebooks).\n\n## Latest release\nTimML 0.6.5\n* Improved documentation: new look, better organization, tutorials, how-to guides etc. Check it out [here](https://timml.readthedocs.io/)!\n* New elements\n * Building pit elements for 3D (multi-layer single aquifer) models.\n * Large diamater wells (only for radial flow).\n* Enhancements\n * Building pit leaky wall resistance can be set per layer and per side (for modeling leaks or gaps).\n * Return integrated normal flux per layer and per line segment.\n\n## TimML Versions\n\n* TimML version 0.6 has the same functionality as version 5, but doesn't depend on a fortran extension anymore, so installation is easy on all platforms.\n* TimML version 0.5 \n * is a total rewrite and is not backwards compatible with previous TimML versions.\n * is intended to be compatible with TTim.\n * has many new features and elements, the code base is Python 3, and the object oriented design is much simpler.\n* TimML version 0.4 remains available through the timml4 branch.\n\n## Citation\n\nSome of the papers that you may want to cite when using TimML are\n\n* Bakker, M., and O.D.L. Strack. 2003. Analytic Elements for Multiaquifer Flow. Journal of Hydrology, 271(1-4), 119-129.\n* Bakker, M. 2006. An analytic element approach for modeling polygonal inhomogeneities in multi-aquifer systems. Advances in Water Resources, 29(10), 1546-1555.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2015 Mark Bakker 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": "Steady multi-layer AEM Model",
"version": "6.6.0",
"project_urls": {
"documentation": "http://mbakker7.github.io/timml/docs/builddocs/html/index.html",
"homepage": "https://github.com/mbakker7/timml",
"repository": "https://github.com/mbakker7/timml"
},
"split_keywords": [
"hydrology",
" groundwater",
" model",
" analytic element method"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25063d6ed6e74ac13bb1966fda378d5fa88c89b5f7ae29929c82864a4651715e",
"md5": "f660704f08e0c7c1229bf78b0ec8608f",
"sha256": "f5e9bb6ba9ee6d683ba0bf3aa9e05c5fbe013e3cf3e22fc8d33442f661c64287"
},
"downloads": -1,
"filename": "timml-6.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f660704f08e0c7c1229bf78b0ec8608f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 74834,
"upload_time": "2024-12-20T12:43:14",
"upload_time_iso_8601": "2024-12-20T12:43:14.560973Z",
"url": "https://files.pythonhosted.org/packages/25/06/3d6ed6e74ac13bb1966fda378d5fa88c89b5f7ae29929c82864a4651715e/timml-6.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2409882d36f118c8bd5f96b10fa24be94db35917d28249c7e32681c63b4fb7ce",
"md5": "bad9ddb18eb13757cc7edd5816bf19e2",
"sha256": "82cca07ca2c49ab6a7f1ae53c9bec0bb35c041deacd7b6363dc88f0b0f07953c"
},
"downloads": -1,
"filename": "timml-6.6.0.tar.gz",
"has_sig": false,
"md5_digest": "bad9ddb18eb13757cc7edd5816bf19e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 61703,
"upload_time": "2024-12-20T12:43:16",
"upload_time_iso_8601": "2024-12-20T12:43:16.625541Z",
"url": "https://files.pythonhosted.org/packages/24/09/882d36f118c8bd5f96b10fa24be94db35917d28249c7e32681c63b4fb7ce/timml-6.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 12:43:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mbakker7",
"github_project": "timml",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "timml"
}
