This release is a pre-release and may not be stable for production use.
Interactive spatial‑omics analysis & visualisation toolkit for single‑cell and spatial transcriptomics data
Celldega
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)
📖 Documentation & Examples
- 📚 Documentation - Complete guides and API reference
- 🖼️ Gallery - Interactive visualization demos
- 📓 Examples - Jupyter notebooks you can run locally
- 🐍 Python API - Complete Python API
- 🌐 JavaScript API - Complete JavaScript API
🛠️ 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:
- Read our Contributing Guide
- Check open issues for ideas
- Join discussions to ask questions
🆘 Getting Help
Questions about using Celldega?
- 💬 Discussions - Ask the community
- 📖 Documentation - Comprehensive guides
- 📓 Examples - Working code you can adapt
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file celldega-0.25.0a1.tar.gz.
File metadata
- Download URL: celldega-0.25.0a1.tar.gz
- Upload date:
- Size: 3.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
Hatch/1.16.5 cpython/3.12.7 HTTPX/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d29eec8c8407c1c2dd34b863a985648ee18b89cbd07f8d4f7c0c3d1e28c3f9d
|
|
| MD5 |
fa2d20d188c5fc5e917f110fc2c3e7d9
|
|
| BLAKE2b-256 |
21fcf7c602cae724f38f3e561a3118d78cf73d17e9f0dad2ab1ab13e53e692cf
|
File details
Details for the file celldega-0.25.0a1-py3-none-any.whl.
File metadata
- Download URL: celldega-0.25.0a1-py3-none-any.whl
- Upload date:
- Size: 3.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
Hatch/1.16.5 cpython/3.12.7 HTTPX/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ff09a2305314a1d9473fa9752735ddb602836778c03bedfc3e73f1b2fe4bd2b1
|
|
| MD5 |
58584d9cb41e73002a3ffa932343421d
|
|
| BLAKE2b-256 |
1159b7378c47bf6f83ff1384f8599929474aa29d85d7b09d220963f487f713e8
|
