Skip to main content

Python library for single-cell adaptive immune receptor repertoire (AIRR) analysis

Project description

Build Status Documentation Status PyPI Bioconda AIRR-compliant The uncompromising python formatter

Scirpy is a scalable python-toolkit to analyse T cell receptor (TCR) or B cell receptor (BCR) repertoires from single-cell RNA sequencing (scRNA-seq) data. It seamlessly integrates with the popular scanpy library and provides various modules for data import, analysis and visualization.

The scirpy workflow

Getting started

Please refer to the documentation. In particular, the

In the documentation, you can also learn more about our immune-cell receptor model.

Case-study

The case study from our preprint is available here.

Installation

You need to have Python 3.6 or newer installed on your system. If you don’t have Python installed, we recommend installing Miniconda.

There are several alternative options to install scirpy:

  1. Install the latest release of scirpy from PyPI:

pip install scirpy
  1. Get it from Bioconda:

conda install -c conda-forge -c bioconda scirpy
  1. Install the latest development version:

pip install git+https://github.com/icbi-lab/scirpy.git@master
  1. Run it in a container using Docker or Podman:

docker pull quay.io/biocontainers/scirpy:<tag>

where tag is one of these tags.

Support

We are happy to assist with problems when using scirpy. Please report any bugs, feature requests, or help requests using the issue tracker. We try to respond within two working days, however fixing bugs or implementing new features can take substantially longer, depending on the availability of our developers.

Release notes

See the release section.

Contact

Please use the issue tracker.

Citation

Sturm, G. Tamas, GS, …, Finotello, F. (2020). Scirpy: A Scanpy extension for analyzing single-cell T-cell receptor sequencing data. Bioinformatics. doi:10.1093/bioinformatics/btaa611

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scirpy-0.6.0.tar.gz (24.2 MB view details)

Uploaded Source

Built Distribution

scirpy-0.6.0-py3-none-any.whl (932.2 kB view details)

Uploaded Python 3

File details

Details for the file scirpy-0.6.0.tar.gz.

File metadata

  • Download URL: scirpy-0.6.0.tar.gz
  • Upload date:
  • Size: 24.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.0

File hashes

Hashes for scirpy-0.6.0.tar.gz
Algorithm Hash digest
SHA256 1a9214d3cac7f7e5d604620dc355594c3474c677ddfa9780e48a8c0e5c3d06f1
MD5 8fa7ed843cfdf585ed3575dc2d479380
BLAKE2b-256 6b024c9e1ce0b94c678c76913102a3cfd58e238104fd574b4585be8e6c00ba0e

See more details on using hashes here.

Provenance

File details

Details for the file scirpy-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: scirpy-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 932.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.0

File hashes

Hashes for scirpy-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4159c1d1d2276b4117f1480988e0ed6c0274423f2eb90025b3b57f00a9ba52cb
MD5 500c30a921e7a71932de6a4d610c1f15
BLAKE2b-256 84bb03425371ced2bb07b125e8d69a86ff92a822d188b37844cec822d290fa5e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page