Skip to content

2. Installation

Ahmed Abdelmoneim edited this page Feb 17, 2022 · 6 revisions

Installing sgRNAble

sgRNAble can be installed from the Pypi repository or directly from GitHub following the instructions below:

Creating a Conda environment for sgRNAble

We recommend creating a conda environment to avoid interference of dependencies. To create a new environment, run the following command in a terminal window:

conda create --name sgRNAble python=3.7

This will create a new environment with the name sgrnable using python 3.7.

Installing sgRNAble using PIP - Option #1

To install sgrnable from PyPi, simply run

pip install sgrnable

Installing sgRNAble from GitHub - Option #2

To clone a copy of the source code, follow the instructions in the contribution guide

You can then install a copy from the source code by navigating to the repository root and running

pip install .

Computational requirements

The codebase is tested to work on Linux and Windows 10 under Python 3.8. Python 2.x isn't supported and will never be. Sorry for the inconvenience. To download and install python 3, use the documentation provided here.