Overview

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

Computational pipelines are often conceptually quite simple, especially if we breakdown the process into simple stages, or separate tasks.

Each stage or task in a computational pipeline is represented by a python function Each python function can be called in parallel to run multiple jobs.

Ruffus was originally designed for use in bioinformatics to analyse multiple genome data sets.

Documentation

Ruffus documentation can be found here , with an download notes , a short tutorial and an in-depth tutorial .

Background

The purpose of a pipeline is to determine automatically which parts of a multi-stage process needs to be run and in what order in order to reach an objective (“targets”)

Computational pipelines, especially for analysing large scientific datasets are in widespread use. However, even a conceptually simple series of steps can be difficult to set up and to maintain, perhaps because the right tools are not available.

Design

The ruffus module has the following design goals:

Simplicity. Can be picked up in 10 minutes

Elegance

Lightweight

Unintrusive

Flexible/Powerful

Features

Automatic support for

Managing dependencies

Parallel jobs

Re-starting from arbitrary points, especially after errors

Display of the pipeline as a flowchart

Reporting

A Simple example

Use the @follows(…) python decorator before the function definitions:
from ruffus import *
import sys

def first_task():
    print "First task"

@follows(first_task)
def second_task():
    print "Second task"

@follows(second_task)
def final_task():
    print "Final task"
the @follows decorator indicate that the first_task function precedes second_task in the pipeline.

Usage

Each stage or task in a computational pipeline is represented by a python function Each python function can be called in parallel to run multiple jobs.
Import module:
import ruffus
Annotate functions with python decorators
Print dependency graph if you necessary
For a graphical flowchart in jpg, svg, dot, png, ps, gif formats:
graph_printout ( open("flowchart.svg", "w"),
                 "svg",
                 list_of_target_tasks)
This requires dot to be installed
For a text printout of all jobs
pipeline_printout(sys.stdout, list_of_target_tasks)
Run the pipeline:
pipeline_run(list_of_target_tasks, [list_of_tasks_forced_to_rerun, multiprocess = N_PARALLEL_JOBS])

Metadata

Release files for ruffus 2.4prerelease

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ruffus 2.4prerelease
File	Size	Uploaded	Provenance
ruffus-2.4prerelease.tar.gz	90.8 kB	Mar 11, 2014	Without provenance	Details

Release files / ruffus-2.4prerelease.tar.gz

Download URL	ruffus-2.4prerelease.tar.gz
Size	90.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`bf2c49da9f9aeed458bd757109b5c65a279a91f18ca910971183fa3af7b45e31`
BLAKE2b-256 checksum How to use checksums	`855725ce429ba09559c0b9d651803124562ac809ec3a87d7db2e93386e93844c`
Upload date	Mar 11, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for ruffus 2.4prerelease

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.