Overview¶

This section describes how to run Toil in various environments, including locally, in the cloud, and with using CWL.

Specifically, the running Toil section documents detail for the following:

  • Toil Workflow Options and Command Line Interface
    • Logging
    • Stats
    • Restart
    • Clean
    • Batch system
    • Default cores, disk, and memory
    • Job store
    • Miscellaneous
    • Running Workflows with Services
  • CWL in Toil
    • Running CWL Locally
    • Running CWL in the Cloud
  • Deploying a Workflow
    • Deploying a Local Workflow
    • Deploying a Remote Workflow
      • Remote deployment with sibling modules
      • Remotely deploying a package hierarchy
      • Relying on shared filesystems
    • Using Docker with Toil
  • Running in AWS
    • Toil Provisioner
    • Details about Launching a Cluster in AWS
      • Static Provisioning
      • Uploading Workflows
      • Running a Workflow with Autoscaling
      • Preemptability
    • Cluster Utilities
      • launch-cluster
      • ssh-cluster
      • rsync-cluster
      • destroy-cluster
  • Running in Azure
    • Launch a leader node in Azure
    • Launch a Toil Mesos Cluster
  • Running in Openstack
  • Running in GCE
  • Running in HPC Environments

Logo

Table Of Contents

Getting Started

  • Overview
  • Installation
  • Quickstart Examples

Running Toil

  • Overview
    • Toil Workflow Options and Command Line Interface
    • CWL in Toil
    • Deploying a Workflow
    • Running in AWS
    • Running in Azure
    • Running in Openstack
    • Running in GCE
    • Running in HPC Environments
  • Toil Workflow Options and Command Line Interface
  • CWL in Toil
  • Deploying a Workflow
  • Running in AWS
  • Running in Azure
  • Running in Openstack
  • Running in GCE
  • Running in HPC Environments

Developing Toil Workflows

  • Overview
  • Developing a Workflow
  • Toil API
  • Batch System API
  • Job Store API

Contributing to Toil

  • Overview
  • Running tests
  • Developing with the Toil Appliance
  • Maintainer’s Guidelines

Appendices

  • Toil Architecture
  • Toil Environment Variables

Related Topics

  • Documentation overview
    • Previous: Quickstart Examples
    • Next: Toil Workflow Options and Command Line Interface

Quick search

©2015 – 2017 UCSC Computational Genomics Lab. | Powered by Sphinx 1.5.3 & Alabaster 0.7.10
Fork me on GitHub