Metadata-Version: 2.1
Name: torrentpy
Version: 0.1.0
Summary: TORRENTpy: a tool for TranspORt thRough the catchmEnt NeTwork
Home-page: https://github.com/ThibHlln/torrentpy
Author: Thibault Hallouin, Michael Bruen, and Eva Mockler
Author-email: thibault.hallouin@ucdconnect.ie
License: GPLv3
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown
Provides-Extra: with_graphviz
Provides-Extra: with_netcdf
Requires-Dist: numpy
Provides-Extra: with_graphviz
Requires-Dist: graphviz; extra == 'with_graphviz'
Provides-Extra: with_netcdf
Requires-Dist: netCDF4; extra == 'with_netcdf'

# TORRENTpy - An open-source tool for TranspORt thRough the catchmEnt NeTwork

TORRENTpy is an open-source framework for water, solutes, and particules transport through lumped and semi-distributed catchments in Python. 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 or at the sub-catchment scale. 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).

## List of Models currently available in TORRENTpy

* Rainfall-Runoff Models:
	* `SMART` model (catchment runoff + river routing)

* Water Quality Models:
	* `INCA` model (catchment runoff + river routing)

## Input/Output File Formats

TORRENTpy 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.

## Version History

* 0.1.0 [08 Jul 2018]: First version of TORRENTpy

