Skip to main content

Celldega banner

PyPI version Python License 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.26.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.26.0
File Size Uploaded
celldega-0.26.0.tar.gz 3.5 MB Details

Built distribution (wheel)

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

Total release size: 7.1 MB

Release files / celldega-0.26.0.tar.gz

Download URL celldega-0.26.0.tar.gz
Size 3.5 MB
Tags Source
SHA-256 checksum
How to use checksums
66b1c6bb7f97fbd82d3f2e6a083e93c3ead7f3887271835da4f55e39726e2929
BLAKE2b-256 checksum
How to use checksums
8a4a8ab0970e3e0a7c31b16b51471d01cee3de0c2151532b3aa30dc986ed45ec
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.26.0-py3-none-any.whl

Download URL celldega-0.26.0-py3-none-any.whl
Size 3.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f5fd49efea28029bf528ca322061af18ca471d36432a4f3ea9f383f6950f038b
BLAKE2b-256 checksum
How to use checksums
c2d9d957a792f4ba6a1bf4411c75e0924753ec17671087ee7fb609072c147905
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 history Release notifications | RSS feed

This release

0.26.0 This release

2 release files

0.25.1

2 release files

0.25.0

2 release files

0.24.2

2 release files

0.21.2

2 release files

0.21.1

2 release files

0.21.0

2 release files

0.20.0

2 release files

0.19.0

2 release files

0.18.1

2 release files

0.18.0

2 release files

0.17.0

2 release files

0.16.0

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.4

2 release files

0.14.3

2 release files

0.14.2

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.1

2 release files

0.9.0

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.5

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

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.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

3 release files

0.1.3

3 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.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