Some tools in GATK4, like the gCNV pipeline and the new deep learning variant filtering tools, require extensive Python dependencies. To avoid having to worry about managing these dependencies, we recommend using the GATK4 docker container, which comes with everything pre-installed, as explained here. If you are running GATK4 on a server and/or cannot use the Docker image, we recommend using the Conda package manager as a backup solution. The Conda package manager comes with all the dependencies you need, so you do not need to install everything separately. Both Conda and Docker are intended to solve the same problem, but one of the big differences/benefits of Conda is that you can use Conda without having root access. Conda should be easy to install if you follow these steps.
Refer to the installation instructions from Conda. Choose the correct version/computer you need to download it for. You will have the option of downloading Anaconda or Miniconda. Conda provides documentation about the difference between Anaconda and Miniconda. We chose to use Miniconda for this tutorial because we just wanted to use the GATK conda environment and did not want to take up too much space on our computer. If you are not going to use Conda for anything other than GATK4, you might consider doing the same. If you choose to install Anaconda, you may have access to other bioinformatics packages that are helpful to you, and you won’t have to install each package you need. Follow the prompts to properly install the .pkg file. Make sure you choose the correct package for the version of Python you are using. For example, if you have Python 2.7 on your computer, choose the version specific to it.
Go to the directory where you have stored the GATK4 jars and the
gatkwrapper script, and make sure gatkcondaenv.yml is present. Run:conda env create -n gatk -f gatkcondaenv.ymlthensource activate gatkTo check if your Conda environment is running properly, type
conda listand you should see a list of packages installed.gatkpythonpackagesshould be one of them.You can also test out whether the new variant filtering tool (CNNScoreVariants) runs properly. If you run
python -c "import vqsr_cnn"the output should look likeUsing TensorFlow backend.. If you do not have the Conda environment configured correctly, you will get an error immediately sayingImportError: No module named vqsr_cnn.If you later upgrade to a new version of GATK4, you will need to update the Conda configuration in the new GATK4 folder. If you simply overwrite the old GATK with the new one, you will get an error message saying “CondaValueError: prefix already exists: /anaconda2/envs/gatk”. For example, when I upgraded from GATK 4.0.1.2 to GATK 4.0.2.0, I simply ran (in my 4.0.2.0 folder)
source deactivate conda env remove -n gatk
Then, follow Steps 2-4 again to re-install it.
Important Do not confuse the above mentioned GATK conda environment setup with this bioconda gatk installation. The current version of the bioconda installation of GATK does not set up the conda environment used for the GATK python tools, so that must still be set up manually.
4 comments
GATK Team GATK Team: your conda installation link is broken:
I installed gatk4 from this site. However, I can not find the "gatkcondaenv.yml" file to configure conda environment. Where is the directory that stores GATK4 jars and the
gatk? Thank you!Hi,
I freshly installed miniconda3, and then downloaded the latest version of gatk (gatk-4.2.2.0; from https://github.com/broadinstitute/gatk/releases). When I ran 'conda env create -n gatk -f gatkcondaenv.yml', I got nothing but incompatible package warnings as conda tried to resolve them. Ultimately, no environment was generated that I could access and the gatkpythonpackages package was not installed, confirmed through conda list.
The version of miniconda I'm running does work on my computer, as I also run Phyluce from it, but do you have any suggestions as to how to fix this issue?
Hello I couldn't download the gatk to my Mac could you pls help me with the issue? I couldn't open the link installation instructions
Please sign in to leave a comment.