Skip to content

Installation

On this page, you will find out how to install ZARP on your system.

Requirements

Installation requires the following:

  • Linux (tested with Ubuntu 20.04; macOS has not been tested yet)
  • Conda (tested with conda 22.11.1)
  • Mamba (tested with mamba 1.3.0)
  • Singularity (tested with singularity 3.8.6; not required if you have root permissions on the machine you would like to install ZARP on; in that case, see below)

Other versions, especially older ones, are not guaranteed to work.

TODO: Add/replace requirements/versions and check that everything is correct

Installation steps

1. Clone ZARP

Clone the ZARP workflow repository with:

git clone git@github.com:zavolanlab/zarp
# or: git clone https://github.com/zavolanlab/zarp.git

2. Set up Conda environment

TODO: Add on...