{ "info": { "author": "Thibault Hallouin", "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 :: Hydrology" ], "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![PyPI Version](https://badge.fury.io/py/eflowcalc.svg)](https://pypi.python.org/pypi/eflowcalc)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2566757.svg)](https://doi.org/10.5281/zenodo.2566757)\n\n# EFlowCalc - An efficient calculator of ecological streamflow characteristics in Python\n\nEFlowCalc is an open-source calculator of ecological streamflow characteristics in Python. It is licensed under GNU GPL-3.0 (see [licence file](https://github.com/ThibHlln/eflowcalc/blob/master/LICENCE.md) provided). EFlowCalc currently gives access to 159 ecologically relevant streamflow characteristics inventoried by [Olden and Poff (2003)](https://doi.org/10.1002/rra.700). More characteristics are gradually added to EFlowCalc. A key strength of EFlowCalc is the vectorisation of all calculations (using [numpy](https://github.com/numpy/numpy), and therefore C code in the background) which makes for very efficient computation of the streamflow characteristics.\n\n## How to Install\n\nEFlowCalc is available on PyPI, so you can simply use pip and the name of the package:\n\n python -m pip install eflowcalc\n\nYou can also use pip and a link to the GitHub repository directly:\n\n\tpython -m pip install git+https://github.com/ThibHlln/eflowcalc.git\n\nAlternatively, you can download the source code (*i.e.* the GitHub repository) and, from the downloaded directory itself, run the command:\n\n python setup.py install\n\n## How to Use\n\nA tutorial in the form of a [Jupyter notebook](https://github.com/ThibHlln/eflowcalc/blob/master/examples/api_usage_example.ipynb) is available to get started with the usage of EFlowCalc's API. The input file required for the tutorial is provided in the `examples/` folder.\n\n## How to Cite\n\nIf you are using EFlowCalc, please consider citing the software as follows (click on the link to get the DOI of a specific version):\n* Hallouin, T. (XXXX). EFlowCalc: Ecological Streamflow Characteristics Calculator (Version X.X.X). Zenodo. https://doi.org/10.5281/zenodo.2566757\n\n## Streamflow Characteristics Available\n\nThe streamflow characteristics currently available in EFlowCalc are as follows:\n* Magnitude of flow events\n * Average flow events: MA1 to MA45\n * Low flow events: ML1 to ML22\n * High flow events: MH1 to MH23\n* Frequency of flow events\n * Low flow events: FL1 to FL3\n * High flow events: FH1 to FH10\n* Duration of flow events\n * Low flow events: DL1 to DL20\n * High flow events: DH1 to DH21\n* Timing of flow events\n * Average flow events: TA1 and TA2\n * Low flow events: TL1 and TL2\n * High flow events: TH1 and TH2\n* Rate of change in flow events\n * Average flow events: RA1 to RA9\n\nThese streamflow characteristics are amongst the 171 hydrological indices inventoried by [Olden and Poff (2003)](https://doi.org/10.1002/rra.700). The computations implemented in EFlowCalc are partially inspired by the work of [Henriksen et al. (2006)](https://doi.org/10.3133/ofr20061093), however EFlowCalc is neither endorsed by these authors nor by the U.S. Geological Survey.\n\n## Dependencies\n\nEFlowCalc requires the Python packages `numpy` and `pandas` to be installed on the Python interpreter where `eflowcalc` is installed.\n\n## Version History\n\n* 0.0.3 [08 Sep 2019]: [General enhancements](https://github.com/ThibHlln/eflowcalc/releases/tag/v0.0.3)\n* 0.0.2 [16 Feb 2019]: [Version with 142 additional SFCs (159 SFCs)](https://github.com/ThibHlln/eflowcalc/releases/tag/v0.0.2)\n* 0.0.1 [26 Oct 2018]: [First version of EFlowCalc (17 SFCs)](https://github.com/ThibHlln/eflowcalc/releases/tag/v0.0.1)\n\n## Acknowledgment\n\nThis tool was developed with the financial support of Ireland's Environmental Protection Agency (Grant Number 2014-W-LS-5).\n\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/eflowcalc", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "eflowcalc", "package_url": "https://pypi.org/project/eflowcalc/", "platform": "", "project_url": "https://pypi.org/project/eflowcalc/", "project_urls": { "Homepage": "https://github.com/ThibHlln/eflowcalc" }, "release_url": "https://pypi.org/project/eflowcalc/0.0.3/", "requires_dist": [ "numpy", "pandas" ], "requires_python": "", "summary": "EFlowCalc: An Efficient Calculator of Ecological Streamflow Characteristics in Python", "version": "0.0.3" }, "last_serial": 5798743, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "fc5f6d3426e0a34d6d7e5e823378a1e7", "sha256": "c4ff24a7ddd944fd8b8472bac6337c50684c236e2c66a86ad0afb9e3ee3ce5df" }, "downloads": -1, "filename": "eflowcalc-0.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "fc5f6d3426e0a34d6d7e5e823378a1e7", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 25768, "upload_time": "2018-10-26T09:31:25", "url": "https://files.pythonhosted.org/packages/7d/8c/71a4df7aaac86d84e72a628d7b7d9ec337d79993372fefd0aa38b284d946/eflowcalc-0.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a05fa8943bd8155699c080990d17b748", "sha256": "cf76725f904f6f34d35cd412e05cabb96b5f4a377816928777c0884bb6b07729" }, "downloads": -1, "filename": "eflowcalc-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a05fa8943bd8155699c080990d17b748", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 25750, "upload_time": "2018-10-26T09:31:26", "url": "https://files.pythonhosted.org/packages/b7/50/a5206f0eae2f29a0cd0d3274df79299504237bf7547be0c9c34e88ae39e8/eflowcalc-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8c23a901b109c16bd3e078a06dd4d2b8", "sha256": "f38284c46a3fb4a0b61fdcb183e2cf6d192e802fb8de721ebbc63906107ca30d" }, "downloads": -1, "filename": "eflowcalc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "8c23a901b109c16bd3e078a06dd4d2b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7153, "upload_time": "2018-10-26T09:31:27", "url": "https://files.pythonhosted.org/packages/83/44/b5e3ea0d407a0b88fba78116b3aeaaf098ab356cab56bbbdea51259702be/eflowcalc-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "a54f7dc5c28d74abe1a293650fc10660", "sha256": "aeb04179efb15cfa17a696a5fe6fb54a6e7b04be29dbf28cf4a34c739e1cfd04" }, "downloads": -1, "filename": "eflowcalc-0.0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "a54f7dc5c28d74abe1a293650fc10660", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 31921, "upload_time": "2019-02-27T08:48:21", "url": "https://files.pythonhosted.org/packages/5b/21/ae2f503b07fc82f4a5c8be326d73dc6c42a7eb691eaa4b6fe29620a12d10/eflowcalc-0.0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c4528b2071dcea92a77214df8bf92036", "sha256": "887f1d7bf0308dfb435a8c571b3129e0a19a9dd71e899c205cbc274dfa46273b" }, "downloads": -1, "filename": "eflowcalc-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c4528b2071dcea92a77214df8bf92036", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31903, "upload_time": "2019-02-27T08:48:22", "url": "https://files.pythonhosted.org/packages/e5/87/92adc94b77a797152b6302b36b628230aae6dd70a3475298c89e6dc0cc57/eflowcalc-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0f5e245e7be33b365c6200b2b2f0c9b6", "sha256": "287114aa684e089e92bea2f41eacb7adbdf07de7e27e34e381878d98f6c52c3e" }, "downloads": -1, "filename": "eflowcalc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "0f5e245e7be33b365c6200b2b2f0c9b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12952, "upload_time": "2019-02-27T08:48:24", "url": "https://files.pythonhosted.org/packages/1f/f9/9a17b78922bcbca9eb9342def0ee686d1ccaedfcd588e15445cd13e4d194/eflowcalc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "a50eeb8d64c776fc170b5159b2ea32d0", "sha256": "875701ebac983fd26d216ff0d57f281bcfb2ccbce81e56342b04f5387edd2ba5" }, "downloads": -1, "filename": "eflowcalc-0.0.3-py2-none-any.whl", "has_sig": false, "md5_digest": "a50eeb8d64c776fc170b5159b2ea32d0", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 32093, "upload_time": "2019-09-08T08:46:55", "url": "https://files.pythonhosted.org/packages/f6/25/e2db0c5eaf96e4f7b424e42c4136a49f1bcdc9b934da1d548b5249532141/eflowcalc-0.0.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "caa3bb1bf79604edbb3eb3b7bd817441", "sha256": "a52d9eb8e88a155cc968495635d465068fa149ee6d61944b39ca54d489f70ba6" }, "downloads": -1, "filename": "eflowcalc-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "caa3bb1bf79604edbb3eb3b7bd817441", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 32092, "upload_time": "2019-09-08T08:46:56", "url": "https://files.pythonhosted.org/packages/97/96/ef40afff02915889c3814562f252af18013d73adb2fbe7991ffb2a27500b/eflowcalc-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8950a4983e9123a9f3ffc128b9074208", "sha256": "8cfed7d5aa6ae64618b15b77299a0e3b1827c3f61b28580becd3147dea3ad879" }, "downloads": -1, "filename": "eflowcalc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "8950a4983e9123a9f3ffc128b9074208", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15234, "upload_time": "2019-09-08T08:46:58", "url": "https://files.pythonhosted.org/packages/03/0a/6814af65c0ebbfcec6eba925a4af919e2c2cf273b1b39f0691a9a2530c18/eflowcalc-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a50eeb8d64c776fc170b5159b2ea32d0", "sha256": "875701ebac983fd26d216ff0d57f281bcfb2ccbce81e56342b04f5387edd2ba5" }, "downloads": -1, "filename": "eflowcalc-0.0.3-py2-none-any.whl", "has_sig": false, "md5_digest": "a50eeb8d64c776fc170b5159b2ea32d0", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 32093, "upload_time": "2019-09-08T08:46:55", "url": "https://files.pythonhosted.org/packages/f6/25/e2db0c5eaf96e4f7b424e42c4136a49f1bcdc9b934da1d548b5249532141/eflowcalc-0.0.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "caa3bb1bf79604edbb3eb3b7bd817441", "sha256": "a52d9eb8e88a155cc968495635d465068fa149ee6d61944b39ca54d489f70ba6" }, "downloads": -1, "filename": "eflowcalc-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "caa3bb1bf79604edbb3eb3b7bd817441", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 32092, "upload_time": "2019-09-08T08:46:56", "url": "https://files.pythonhosted.org/packages/97/96/ef40afff02915889c3814562f252af18013d73adb2fbe7991ffb2a27500b/eflowcalc-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8950a4983e9123a9f3ffc128b9074208", "sha256": "8cfed7d5aa6ae64618b15b77299a0e3b1827c3f61b28580becd3147dea3ad879" }, "downloads": -1, "filename": "eflowcalc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "8950a4983e9123a9f3ffc128b9074208", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15234, "upload_time": "2019-09-08T08:46:58", "url": "https://files.pythonhosted.org/packages/03/0a/6814af65c0ebbfcec6eba925a4af919e2c2cf273b1b39f0691a9a2530c18/eflowcalc-0.0.3.tar.gz" } ] }