Skip to main content

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

Project description

Scirpy: single-cell immune receptor analysis in Python

Tests Documentation PyPI bioconda airr Powered by NumFOCUS

Scirpy is a package to analyse T cell receptor (TCR) or B cell receptor (BCR) repertoires from single-cell RNA sequencing (scRNA-seq) data in Python. It seamlessly integrates with scanpy and mudata and provides various modules for data import, analysis and visualization.

scirpy is part of the scverse® project (website, governance) and is fiscally sponsored by NumFOCUS. If you like scverse® and want to support our mission, please consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

Getting started

Please refer to the documentation. In particular, the

Installation

You need to have Python 3.10 or newer installed on your system. If you don't have Python installed, we recommend installing Mambaforge.

There are several alternative options to install scirpy:

  1. Install the latest release of scirpy from PyPI:

    pip install scirpy
    
  2. Get it from Bioconda:

    First setup conda channels as described here. Then install scirpy:

    conda install scirpy
    
  3. Install the latest development version:

    pip install git+https://github.com/scverse/scirpy.git@main
    
  4. Run it in a container using Docker or Podman:

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

where tag is one of these tags.

Release notes

See the changelog.

Support and Contact

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.

Citation

If you use scirpy in your work, please cite the scirpy publication as follows:

Scirpy: A Scanpy extension for analyzing single-cell T-cell receptor sequencing data

Gregor Sturm, Tamas Szabo, Georgios Fotakis, Marlene Haider, Dietmar Rieder, Zlatko Trajanoski, Francesca Finotello

Bioinformatics 2020 Sep 15. doi: 10.1093/bioinformatics/btaa611.

You can cite the scverse publication as follows:

The scverse project provides a computational ecosystem for single-cell omics data analysis

Isaac Virshup, Danila Bredikhin, Lukas Heumos, Giovanni Palla, Gregor Sturm, Adam Gayoso, Ilia Kats, Mikaela Koutrouli, Scverse Community, Bonnie Berger, Dana Pe’er, Aviv Regev, Sarah A. Teichmann, Francesca Finotello, F. Alexander Wolf, Nir Yosef, Oliver Stegle & Fabian J. Theis

Nat Biotechnol. 2023 Apr 10. doi: 10.1038/s41587-023-01733-8.

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

Uploaded Source

Built Distribution

scirpy-0.22.1-py3-none-any.whl (3.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scirpy-0.22.1.tar.gz
  • Upload date:
  • Size: 35.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scirpy-0.22.1.tar.gz
Algorithm Hash digest
SHA256 bc26a726c2d45d8c1218b58231c85d9426cb332ed34b5da045a5a31f7095271e
MD5 e0cb84f0307e4d37c880463bcd1fc46c
BLAKE2b-256 f1548ad050f3da0e32fca730779e8b77deb09f268d17585530b85f9ce8e35aae

See more details on using hashes here.

Provenance

The following attestation bundles were made for scirpy-0.22.1.tar.gz:

Publisher: release.yaml on scverse/scirpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: scirpy-0.22.1-py3-none-any.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scirpy-0.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 083b082512cd73d92a342eef54268cd421709e1400dcc14b44a3c1e3e67922ed
MD5 1ad5f5e27b5d4068ac8037d5058cdde7
BLAKE2b-256 935b77742057edaf15856dbb4aa0aeda00fa74b1656d7e11c1e1e87aea437b74

See more details on using hashes here.

Provenance

The following attestation bundles were made for scirpy-0.22.1-py3-none-any.whl:

Publisher: release.yaml on scverse/scirpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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