python的全光处理库。
plenp的Python项目详细描述
Plenpy-python的Plenoptic处理库。
这是一个python包,用于校准、处理和分析 (高光谱)光场图像和(高)光谱图像 从真实相机(如Lytro)或合成/渲染图像。
Note: The package is still undergoing API altering changes with each minor release.
许可证和使用
此软件是在GNU GPLV3许可下授权的(见下文)。
如果您在科研中使用此软件,请引用
Not Yet Available, please check back later :)
快速启动
为了快速试用,您可以使用我们最新的Docker Image。 查看我们的Documentation以获取一些基本示例。
安装
您可以通过pip
:
plenpy
$ pip install plenpy
就这样!
依赖性
Plenpy需要python >= 3.6
,因为它依赖于具有
在Python3.6中引入,如f字符串或类型提示。
包依赖项在安装时使用pip
自动解析。
有关开发和测试依赖项,请参见requirements.txt
文件。
包依赖项在setup.py
中声明。
在unix/linux/macos上手动安装
如果您想从源代码安装,那么使用make
的安装非常简单,并且
plenpy
及其运行时依赖项。
如果make
不可用,或者您正在运行Windows,请参阅下面的。
caution:使用sudo
进行系统范围的安装是容易和可能的,但是
气馁。建议在环境中安装。
要安装plenpy
,请首先将项目的git存储库克隆到
您想要的位置并将目录更改为项目:
$ cd <path-to-plenpy>/
$ git clone git@gitlab.com:iiit-public/plenpy.git
$ cd plenpy
然后,通过以下方式安装库:
$ make
或者,使用
$ make editable
如果没有出现错误,我们可以检查安装是否成功 通过运行单元测试:
$ make test
就这样!这个包裹现在应该可以用了。
在windows上手动安装
如果系统上没有make
,则通过pip
安装
也是直截了当的。而不是调用make
,
通过调用(例如从anaconda提示符)进行安装
$ pip install -r requirements.txt .
请注意结尾处的.
,指的是当前文件夹
<path-to-plenpy>/plenpy
。
测试
您可以使用pytest
:
$ pytest <path-to-plenpy>/test/
卸载
使用
卸载plenpy
$ pip uninstall plenpy
文档
文档可以找到here。
您也可以自己构建文档:
依赖关系和构建
文档是使用Sphinx生成的。 要安装文档的所有必需依赖项,请运行
$ cd <path-to-plenpyr>
$ make
$ pip install -r docs/requirements.txt
$ cd docs
$ sphinx-apidoc -f -o ./ ../plenpy/
$ make html
这将在
docs/_build/html
文件夹。
贡献
如果您有兴趣参与plenpy
,请随意创建问题或
派生项目并提交合并请求。因为这个项目还在进行中
重组和扩建,随时欢迎帮助!
对于程序员
请坚持 PEP 8 Python coding styleguide。
重构文本的docstring编码样式遵循 googledoc style。
许可证
版权所有(c)2018-2019 The Plepy Authors
此程序是免费软件:您可以重新分发和/或修改 根据由 自由软件基金会,或者许可证的第3版,或者 (由您选择)任何更高版本。
这个程序的发布是希望它能有用, 但没有任何保证;甚至没有 适销性或适合某一特定目的的适销性。见 GNU通用公共许可证了解更多详细信息。
你应该收到GNU通用公共许可证的副本 还有这个节目。如果没有,请参阅https://www.gnu.org/licenses/。