Overview¶

This section describes how to develop Toil workflows using the Toil API, the batch system API, and the job store API.

Specifically, the developing Toil section documents the following:

  • Developing a Workflow
    • Scripting quick start
    • Job basics
    • Invoking a workflow
    • Specifying arguments via the command line
    • Resuming a workflow
    • Functions and job functions
    • Workflows with multiple jobs
    • Dynamic job creation
    • Promises
    • Promised Requirements
    • FileID
    • Managing files within a workflow
      • Staging of files into the job store
    • Using Docker containers in Toil
    • Services
    • Checkpoints
    • Encapsulation
    • Depending on Toil
    • Best practices for Dockerizing Toil workflows
  • Toil API
    • Job methods
    • Job.FileStore
    • Job.Runner
    • Toil
    • Job.Service
    • FunctionWrappingJob
    • JobFunctionWrappingJob
    • EncapsulatedJob
    • Promise
    • Exceptions
  • Batch System API
    • Batch System Enivronmental Variables
    • Batch System API
  • Job Store API

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

Developing Toil Workflows

  • Overview
    • Developing a Workflow
    • Toil API
    • Batch System API
    • Job Store API
  • 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: Running in HPC Environments
    • Next: Developing a Workflow

Quick search

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