生态水流特性的计算机
eflowcalc的Python项目详细描述
eflowcalc-一个python中生态流特性的开源计算器
eflowcalc是python中生态流特性的开源计算器。它是根据gnu gpl-3.0授权的(参见licence file提供的)。eflowcalc目前可以访问由Olden and Poff (2003)列出的171种不同的生态相关河流特征中的159种。越来越多的特征被逐渐添加到eflowcalc中。eflowcalc的一个关键优点是所有计算的矢量化(使用numpy,因此在后台使用c代码),这使得对水流特性的计算非常有效。
如何安装
Pypi上提供了eflowcalc,因此您可以简单地使用pip和包的名称:
python -m pip install eflowcalc
您还可以直接使用pip和指向github存储库的链接:
python -m pip install git+https://github.com/ThibHlln/eflowcalc.git
或者,您可以下载源代码(i.e.github存储库),并从下载的目录本身运行命令:
python setup.py install
如何使用
可以使用Jupyter notebook形式的教程开始使用eflowcalc的api。教程所需的输入文件在examples/
文件夹中提供。
如何引用
如果您使用的是eflowcalc,请考虑使用此文件头中提供的doi引用软件。
可用的流量特性
eflowcalc中当前可用的流量特性如下:
- 流量事件的大小
- 平均流量事件:ma1到ma45
- 低流量事件:ML1至ML22
- 高流量事件:mh1到mh23
- 流事件的频率
- 低流量事件:FL1到FL3
- 高流量事件:FH1至FH10
- 流事件持续时间
- 低流量事件:DL1到DL20
- 高流量事件:DH1至DH21
- 流事件的计时
- 平均流量事件:TA1和TA2
- 低流量事件:tl1和tl2
- 高流量事件:th1和th2
- 流量事件变化率
- 平均流量事件:RA1到RA9
这些径流特征是Olden and Poff (2003)列出的171个水文指标之一。在eflowcalc中实现的计算部分受到Henriksen et al. (2006)工作的启发,但是eflowcalc既没有得到这些作者的认可,也没有得到美国地质调查局的认可。
依赖关系
eflowcalc要求python包numpy
和pandas
安装在安装eflowcalc
的python解释器上。
版本历史记录
- 0.0.2[2019年2月16日]:增加142个SFC的版本(159个SFC)
- 0.0.1[2018年10月26日]:eflowcalc(17个sfcs)的第一版
确认
该工具是在爱尔兰环境保护署(批准号2014-W-LS-5)的资助下开发的。