Skip to main content

Pipeline management software for clusters.

Project description

Toil is a massively scalable pipeline management system, written entirely in Python. Toil runs as easily on a laptop as it does on a bare-metal cluster or in the cloud, thanks to support for many batch systems, including Grid Engine, Parasol, and a custom Mesos framework.

Toil is robust, and designed to run in highly unreliable computing environments like Amazon’s Spot Market. Towards this goal, Toil does not rely on a distributed file system. Instead, Toil abstracts a pipeline’s global storage as a JobStore that can be stored either locally or on AWS. The result of this abstraction is a robust system that can be resumed even after an unexpected shutdown of every node in the cluster that resulted in the loss of all local data.

Writing a Toil script requires only a knowledge of basic Python, with Toil “Jobs” as the elemental unit of work in a Toil workflow. A Job can dynamically spawn other Jobs as needed, leading to an intuitive and powerful control over the pipeline.

Prerequisites

Python 2.5 < 3.0

pip 7.x

Apache Mesos 0.22.1, if using the Mesos batch system. This is Brew installable on OSX via:

brew install mesos

Git, if cloning from the Toil Github Repository

Installation

Toil uses setuptool’s extras syntax for dependencies of optional features, like the Mesos batch system and the AWS JobStore. To install Toil with these extras, specify the features you would like to include when pip installing:

pip install toil[aws,mesos]

Building & Testing

This is only required if cloning from Git. Running:

make develop

will install Toil in editable mode. You can also specify extras to use in develop mode as follows:

make develop extras=[mesos,aws]

To run the tests, cd into the toil root directory and run:

make test

Finally, running:

make

by itself will print help for testing and building.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toil-3.0.6a1.dev377.tar.gz (108.4 kB view details)

Uploaded Source

Built Distribution

toil-3.0.6a1.dev377-py2.7.egg (314.5 kB view details)

Uploaded Source

File details

Details for the file toil-3.0.6a1.dev377.tar.gz.

File metadata

File hashes

Hashes for toil-3.0.6a1.dev377.tar.gz
Algorithm Hash digest
SHA256 474089bf044d54943bb84a5bf864af55c5a1af3e4745b86625a942be18ef4321
MD5 05e6472e1e2ac99a850979d014e0a62a
BLAKE2b-256 02f3e7aaf455e69bda3bbc193bf1340aa3314f4561b9cefc8e6219a6eba5c7d7

See more details on using hashes here.

Provenance

File details

Details for the file toil-3.0.6a1.dev377-py2.7.egg.

File metadata

File hashes

Hashes for toil-3.0.6a1.dev377-py2.7.egg
Algorithm Hash digest
SHA256 29c7e51aebc6bca3269c22cf1968494350b177e2f0f4c4eeee8d0774f7021f61
MD5 a22fd6d6cb9af8eadbf4cbf1ab1c788e
BLAKE2b-256 6c810254cc67c0e33ef5c9997988990aec5c76f1990595649b773790540c5bd0

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page