Table Of Contents

Previous topic


Next topic

Getting started

This Page


To run Sumatra you will need Python installed on your machine. If you are running Linux or OS X, you almost certainly already have it. If you don’t have Python, you can install it from, or install one of the “value-added” distributions aimed at scientific users of Python: Enthought, Python(x,y) or Anaconda.

The easiest way to install Sumatra is directly from the Python Package Index (PyPI):

$ pip install sumatra

Alternatively, you can download the Sumatra package from either PyPI or the INCF Software Centre and install it as follows:

$ tar xzf Sumatra-0.7.0.tar.gz
$ cd Sumatra-0.7.0
# python install

The last step may need to be run as root, or using sudo, although in general we recommend installing in an isolated environment created using virtualenv or conda.

Installing Django

If you wish to use the web interface, you will also need to install Django version 1.6 or later. On Linux, you may be able to do this via your package management system: see

Otherwise, it is very easy to install manually: see

You will also need to install the parameters, django-tagging and docutils packages, which may be in your package management system, otherwise they can be installed using pip:

$ pip install parameters
$ pip install django-tagging
$ pip install docutils

Installing Python bindings for your version control system

Sumatra currently supports Mercurial, Subversion, Git and Bazaar. If you are using Subversion, you will need to install the pysvn bindings. Since Bazaar is mostly written in Python, just installing the main Bazaar package is sufficient. For Git, you need to install the GitPython package. For Mercurial, you need to install the hgapi package.

Command completion for bash

Sumatra comes with a limited bash completion facility. You can install it to you system by sourcing the file in your .bashrc or .profile. By default, Sumatra installs this script to your `/usr/bin directory by default but moving it elsewhere (e.g. to ~/.bash_completion.d/) is recommended.