plenpy 0.5.1

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 :)

Quick Start

For a quick tryout, you can use our latest Docker Image. Have a look at our Documentation for some basic examples.

Installation

You can install plenpy directly from PyPi via pip:

$ pip install plenpy

That's it!

Dependencies

Plenpy requires 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 listed in the requirements.txt file and are resolved automatically upon installation using pip

Furthermore, testing requires the pytest library and the pytest-cov library for coverage report.

Manual Installation on Linux / Unix / macOS

If you want to install from source, the installation using make is straightforward and installs plenpy and its runtime dependencies automatically.

Caution: A system wide installation using sudo is easy and possible but discouraged. Installing in a environment is recommended.

To install plenpy, first clone the project's git repository to a location of your desire and change directory to the project:

$ cd <myFolder>
$ git clone [e-mail]:schambach/plenpy.git
$ cd plenpy

Then, install the library via:

$ make

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.

---

If make is not available on your system, the installation via pip is also straightforward. Instead of invoking make, install by calling

$ pip install -r requirements.txt .

Please note the . at the end, referring to the current folder <myFolder>/plenpy. You can manually run the tests using pytest:

$ pytest test/

Uninstallation

Uninstall plenpy using

$ pip uninstall plenpy

Documentation

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 <plenpy-main-repository-folder>
$ 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 docs/_build/html folder.

Contribute

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!

For Programmers

Please stick to the PEP 8 Python coding styleguide.

The docstring coding style of the reStructuredText follows the googledoc style.

License

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/.