BiRG is heavily dependent on Docker, therefore make sure that you have Docker installed and working. We use Docker to ensure that the environment, which we are building and testing in, is clean and reproducible.

If you don’t have Docker installed, we recommend that you follow the Docker installation guide which can be found at the following link: Docker installation guide

When Docker is installed, we recommend following the post-installation step “Manage Docker as a non-root user”, the linux guide can be found here . Setting up Docker to be used as non-root, will make it possible to run BiRG without escalated privileges.

From Docker Hub

We have prepared a docker image for running BiRG, the docker image can be downloaded from Docker Hub, by running the following command:

$ docker pull perhogfeldt/birg:latest

That’s it you can now proceed to the tutorial, for instructions on how to use the docker image.


From Source

First clone the BiRG recipe from github with the following command:

$ git clone

Next up is to create a conda environment from the environment.yml file in the BiRG repo folder:

$ cd birg
$ conda env create -f environment.yml
$ conda activate birg


There might be problems with creating an environment from the environment.yml file, if you are on a mac. A solution is to run the following commands instead:

conda create -n birg python=3.6 bioconda-utils docker-py gitdb2=2.0.5
conda activate birg

Install it with the and check if BiRG is installed correctly by running -h:

$ pip install .
$ birg -h