The easiest way to install sherlock is to use pip (here we show the install inside of a conda environment):

conda create -n sherlock python=3.7 pip
conda activate sherlock
pip install sherlock

Or you can clone the github repo and install from a local version of the code:

git clone
cd sherlock
python install

To upgrade to the latest version of sherlock use the command:

pip install sherlock --upgrade

To check installation was successful run sherlock -v. This should return the version number of the install.


If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:

git clone
cd sherlock
python develop

Pull requests are welcomed!