Installation

Stable Release (Recommended)

The latest stable release and associated dependencies can be installed from PyPi:

pip install sarracen

This is the recommended way to install Sarracen.

Development Snapshot (via pip)

The latest development snapshot is available on the GitHub repository. This can be installed directly through pip by using

pip install git+https://github.com/ttricco/sarracen.git

This will install Sarracen in your local environment, as well as any required dependencies.

Development Snapshot (via git)

Alternatively, the repository can be cloned locally and the dependencies installed manually. First, clone the repository to your local machine either using the https link

git clone https://github.com/ttricco/sarracen.git

or clone through ssh using a password-protected ssh key

git clone git@github.com:ttricco/sarracen.git

The list of dependencies are stored in requirements.txt. These can be installed into your Python environment using pip

pip install -r requirements.txt

This method does not install Sarracen as a package in your Python environment. You will need to define the path to Sarracen so that your Python code can locate it. See below.

import sys
sys.path.append('/path/to/sarracen')  # replace with your path to Sarracen

import sarracen