Scirpy: single-cell immune receptor analysis in Python
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
- Tutorial, and the
- API documentation.
Installation
You need to have Python 3.11 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:
-
Install the latest release of
scirpyfrom PyPI:pip install scirpy
-
Get it from Bioconda:
First setup conda channels as described here. Then install scirpy:
conda install scirpy
-
Install the latest development version:
pip install git+https://github.com/scverse/scirpy.git@main
-
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.
1 maintainer
Release files for scirpy 0.25.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scirpy-0.25.1.tar.gz | 37.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scirpy-0.25.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.9 MB
Release files / scirpy-0.25.1.tar.gz
| Download URL | scirpy-0.25.1.tar.gz |
|---|---|
| Size | 37.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f0518b60bd559f57720515c7b759138bd840928dfe9b74bf4017f2e45287be5b
|
|
BLAKE2b-256 checksum How to use checksums |
41449cde797a1e64512f144f42efc2d73b196bdb2aaada23843c75433c769637
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 21, 2026.
Transparency logRelease files / scirpy-0.25.1-py3-none-any.whl
| Download URL | scirpy-0.25.1-py3-none-any.whl |
|---|---|
| Size | 4.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
915e9442e427d3f6ed11400c87982a57e11ddeb675f661e64620b6c7521e22e1
|
|
BLAKE2b-256 checksum How to use checksums |
3282bf8f9fa6b345d6cb4f3b79e2876eb7f6f27f4fad5489a959aa93595ef854
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 21, 2026.
Transparency log
