用于处理读取用JPK仪器记录的文件的包。
jpkfile的Python项目详细描述
JPK文件
JPKfile是一个用于读取 JPK Instruments。
安装
安装jpkfile有以下三个选项。
将模块添加到您的PYTHONPATH
目前jpkfile
只有一个相关的python文件jpkfile.py
,这使得“安装”变得很简单:只需将.py文件所在的文件夹添加到python路径。
一种方法是添加一个.pth文件,其中包含文件夹的路径作为文本添加到用户的site packages文件夹:
*在我的ubuntu 18.04机器上,site packages文件夹位于/home/<;username>;/.local/lib/python3.7/site packages
*如果没有,可以通过在命令行中启动python并键入
>>> import site >>> site.USER_SITE
- 在文本编辑器中打开一个新文件,输入包含jpkfile模块的文件夹的路径。
- 将文件保存到“网站包”文件夹中。
就这样。现在您应该可以在系统的任何地方导入jpkfile。
第一步
您可以查看read_data_from_jpk_archive.py
文件,或者,如果您安装了jupyter/ipython笔记本,可以查看examples文件夹中的read_data_from_jpk_archive.ipynb
文件。这些示例向您展示了如何使用jpkfile模块的第一步。
文档
这个模块是用狮身人面像来记录的。您可以在readthedocs.io找到一个构建版本,也可以从那里下载pdf或html格式的版本。
或者,您可以自己在本地构建它。源文件包括一个docs
文件夹,其中包含文档的所有内容。它需要sphinx(我只测试了版本2.0.1)和sphinx_rtd_主题来构建。
许可证
麻省理工学院执照(MIT) 版权所有(c)2016 Ilyas Kuhlemann
特此免费授予获得本软件副本和相关文档文件(以下简称“软件”)的任何人使用本软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再授权和/或出售本软件副本的权利,并在符合以下条件的情况下,允许向其提供软件的人员这样做:
上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。
<软件>提供“原样”,无任何担保,明示或默示,包括但不限于适销性、适合特定用途和不侵权的保证。在任何情况下,作者或版权持有人均不对任何索赔、损害或其他责任负责,无论是在合同诉讼、侵权诉讼或其他诉讼中,由软件或软件的使用或其他交易引起的、由软件引起的或与之相关的。