Peregrine

Peregrine is a fast and flexible open-source software GNSS receiver. It can be used as a standalone application to post-process GNSS data all the way to PVT solutions or as from within IPython <http://ipython.org/> as a toolkit for GNSS data exploration.

Peregrine is written in Python <http://www.python.org/> for flexibility and ease of development and uses the libswiftnav C library for speed.

Full documentation available online at http://docs.swift-nav.com/peregrine.

Installation

Requirements

You can automatically install dependencies using:

$ ./deps.sh

Peregrine makes use of the following packages:

• Python 2.6 or 2.7
• Numpy 1.6 or later
• FFTW3
• pyFFTW 0.8.2 or later

Peregrine can also be used interactively with IPython and requires an additional two packages:

• [Optional] progressbar to display a progress indication in the terminal whilst running.
• [Optional] matplotlib to support generation of plots.

On Ubuntu these can be installed from the repositories:

$ sudo apt-get install python-numpy python-fftw python-matplotlib libfftw3-dev
$ pip install git+https://github.com/fnoble/python-progressbar.git

Additionally, Peregrine depends on the libswiftnav libraries and Python bindings, see each of the packages for installation instructions:

• libswiftnav

Installing Peregrine

Obtaining the source

The peregrine source are available from GitHub, https://github.com/swift-nav/peregrine.

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

$ git clone git://github.com/swift-nav/peregrine.git

Building and Installing

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

$ python setup.py install

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

Peregrine also supports a developer mode that creates a symbolic link from the source location to the install location. This enables you to modify Peregrine without having to install it every time. It can be installed by:

$ python setup.py develop

Building documentation

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

• Sphinx (and its dependencies) 1.0 or later
• numpydoc 0.4 or later
• matplotlib 1.1 or later
• ipython 0.13.1 or later
• Latex
• dvipng 1.14 or later

These packages can be installed on Ubuntu 12.04 or later:

$ sudo apt-get install python-sphinx python-matplotlib ipython texlive-full dvipng
$ sudo pip install numpydoc

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.