Installation

Installation

The Python package peri is compatible with most platforms including Linux, Mac, and Windows. Currently we are only compatible with Python 2.7.x but very close to Python 3.x compatibility. In order to run peri you must have a modern installation of Python. On all platforms, we recommend using the new Anaconda. However, any modern distribution of Python will work. For example, on Linux, you can you the system Python installed by default (via apt-get install python). On Mac, you can use the system Python or one installed from macports / brew.

Quick install

Official releases of peri are provided on PyPI.org, a.k.a. the ‘cheeseshop’. You can access the source distribution files there at peri or using the common packaging tools provided with Python. The quickest way is to run:

pip install peri

This will install peri onto your PYTHONPATH. Make sure that the appropriate path is also added to your path so the peri executable is available. It can be found in $PYTHONPATH/bin.

If you don’t have Python, you’ll first need to install 64-bit Python, version 2.7. Download Python.

In addition, you’ll want 64-bit versions of the following packages
  • numpy (required)
  • scipy (required)
  • matplotlib (required)
  • pillow (required)
  • pyfftw (makes calculations much faster; all-but-required)
  • trackpy (useful for analyzing the results and getting initial guesses; not required)

Running pip install peri should install peri and its dependencies automatically. Sometimes I have trouble with dependencies on Windows machines. To get around this, try downloading the Anaconda Python distribution, which includes nearly all of the peri dependencies. Alternatively, you can download the dependencies in 64-bit from Christopher Gohlke’s helpful website here.

Source code

Warning

Development builds of PERI may be unstable and not suitable for production use, install at your own risk.

Alternatively, you may install the development version from source. Currently, the repository is hosted on GitHub. To download and install from source you can clone and install:

git clone https://github.com/peri-source/peri.git
cd peri/
python setup.py install

After that, given you have properly set your PATH variables (see above), you should have peri on the command line.

Source releases are also tagged on GitHub and can be accessed from the cloned repository. To install a particular release, go to the cloned repo and checkout the desired tags. These tags can be listed from command line:

git tag -l
git checkout <tag name>
python setup.py install

Contributing

If you find that featuring performance is poor for a particular image or you encounter a bug / issue, please reach out to the developers.

Bugs and issues

Bugs and issues are currently reported through GitHub issues. In order to help us as much as possible to resolve the issue, please enable the highest verbosity in the peri logging system (logger) and upload your logs along with a link to the image and run script / command line to the issue tracker.

Contributing

Todo

Create a contributing doc which describes how to become a developer