Skip to content

blaineylab/OpticalPooledScreens

Repository files navigation

Optical Pooled Screens

Example in situ sequencing-by-synthesis data (in example_data/) and analysis code (in ops/) for the manuscript Pooled optical screens in human cells, available on Biorxiv.

Installation (OSX)

Download the OpticalPooledScreens directory (e.g., on Github use the green "Clone or download" button, then "Download ZIP").

In Terminal, go to the OpticalPooledScreens project directory and create a Python 3 virtual environment using a command like:

python3 -m venv venv

If the python3 command isn't available, you might need to specify the full path. E.g., if Miniconda is installed in the home directory:

~/miniconda3/bin/python -m venv venv

This creates a virtual environment called venv for project-specific resources. The commands in install.sh add required packages to the virtual environment:

sh install.sh

The ops package is installed with pip install -e, so the source code in the ops/ directory can be modified in place. The package is compatible with Python 2.7 and Python 3.6, however results may not be numerically identical.

Running example code

Once installed, activate the virtual environment from the project directory:

source venv/bin/activate

You can then launch a project-specific notebook server:

jupyter notebook

The notebook ops_python.ipynb demonstrates step-by-step analysis using the high-level functions in ops.firesnake.Snake. The analysis pipeline can also be run using snakemake (after activating the virtual environment):

cd example_data
snakemake -s Snakefile_20180707_201