This document explains how to install and use Docker to run GATK on a local machine. For a primer on what Docker containers are for and related terminology, see this Dictionary entry.
1. Install Docker
Follow the relevant link below depending on your computer system. On Mac and Windows, select the "Stable channel" download. Run through the installation instructions and initial setup page; they are straightforward and should take only a few minutes (not counting download time). Below are instructions for all steps after that first page, so you shouldn't need to go to any other pages in the Docker documentation.
On Mac, the installation adds a menu bar item that looks like a whale/container-ship, which conveniently shows you the status of the Docker "daemon" (= program that runs in the background) and gives you GUI access to various Docker-related functionalities. Or you can use it from the command-line, which is what we'll do in the rest of this tutorial.
Note: On some Windows systems (including non-Pro versions like Windows Home, and older versions) the "normal" Docker app doesn't work. You have to use an older app called Docker Toolbox, which you can find here.
2. Test that it works
Now, open a terminal window and invoke the
docker program directly. Checking the version is a good way to test that a program runs without investing too much effort into finding a command that works. Let's do:
This should return something like "Docker version 17.06.0-ce, build 02c1d87".
If you run into trouble at this step, you may need to run one or more of the following commands:
docker-machine restart default docker-machine regenerate-certs docker-machine env
Note: We've had reports that Docker is not compatible with some other virtual machine (VM) software. If you run into that problem, you may need to uninstall other software. Or, uh, install Docker in a virtual machine? Ahhhh, too many layers! Let's just assume your Docker install worked fine. (If not, let us know in the forum and we'll try to help you).
3. Get the GATK container image
In your terminal (it doesn't matter where your working directory is), run the following command to retrieve the GATK image from Docker Hub:
docker pull broadinstitute/gatk:188.8.131.52
Note: The last bit after
gatk: is the version tag, which you can change to get a different version than the one specified here. At time of writing, we're using the latest released version.
The GATK container image is large, so the download may take a while if you've never done this before. Good news: Next time you pull a GATK image (e.g., to get another release), Docker will pull only the updated components, so it will go faster.
4. Start up the GATK container
There are several different ways to do this in Docker. Here we're going to use the simplest invocation that gets us the functionality we need, i.e., the ability to log into the container once it's running and execute commands from inside it.
docker run -it broadinstitute/gatk:184.108.40.206
If all goes well, this will start up the container in interactive mode, and you will automatically get logged into it. Your terminal prompt will change to something like this:
At this point, you can use classic shell commands to explore the container and see what's in there.
5. Run a GATK command in the container
The container has the
gatk wrapper script all set up and ready to go, so now you can run any GATK or Picard command you want. Note: If you want to run a Picard command, use the new syntax, which follows GATK conventions (
-I instead of
I= and so on). Let's use
--list to list all tools available in this version.
The output will start with a usage message (shown below), then a full list of tools and their summary descriptions.
Using GATK wrapper script /gatk/build/install/gatk/bin/gatk Running: /gatk/build/install/gatk/bin/gatk --help USAGE: <program name> [-h]
Once you verify that this works for you, you can run any GATK commands you want. But before you proceed, there's one more setup to go through. Technically, it's optional but it will make your life much easier.
6. Use a mounted volume to access data that lives outside the container
This is the final piece of the puzzle. By default, when you're inside the container you can't access any data that live on the filesystem outside the container. One way to deal with that is to copy things back and forth, but that's wasteful and tedious. So we're going to follow the better path, which is to mount a volume in the container, i.e., establish a link that makes part of the filesystem visible from inside the container.
You can't do this after you start running the container, so you have to shut it down and run a new one (not just restart the first one) with an extra part to the command. If you wonder why we didn't do this from the get-go, it's because the first command we ran is simpler - there's less chance that something will go wrong, which is nice when you're trying something for the first time.
To shut down your container from inside it, just type exit while still inside the container:
That should stop the container and take you back to your regular prompt. It's possible to exit the container without stopping it (a move called detaching) but that's a matter for another time since here we do want to to stop it. Also, you should learn how to clean up and delete old instances of containers that you no longer want.
For now, let's focus on starting a new instance of the GATK4 container, specifying in the following command what is your particular container ID and the filesystem location you want to mount.
docker run -v ~/my_project:/gatk/my_data -it broadinstitute/gatk:220.127.116.11
Here I set the external location as an existing directory called
my_project in my home directory, (the key requirement is that it must be an absolute path) and I'm setting the mount point inside the container's
/gatk directory. The name of the mount point can be the same as the mount directory, or something completely different; the main constraint is that it can't conflict with an existing directory, as that makes the existing directory unattainable.
Assuming your paths are valid, this command starts up the container and logs you into it the same way as before; but now you can see by using
ls that you have access to your filesystem. So now you can run GATK commands on any of your data. Have fun!