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 paper 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/scverse/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.

  • If you need help with scirpy or have questions regarding single-cell immune-cell receptor analysis in general, please join us in the scverse discourse.

  • For bug report or feature requests, please use 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.12.0.tar.gz (25.7 MB view details)

Uploaded Source

Built Distribution

scirpy-0.12.0-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.12.0.tar.gz
Algorithm Hash digest
SHA256 4700dce86174b83d2f662cf89d6511485177de87d99469a2c49ab71cd11dc260
MD5 b3cbe071e501a418d16d729dee2e4a89
BLAKE2b-256 408cb96847fd55f5c1c345f33c310792871e47524b0dae71bc64d4357c6c1be1

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b5afbb6573ba1fa6825aced58f2a4fe023f9a50e1c4169e8b8c324cf5207b9c
MD5 cf7cee82db26b47dbd2103b9515968b4
BLAKE2b-256 d22f837bc1e1adaa48205ff478a9f301b755dcbfbb9edc7d89c4d0785eb5d12a

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