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.7.dev2.tar.gz (107.4 kB view details)

Uploaded Source

Built Distribution

toil-3.0.7.dev2-py2.7.egg (314.6 kB view details)

Uploaded Source

File details

Details for the file toil-3.0.7.dev2.tar.gz.

File metadata

  • Download URL: toil-3.0.7.dev2.tar.gz
  • Upload date:
  • Size: 107.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for toil-3.0.7.dev2.tar.gz
Algorithm Hash digest
SHA256 f4036a87eac5646568d7e330bfb98642766041370ff402b4bc08f81928288ec4
MD5 5440d5de8bc0e1906d8e9b6430cd4313
BLAKE2b-256 a1e12f9af9de9daef0592327a8b257c7ee4611b06a034ab0e6c58e3460c47f84

See more details on using hashes here.

Provenance

File details

Details for the file toil-3.0.7.dev2-py2.7.egg.

File metadata

File hashes

Hashes for toil-3.0.7.dev2-py2.7.egg
Algorithm Hash digest
SHA256 240ed3d7bb4fb7da871250216f523f906597b797345a664fd6355c6fd48c87b7
MD5 835ad3f583dd77d35a6f77655c6b0a66
BLAKE2b-256 13b5c1d0ae9af765797b9ba063cb0f0803b396f1cdb686d058ba785f4445f71d

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