A plenoptic processing library for Python.
plenpy - A plenoptic processing library for Python.
This is a Python package to calibrate, process and analyse (hyperspectral) lightfield images as well as (hyper)spectral images from either real cameras (e.g. Lytro) or synthetic/rendered images.
Note: The package is still undergoing API altering changes with each minor release.
License and Usage
This software is licensed under the GNU GPLv3 license (see below).
If you use this software in your scientific research, please cite
Not Yet Available, please check back later :)
You can install
plenpy directly from PyPi via
$ pip install plenpy
python >= 3.6 as it relies on Python syntax that has
been introduced in Python 3.6 such as f-strings or type hinting.
The package dependencies are resolved automatically upon installation using
For development and testing dependencies, see the
The package dependencies are stated in
Manual Installation on Unix / Linux / macOS
If you want to install from source, the installation using
make is straightforward and installs
plenpy and its runtime dependencies automatically.
make is not available, or you are running Windows, see below.
Caution: A system wide installation using
sudo is easy and possible but
discouraged. Installing in a environment is recommended.
plenpy, first clone the project's git repository to
a location of your desire and change directory to the project:
$ cd <path-to-plenpy>/ $ git clone firstname.lastname@example.org:iiit-public/plenpy.git $ cd plenpy
Then, install the library via:
Or, to have an editable install of plenpy, using
$ make editable
If no errors occur, we can check if the installation was successful by running the unit tests:
$ make test
That's it! The package should now be available.
Manual Installation on Windows
make is not available on your system, the installation via
is also straightforward. Instead of invoking
install by calling (e.g. from the Anaconda prompt)
$ pip install -r requirements.txt .
Please note the
. at the end, referring to the current folder
You can manually run the tests using
$ pytest <path-to-plenpy>/test/
$ pip uninstall plenpy
The documentation can be found here.
You can also build the documentation yourself:
Dependencies and Building
The documentation is build using Sphinx. To install all necessary dependencies for the documentation, run
$ cd <path-to-plenpyr> $ make $ pip install -r docs/requirements.txt $ cd docs $ sphinx-apidoc -f -o ./ ../plenpy/ $ make html
This will create the full
plenpy documentation in the
If you are interested in contributing to
plenpy, feel free to create an issue or
fork the project and submit a merge request. As this project is still undergoing
restructuring and extension, help is always welcome!
Please stick to the PEP 8 Python coding styleguide.
The docstring coding style of the reStructuredText follows the googledoc style.
Copyright (C) 2018-2019 The Plenpy Authors
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.