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.7 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.9.0.tar.gz (24.7 MB view details)

Uploaded Source

Built Distribution

scirpy-0.9.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.9.0.tar.gz
Algorithm Hash digest
SHA256 84691ec59a93ce814c6dab672cae4813b74b4ec7e7a3a2060502c8f3d1b8ffcd
MD5 1e8eb0cf3caf950eca7c556bcd2252d0
BLAKE2b-256 d96efe4eb190bc89f54014dd60ff6ea0154bce51a6b57417fd6fe6229a1fefc9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: scirpy-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.26.0

File hashes

Hashes for scirpy-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e58c1c5a3a8b65cdbcb66322a292197f2291dc01e0b7e62b8e2673670eb2c07
MD5 40754bd6850c89279eb0eef385048b88
BLAKE2b-256 1b5f74307d956743fb0a8b2df31e097c566b41e51e2f5a199d497e59cdc68b1d

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