Installation

This section will help you set up the necessary software and packages required to run SigProfilerExtractor.

Prerequisites¶

SigProfilerExtractor requires that you have:

Python version >= 3.4.0
SigProfilerMatrixGenerator reference genome download
- GRCh37, GRCh38, mm9, mm10, rn6, or 288c.
Other dependencies and necessary packages are downloaded during the installation.

Mac/Unix¶

First, follow the SigProfilerMatrixGenerator Mac guide for installing Python, pip, and a reference genome. Next, follow the download instructions for the latest stable release or the current Github version.

Mac/Unix Stable Release¶

Install SigProfilerExtractor using pip.

$ pip install SigProfilerExtractor

Mac/Unix Github Release¶

First, clone the Github repository.

$ git clone git@github.com:AlexandrovLab/SigProfilerExtractor.git

Next, enter the downloaded directory and install the package.

$ cd SigProfilerExtractor 
$ pip install .

After SigProfilerExtractor successfully installs, the environment is set up and ready to use.

Windows¶

First, follow the SigProfilerMatrixGenerator Windows guide for installing Python, pip, and a reference genome. Next, follow the download instructions for the latest stable release or the current Github version.

Windows Stable Release¶

Install SigProfilerExtractor using pip.

$ pip install SigProfilerExtractor

Windows Github Release¶

First, clone the Github repository.

$ git clone git@github.com:AlexandrovLab/SigProfilerExtractor.git

Next, enter the downloaded directory and install the package.

$ cd SigProfilerExtractor 
$ pip install .

After SigProfilerExtractor successfully installs, the environment is set up and ready to use.