{ "info": { "author": "Thibault Hallouin, Michael Bruen, and Eva Mockler", "author_email": "thibault.hallouin@ucdconnect.ie", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Scientific/Engineering" ], "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\r\n[![PyPI Version](https://badge.fury.io/py/torrentpy.svg)](https://pypi.python.org/pypi/torrentpy)\r\n[![Travis CI Build Status](https://www.travis-ci.org/ThibHlln/torrentpy.svg?branch=master)](https://www.travis-ci.org/ThibHlln/torrentpy)\r\n[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/ThibHlln/torrentpy?branch=master&svg=true)](https://ci.appveyor.com/project/ThibHlln/torrentpy)\r\n\r\n\r\n# TORRENTpy - An open-source tool for water, solutes, and particles TranspORt thRough the catchmEnt NeTwork\r\n\r\nTORRENTpy is an open-source framework in Python for water, solutes, and particles transport through catchments discretised in lumped and semi-distributed manners. It is licensed under GNU GPL-3.0 (see [licence file](LICENCE.md) provided). The framework simulates the hydrological fluxes using top-down catchment models that can be applied at the catchment scale (lumped manner) or at the sub-catchment scale (semi-distributed manner). Water quality models can complement the catchment models to simulate the water-borne contaminants (both solutes and particles) at the scale where the catchment models are applied (*i.e.* catchment scale or sub-catchment scale).\r\n\r\n## How to Install\r\n\r\nTORRENTpy is available on PyPI, so you can simply use pip:\r\n\r\n python -m pip install torrentpy\r\n\r\nAlternatively, you can download the source code (*i.e.* this repository) and use the command:\r\n\r\n python setup.py install\r\n\r\n## Dependencies\r\n\r\nTORRENTpy requires the popular Python package `numpy` to be installed on the Python implementation where `torrentpy` is installed. For Python 2 and 3 compatibilities, the package `future` is also required.\r\nAdditional optional dependencies include `netCDF4` if one wishes to use NetCDF files as input and/or output, `graphviz` if one wishes to use the utility `connectivity.py` and plot the network it generates, and `smartcpp` if one wishes to use an accelerator module for the `SMART` model (it gives access to a C++ extension for the SMART model).\r\n\r\n## List of Models currently available in TORRENTpy\r\n\r\n* Rainfall-Runoff Models:\r\n\t* `SMART` model (catchment runoff + river routing)\r\n\r\n* Water Quality Models:\r\n\t* `INCA` model (catchment runoff + river routing)\r\n\r\n## Input/Output File Formats\r\n\r\nTORRENTpy is designed to read CSV (Comma-Separated Values) files and NetCDF (Network Common Data Form) files. However, the use of NetCDF files requires the Python package `netCDF4` to be installed on the Python implementation where this package is installed (specific pre-requisites prior the installation of `netCDF4` exist and can be found at [unidata.github.io/netcdf4-python](http://unidata.github.io/netcdf4-python/)).\r\n\r\n## Version History\r\n\r\n* 0.2.0 [12 Jul 2018]: Operational version of TORRENTpy, with Python 3 compatibility\r\n\t* Fixes relative module import issues that made v0.1.0 unusable out of the box\r\n\t* Adds clean up function for output folder to avoid appending to files from previous simulations\r\n\t* Makes all scripts Python 3 compatible by using `builtins` and `io` packages\r\n\t* Corrects check on class instance for user-defined models added to KnowledgeBase\r\n* 0.1.0 [05 Jul 2018]: First version of TORRENTpy\r\n\t* Attention, this version is not functioning due to relative module import issues.\r\n\r\n## Acknowledgment\r\n\r\nThis tool was developed with the financial support of Ireland's Environmental Protection Agency (Grant Number 2014-W-LS-5).\r\n\r\n\r\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ThibHlln/torrentpy", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "torrentpy", "package_url": "https://pypi.org/project/torrentpy/", "platform": "", "project_url": "https://pypi.org/project/torrentpy/", "project_urls": { "Homepage": "https://github.com/ThibHlln/torrentpy" }, "release_url": "https://pypi.org/project/torrentpy/0.2.0/", "requires_dist": [ "numpy", "future", "netCDF4; extra == 'with_all_extras'", "graphviz; extra == 'with_all_extras'", "smartcpp; extra == 'with_all_extras'", "graphviz; extra == 'with_graphviz'", "netCDF4; extra == 'with_netcdf'", "smartcpp; extra == 'with_smartcpp'" ], "requires_python": "", "summary": "TORRENTpy: a tool for TranspORt thRough the catchmEnt NeTwork", "version": "0.2.0" }, "last_serial": 4058362, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "4cbd296c24eaef446651d412a4b6f814", "sha256": "5e4b8f4981733dd0ca9d65b60c689acf35948f4079536e4c029dcbb29b429f09" }, "downloads": -1, "filename": "torrentpy-0.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "4cbd296c24eaef446651d412a4b6f814", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 25510, "upload_time": "2018-07-05T18:30:41", "url": "https://files.pythonhosted.org/packages/5b/ad/37c61fc4b36d4b48653c2834c690a79525468f9ac07ac63c803db24e63f9/torrentpy-0.1.0-py2-none-any.whl" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "b7a6c5aedf4f87ec4ff835e61d3d3bae", "sha256": "e9cf41103b864ea1ae7abc7f4fa9b831e3985a1ef978c0ac8c60ed9a15a141a6" }, "downloads": -1, "filename": "torrentpy-0.2.0-py2-none-any.whl", "has_sig": false, "md5_digest": "b7a6c5aedf4f87ec4ff835e61d3d3bae", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 63126, "upload_time": "2018-07-13T15:34:18", "url": "https://files.pythonhosted.org/packages/7b/47/6df370662a7fe41d6da5896cfa159b212ec077db23befbc83e075637fb94/torrentpy-0.2.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1de8d5c87c3058f190fff451702b9315", "sha256": "41a3a3df48ae4a28ff9313976c8502153245039182dcd4196e778f170b56d0fb" }, "downloads": -1, "filename": "torrentpy-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1de8d5c87c3058f190fff451702b9315", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 62816, "upload_time": "2018-07-13T15:34:20", "url": "https://files.pythonhosted.org/packages/e5/dd/ec150dc2dc5d321dd7ee33e4b6ef9d95f919a5d2045122f23a7305868ddf/torrentpy-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9bee1052be2e3e2dcdcf123edf692874", "sha256": "e5447374269ca6738ae99447821f3267d1eecff5443b5b5b059e9ed7ce32c1df" }, "downloads": -1, "filename": "torrentpy-0.2.0.tar.gz", "has_sig": false, "md5_digest": "9bee1052be2e3e2dcdcf123edf692874", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 51802, "upload_time": "2018-07-13T15:34:21", "url": "https://files.pythonhosted.org/packages/a3/37/e91e51f0e7beb6ee958fc48d41e8cb2490e0053d8fbaf5f465388cc73b31/torrentpy-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b7a6c5aedf4f87ec4ff835e61d3d3bae", "sha256": "e9cf41103b864ea1ae7abc7f4fa9b831e3985a1ef978c0ac8c60ed9a15a141a6" }, "downloads": -1, "filename": "torrentpy-0.2.0-py2-none-any.whl", "has_sig": false, "md5_digest": "b7a6c5aedf4f87ec4ff835e61d3d3bae", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 63126, "upload_time": "2018-07-13T15:34:18", "url": "https://files.pythonhosted.org/packages/7b/47/6df370662a7fe41d6da5896cfa159b212ec077db23befbc83e075637fb94/torrentpy-0.2.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1de8d5c87c3058f190fff451702b9315", "sha256": "41a3a3df48ae4a28ff9313976c8502153245039182dcd4196e778f170b56d0fb" }, "downloads": -1, "filename": "torrentpy-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1de8d5c87c3058f190fff451702b9315", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 62816, "upload_time": "2018-07-13T15:34:20", "url": "https://files.pythonhosted.org/packages/e5/dd/ec150dc2dc5d321dd7ee33e4b6ef9d95f919a5d2045122f23a7305868ddf/torrentpy-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9bee1052be2e3e2dcdcf123edf692874", "sha256": "e5447374269ca6738ae99447821f3267d1eecff5443b5b5b059e9ed7ce32c1df" }, "downloads": -1, "filename": "torrentpy-0.2.0.tar.gz", "has_sig": false, "md5_digest": "9bee1052be2e3e2dcdcf123edf692874", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 51802, "upload_time": "2018-07-13T15:34:21", "url": "https://files.pythonhosted.org/packages/a3/37/e91e51f0e7beb6ee958fc48d41e8cb2490e0053d8fbaf5f465388cc73b31/torrentpy-0.2.0.tar.gz" } ] }