hiev数据捕获应用程序api的python 3包装器
hievp的Python项目详细描述
层次结构
hievpy是一个python 3包装器,它围绕着数据捕获HIEv的api接口 由位于Western Sydney University的Hawkesbury Institute for the Environment使用的应用程序。
下面简要介绍了hievpy库,包括安装说明。全部 文档和示例可以在项目的documentation pages中找到。
先决条件
要使用hievpy,您必须在 HIEv应用程序。若要讨论注册事宜,请联系HIE的数据经理, Gerry Devine
安装
hievpy可以通过pip安装:
$ pip install --index-url https://test.pypi.org/simple/ hievpy
Note: HIEvPy is currently hosted on Test PyPi. This will soon be moved to the official PyPi repository
一旦hievpy安装完毕,您就可以使用以下命令将其导入到python控制台或脚本中:
importhievpyashp
(使用可选的作为hp的快捷方式)
hievpy函数
一般功能
- search:返回与一组输入搜索参数匹配的hiev记录列表
- search_download:执行hievpy搜索并自动下载匹配的文件
- upload:将带有相关元数据的文件上载到hiev
- update_metadata:更新hievpy search返回的记录列表上的元数据
至5个功能
- toa5_summary:返回给定的toa5摘要信息(变量名称、单位和度量类型)
个人搜索返回记录。
- search_loaf_toa5df:执行hievpy搜索,并在给定文件记录的情况下将结果加载到pandas数据帧中
- toa5_summary:返回给定的toa5摘要信息(变量名称、单位和度量类型) 个人搜索返回记录。
- search_loaf_toa5df:执行hievpy搜索,并在给定文件记录的情况下将结果加载到pandas数据帧中
有关所有hievpy函数的完整解释,请参见项目的documentation pages examples文件夹包含许多示例脚本,概述了不同的hievpy函数的用法。 要运行任何示例脚本,您需要运行hiev py.utils.make_credsfile(),该脚本创建的文件github不会共享名为credentials.py并用HIEV API标记填充它 版权所有(c)2018 Gerry Devine 兹免费准许任何人取得副本
本软件和相关文档文件(“软件”)的
在软件中不受限制,包括但不限于
使用、复制、修改、合并、发布、分发、再授权和/或出售
软件的副本,并允许软件的用户
在满足以下条件的情况下,可以这样做: 上述版权公告及本许可公告须包括在
软件的拷贝或大部分。 本软件按“原样”提供,无任何形式的保证,明示或
默示的,包括但不限于适销性保证,
适合特定目的和不侵权。在任何情况下
作者或版权所有者应对任何索赔、损害或其他
责任,无论是在合同诉讼、侵权诉讼或其他诉讼中,
不属于或与本软件有关,或使用或与本软件的其他交易有关。
软件。示例
import hievpy as hp
hp.utils.make_credsfile()
许可证
推荐PyPI第三方库