Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 2.81 KB

01-Install.md

File metadata and controls

58 lines (34 loc) · 2.81 KB

Installation

We are going to ask you to install docker, a powerful, versatile computing tool on your laptop.

Then we will use docker to run cwltool and awe-submit, both of which are meta-tools that manage other programs.

Common Workflow Language is the protocol for telling cwltool and awe-submit how to run programs.

We will use cwltool to run a toy workflow locally and awe-submit to send a bioinformatics workflow to a compute server.

Docker

Install Docker CE for your desktop from https://docs.docker.com/v17.09/engine/installation/#server

You will need to choose your operating system to get the right installer. The installers are about 600Mb.

What does docker do? Docker allows running commands in pre-configured containers that include programs, operating systems, and sometimes training data bundled together. Docker manages starting and interacting with these containers.

Why bother? Docker lets you run linux tools on other operating systems. Even better, docker lets you run different linux tools in their own environments, and you can expect tools to work out of the box without installation steps.

Common Workflow Language

The Common Workflow Language is a tooling layer that describes what resources and data tools need to run, and what data tools produce. This specification allows CWL to manage the interface with a tool--getting the data in and getting the data out.

Common Workflow Language User Guide

Why bother? Describing the tool at a high level can let us run the tool in different settings. Some tools run on our local operating system, some might run in a docker container, and some can be run on a remote server. Most of the parts of the tool specification will remain the same, and we can start using tools without repeating the installation, configuration, and operating system drudgery every time.

We are not going to install the cwl engine on your laptop -- because we can run it from a docker container.

# every time I try to run "cwltool", start the docker container commonworkflowlanguage/cwltool and run cwltool inside it
alias cwltool='docker run -v /var/run/docker.sock:/var/run/docker.sock -v /tmp:/tmp -v "$PWD":"$PWD" -w="$PWD" commonworkflowlanguage/cwltool'