Skip to content

Installation

Requirements

  • Python 3.9 or higher
  • numpy, pandas, scanpy, anndata (core dependencies)
  • matplotlib, seaborn (visualization)

Install from PyPI

pip install tcrsift

Install from Source

git clone https://github.com/pirl-unc/tcrsift.git
cd tcrsift
pip install -e .

Optional Dependencies

PDF Report Generation

For generating PDF reports:

pip install reportlab pdfkit

You'll also need wkhtmltopdf:

brew install wkhtmltopdf
sudo apt-get install wkhtmltopdf

Download from wkhtmltopdf.org

Ensembl Data for Constant Regions

For assembling full-length TCR sequences with constant regions:

pip install pyensembl
pyensembl install --release 93 --species human

Statistical Modeling

For logistic regression-based filtering:

pip install statsmodels

Verify Installation

tcrsift --version

Or in Python:

import tcrsift
print(tcrsift.__version__)