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) 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 T-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.5.0.tar.gz (24.3 MB view details)

Uploaded Source

Built Distribution

scirpy-0.5.0-py3-none-any.whl (931.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.5.0.tar.gz
Algorithm Hash digest
SHA256 bc6d8b733e4dd38179b1d96f1b7dd9ff1a355585ce2f1465e24eb0d1f8586066
MD5 70bf8838e2bff39222488bd60ddda1bf
BLAKE2b-256 9d73a8cf8bc4105958641eed539a6c81fe51723c339955ec9fc5ec2242afe4c6

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for scirpy-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64fe5acd51fdfc526c91120194c62a550442213d24e211a65413d5248bd59210
MD5 3bff565615814ae0f1974f9767eb4fa5
BLAKE2b-256 1ed151afe3f1c0dfeaca34e4596dd717df2bc3eca6246c7ec9ccfe8b9213111d

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