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

This version

3.0.6

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

Uploaded Source

Built Distribution

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for toil-3.0.6.tar.gz
Algorithm Hash digest
SHA256 e2a625a5a98cc705af246af7a0ddc4af5387acdefee2a4088f06ba95084da353
MD5 7b0c422c98da3c79bd680cbf5f2bc3de
BLAKE2b-256 dba0353db7c2093e644266f906d75d9234362b03f6b487f708730af844fb77e0

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: toil-3.0.6-py2.7.egg
  • Upload date:
  • Size: 314.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for toil-3.0.6-py2.7.egg
Algorithm Hash digest
SHA256 24de2b704a440647c8d5a33ccc6adb571ba9dc653d89617c5ef730e5e959a77c
MD5 2a25b86eb746fe2967655c0f3dc8fc73
BLAKE2b-256 fe50526d70bad164c8219e799f3cb3ad2ea421e91d469e7b45887b26da322283

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