Skip to main content

PyPI version

Panpipes - multimodal single cell pipelines

Overview

Panpipes is a set of computational workflows designed to automate multimodal single-cell and spatial transcriptomic analyses by incorporating widely-used Python-based tools to perform quality control, preprocessing, integration, clustering, and reference mapping at scale. Panpipes allows reliable and customisable analysis and evaluation of individual and integrated modalities, thereby empowering decision-making before downstream investigations.

See our documentation

Panpipes is on Genome Biology!

These workflows make use of cgat-core

Available workflows:

  1. "ingest" : Ingest data and compute quality control metrics
  2. "preprocess" : Filter and normalize per modality
  3. "integration" : Integrate and batch correct using single and multimodal methods
  4. "clustering" : Cluster cells per modality
  5. "refmap" : Map queries against reference datasets
  6. "vis" : Visualize metrics from other pipelines in the context of experiment metadata
  7. "qc_spatial" : Ingest spatial transcriptomics data (Vizgen, Visium) and compute quality control metrics
  8. "preprocess_spatial" : Filtering and normalize spatial transcriptomics data
  9. "deconvolution_spatial" : Deconvolve cell types of spatial transcriptomics slides

Installation and configuration

For detailed installation instructions (including those for Apple Silicon machines), refer to the installation instructions here.

We recommend installing panpipes in a conda environment. We provide a minimal conda config file in pipeline_env.yaml. First, clone this repository and navigate to the root directory of the repository:

git clone https://github.com/DendrouLab/panpipes.git
cd panpipes

Then, create the conda environment and install the nightly version of panpipes using the following command:

conda env create --file=pipeline_env.yaml 
conda activate pipeline_env
pip install -e .

Oxford BMRC Rescomp users find additional advice on the installation here.

Releases

Since panpipes v.1.2.0 the spatial workflows use SpatialData as the data format for spatial assays. Check out the documentation at https://panpipes-pipelines.readthedocs.io

Since panpipes v0.4.0, the ingest workflow expects different headers for the RNA and Protein modalities from the previous releases. Check the example submission file and the documentation for more detailed instructions.

Citation

Curion, F., Rich-Griffin, C., Agarwal, D. et al. Panpipes: a pipeline for multiomic single-cell and spatial transcriptomic data analysis. Genome Biol 25, 181 (2024). doi: https://doi.org/10.1186/s13059-024-03322-7

Contributors

Created by Charlotte Rich-Griffin and Fabiola Curion. Maintained by Fabiola Curion and Sarah Ouologuem. Additional contributors: Sarah Ouologuem, Devika Agarwal, Lilly May, Kevin Rue-Albrecht, Giulia Garcia, Wojciech Lason, Lukas Heumos, Jarne Belien.

Release files for panpipes 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for panpipes 1.2.0
File Size Uploaded
panpipes-1.2.0.tar.gz 172.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for panpipes 1.2.0
File Interpreter ABI Platform
panpipes-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 412.0 kB

Release files / panpipes-1.2.0.tar.gz

Download URL panpipes-1.2.0.tar.gz
Size 172.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0470cd9416342057298f7f22f2e1ee65a78df8031c7b5a1221b8bac56962c7f9
BLAKE2b-256 checksum
How to use checksums
9450cb723204be2c24f69c40e046da52d6ce5c8511ca925ac84c47b7eccdd83f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.17

Release files / panpipes-1.2.0-py3-none-any.whl

Download URL panpipes-1.2.0-py3-none-any.whl
Size 239.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
40c4a355c94c00ab7e5221260ca5114a0f1f0d4e83f1d802da8f0cead46e59e9
BLAKE2b-256 checksum
How to use checksums
acd9062640d0a67222af0c1b8ed6db898cf15e6c8bee08095ea10edd754375cb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.17

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page