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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.11.2.tar.gz
Algorithm Hash digest
SHA256 dde0e379abe3e8bc109b61448be718ab10c06cc25cb2e74a1a3ee80cdedea2a3
MD5 c77ec2819f9749ddeca59c2eeb214e3f
BLAKE2b-256 294f586959086f4cbed10ccfd853e7d67feb0b2fb498ea2caad548747fa7146a

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dab8fe198422a14f0f11c927390b0862d6cc7f6abe9fefc935cad04124a0cf72
MD5 1fe8f6785858e308cb7abd5d69589929
BLAKE2b-256 7eb58b50aa1c023dd8fda3662903f521df1ef0121a5f1ed9edad327841190804

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