Peregrine has the following requirements:

Peregrine also depends on other projects for optional features.

  • progressbar to display a progress indication in the terminal whilst running.


Peregrine makes use of some extensions to the progressbar library that are not yet merged upstream. For now you can install our development version as follows:

$ pip install git+

Installing Peregrine

Obtaining the source

The peregrine source and release tarballs are available from GitHub,

The latest development version of peregrine can be cloned from GitHub using this command:

git clone git://

Building and Installing


pyFFTW requires FFTW3 which should be available through your operating system package manager. For Mac OS X we recommend using Homebrew.


Installation requires Distribute, if your python installation doesn’t provide this it will automatically be installed.

To install Peregrine (from the root of the source tree):

$ python install

This will download and install any required python modules from PyPI.

If you are a developer and intend to make modifications to Peregrine then you can instead run:

$ python develop

Which is similar to install but instead of copying Peregrine to the install location, a link is made from the source location to the install location so you can continue to work on the source without having to run install every time you wish to test your changes.

Building documentation


The latest version of Peregrine’s documentation should be available online at

Building the documentation requires the Peregrine source code and some additional packages:

To build the Peregrine documentation, execute the following commands:

$ cd docs
$ make html

The documentation will be built in the docs/_build/html directory, and can be read by pointing a web browser to docs/_build/html/index.html.

Table Of Contents

Previous topic

Welcome to peregrine’s documentation!

Next topic

Command-line Usage

This Page