### Navigation

- index
- modules |
- next |
- previous |
Ruffus v. 1.0.8
- Home |
- Contents |
- Cheat sheet |
- Full tutorial |
- FAQ |
- Future plans |
- Search »

# Introduction

The `ruffus` module is a lightweight way to add support for running computational pipelines.

## Features

The `ruffus` provides automatic support for

> - Managing dependencies
> - Parallel jobs
> - Re-starting from arbitrary points, especially after errors
> - Display of the pipeline as a flowchart
> - Reporting

## Installation

### The easy way

> rufus is available as an easy-install -able package on the Python Package Index.

> 1. Install setuptools:

>        wget peak.telecommunity.com/dist/ez_setup.py
>        sudo python ez_setup.py

> 2. Install Ruffus automatically:

>        easy_install -U ruffus

### The most up-to-date code:

> More rarely, the most up-to-date code can be found from

> > - download the latest sources from here

> >   or check out the latest code from svn:

> >       svn checkout http://ruffus.googlecode.com/svn/trunk/ ruffus-read-only

> >   or ask to be a project member and enter your google name:

> >       svn checkout https://ruffus.googlecode.com/svn/trunk/ ruffus --username yourname

> > - To install, type:

> >       python setup.py install

## Whence the name Ruffus?

Cylindrophis ruffus is the name of the red-tailed pipe snake (bad python-y pun) which can be found in Hong Kong where the author comes from. Be careful not to step on one when running down country park lanes at full speed in Hong Kong: this snake is a rare breed!

Ruffus is a shy creature, and pretends to be a cobra by putting up its red tail and ducking its head in its coils when startled. It does most of its work at night and sleeps during the day: typical of many python programmers!

The original image is from wikimedia

### Navigation

- index
- modules |
- next |
- previous |
Ruffus v. 1.0.8
- Home |
- Contents |
- Cheat sheet |
- Full tutorial |
- FAQ |
- Future plans |
- Search »