Skip to main content

Celldega banner

PyPI version Python Documentation

Interactive spatial‑omics analysis & visualisation toolkit for single‑cell and spatial transcriptomics data

Celldega

Demo

Celldega Demo Video

https://github.com/user-attachments/assets/ce43a3a0-8aff-4424-be74-8bb06c29a9c9

Celldega combines scalable computational pipelines with GPU‑accelerated, web‑native visualisations so you can explore millions of cells and transcripts directly inside Jupyter Lab, VS Code, or any modern browser. Built for researchers working with Xenium, Visium HD, MERFISH, and other spatial omics technologies.

🚀 Quick Start (30 min)

Installation

pip install celldega

For Terra.bio Users

Add this to your startup script for image processing features (more info):

apt update && apt install -y libvips libvips-tools libvips-dev

Example Usage

base_url = 'https://raw.githubusercontent.com/broadinstitute/celldega_Xenium_Prime_Human_Skin_FFPE_outs/main/Xenium_Prime_Human_Skin_FFPE_outs'

landscape_ist = dega.viz.Landscape(
    technology="Xenium",
    ini_zoom=-4.5,
    ini_x=6000,
    ini_y=8000,
    base_url=base_url,
    height=700,
    width=600,
)

# Alternatively pass an AnnData object to auto-populate cell metadata
# including "leiden" clusters, colors and UMAP coordinates.
landscape_from_adata = dega.viz.Landscape(
    base_url=base_url,
    AnnData=adata,
)

file_path = 'https://raw.githubusercontent.com/broadinstitute/celldega_Xenium_Prime_Human_Skin_FFPE_outs/main/Xenium_Prime_Human_Skin_FFPE_outs/df_sig.parquet'
df = pd.read_parquet(file_path)

mat = dega.clust.Matrix(df)
mat.cluster()
cgm = dega.viz.Clustergram(matrix=mat)

dega.viz.landscape_clustergram(landscape_ist, cgm)

Celldega Demo

📖 Documentation & Examples

🛠️ Development Setup (for Contributors)

Get started contributing in 2 minutes:

git clone https://github.com/broadinstitute/celldega.git
cd celldega

bash ./scripts/setup.sh

source dega/bin/activate
npm run dev

See our Contributing Guide for detailed instructions.

🏗️ Repository Structure

Directory/File Purpose
src/celldega/ 🐍 Core Python package
js/ 🌐 JavaScript widgets & visualizations
examples/ 📓 Jupyter notebook examples
docs/ 📚 Documentation source
js/__tests__/ 🧪 JS/TS Test suites
tests/ 🧪 Python Test suites
scripts/ 🔧 Development utilities

🤝 Contributing

We welcome contributions from the bio community! Whether you're a:

  • 🧬 Researcher - Share datasets, create tutorials, improve documentation
  • 👩‍💻 Developer - Add features, fix bugs, optimize performance
  • 📚 Educator - Create educational content, examples, workshops
  • 🎨 Designer - Improve visualizations, user experience, documentation

Getting started:

  1. Read our Contributing Guide
  2. Check open issues for ideas
  3. Join discussions to ask questions

🆘 Getting Help

Questions about using Celldega?

Found a bug or want a feature?

📊 Citation

If Celldega helps your research, please cite us:

@software{celldega,
  title   = {Celldega: Interactive spatial‑omics analysis & visualisation toolkit},
  author  = {{Broad Institute}},
  url     = {https://github.com/broadinstitute/celldega},
  version = {0.12.0},
  year    = {2025}
}

🏛️ About

Celldega is developed at the Broad Institute together with the biology research community. Our mission is to make spatial transcriptomics analysis accessible, interactive, and beautiful.

Built on amazing open source tools:

  • deck.gl - GPU-accelerated visualizations
  • PyArrow - Fast columnar data processing
  • AnnData - Annotated data matrices
  • SpatialData - Spatial omics data structures

Made with 🧬 by the Spatial Technology Platform at the Broad Institute

Metadata

Release files for celldega 0.27.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 celldega 0.27.0
File Size Uploaded Provenance Actions
celldega-0.27.0.tar.gz 3.5 MB Without provenance Details for celldega-0.27.0.tar.gz

Built distribution (wheel)

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

Total release size: 7.1 MB

Release files / celldega-0.27.0.tar.gz

Download URL celldega-0.27.0.tar.gz
Size 3.5 MB
Tags Source
SHA-256 checksum
How to use checksums
00c37e6723ca2d738d2dea5649f87a0723844810a8467561ea682a07831dee08
BLAKE2b-256 checksum
How to use checksums
81633c1d31bd8001b9cca64d7b955ab2a12270dc5b5c2c03a6d8e488630b0ca9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.5 cpython/3.12.7 HTTPX/0.27.0

Release files / celldega-0.27.0-py3-none-any.whl

Download URL celldega-0.27.0-py3-none-any.whl
Size 3.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
50312f05faeaea1918b3f9fc59c900163d9482ba3f4d9a432fb0ffa9b7ecb41e
BLAKE2b-256 checksum
How to use checksums
5290fdba7b97959264a9b21cdd87230bd4a2b0821213b0dc49635c886c3cc689
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.5 cpython/3.12.7 HTTPX/0.27.0

Security for celldega 0.27.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.27.0 This release

2 release files No provenance

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