Skip to content

Commit

Permalink
updates readme and setup information
Browse files Browse the repository at this point in the history
  • Loading branch information
ThibHlln committed Jul 6, 2018
1 parent d54cd47 commit a4a5f57
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Python Versions](https://img.shields.io/pypi/pyversions/torrentpy.png)](https://pypi.python.org/pypi/torrentpy)
[![PyPI Version](https://img.shields.io/pypi/v/torrentpy.png)](https://pypi.python.org/pypi/torrentpy)

# 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).
Expand All @@ -12,8 +16,12 @@ TORRENTpy is an open-source framework for water, solutes, and particules transpo

## 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.
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
* 0.1.0 [08 Jul 2018]: First version of TORRENTpy

### Ackownlegments

This tool was developed with the financial support of Ireland's Environmental Protection Agency (Grant Number 2014-W-LS-5).
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@

'Operating System :: MacOS',
'Operating System :: Microsoft :: Windows',
'Operating System :: POSIX',
'Operating System :: Unix',
'Operating System :: POSIX :: Linux',


'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
Expand Down

0 comments on commit a4a5f57

Please sign in to comment.