A package to easily use Vitessce to create interactive plots for single-cell data
Project description
Easy Vitessce
🪄 Configure Vitessce with a single line of code!
Turn your static Scanpy and SpatialData plots into interactive Vitessce visualizations simply by importing the easy_vitessce package!
Supported Functions
sc.pl.umapsc.pl.tsnesc.pl.pcasc.pl.diffmapsc.pl.embeddingsc.pl.violinsc.pl.dotplotsc.pl.heatmapsdata.pl(.render_images,.render_labels,.render_shapes,.render_points)
See the example notebooks and the documentation for further details.
Installation
Install package using pip:
pip install easy_vitessce
How to Use
Importing Easy Vitessce
import easy_vitessce as ev
🪄 By default, interactive plots are enabled via this import statement.
Deactivating Interactive Plots:
ev.disable_plots(["embedding", "violin", "spatialdata-plot"])
# or, to disable all interactive plots and return to static plotting mode
ev.disable_plots()
Reactivating Interactive Plots:
ev.enable_plots(["spatialdata-plot"])
# or, to enable all interactive plots
ev.enable_plots()
Troubleshooting
See the Troubleshooting section of the vitessce-python repository for tips.
Development
Set up environment
uv sync --extra dev --extra docs
This command should also be run after updating dependencies in pyproject.toml.
Run tests
# uv sync --extra dev
uv run pytest
Make documentation
uv run make html # on mac/linux
# uv run make.bat html # on windows
open docs/_build/html/index.html
Launch Jupyter notebook or lab
# uv sync --extra dev
uv run jupyter notebook --notebook-dir .
# or
uv run jupyter lab --notebook-dir .
Citation
To cite EasyVitessce in your work, please use:
@article{luo2025easyvitessce,
title = {{EasyVitessce: auto-magically adding interactivity to Scverse single-cell and spatial biology plots}},
author = {Luo, Selena and Keller, Mark S. and Kakar, Tabassum and Choy, Lisa and Gehlenborg, Nils},
journal = {arXiv},
year = {2025},
month = oct,
doi = {10.48550/arXiv.2510.19532}
}
To cite Vitessce in your work, please use:
@article{keller2024vitessce,
title = {{Vitessce: integrative visualization of multimodal and spatially resolved single-cell data}},
author = {Keller, Mark S. and Gold, Ilan and McCallum, Chuck and Manz, Trevor and Kharchenko, Peter V. and Gehlenborg, Nils},
journal = {Nature Methods},
year = {2024},
month = sep,
doi = {10.1038/s41592-024-02436-x}
}
If you use the image rendering functionality, please additionally cite Viv:
@article{manz2022viv,
title = {{Viv: multiscale visualization of high-resolution multiplexed bioimaging data on the web}},
author = {Manz, Trevor and Gold, Ilan and Patterson, Nathan Heath and McCallum, Chuck and Keller, Mark S. and Herr, II, Bruce W. and Börner, Kay and Spraggins, Jeffrey M. and Gehlenborg, Nils},
journal = {Nature Methods},
year = {2022},
month = may,
doi = {10.1038/s41592-022-01482-7}
}
Project details
Release history Release notifications | RSS feed
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 easy_vitessce-0.0.9.tar.gz.
File metadata
- Download URL: easy_vitessce-0.0.9.tar.gz
- Upload date:
- Size: 20.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.8.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44ae2617ccee789fbfc5279ec3b5f62baaf56cb51475cd855f6621c52e7244b1
|
|
| MD5 |
48471461f247008953c99c72178dd1f9
|
|
| BLAKE2b-256 |
d93f2fd9ffaed8754cdc18748af34275fafeea291d587f735a628d95d8e26443
|
File details
Details for the file easy_vitessce-0.0.9-py3-none-any.whl.
File metadata
- Download URL: easy_vitessce-0.0.9-py3-none-any.whl
- Upload date:
- Size: 23.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.8.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
76251059e154af46240a32c3780588ca0b5931d7f0aa4a5f1041e9ec077513cc
|
|
| MD5 |
8bb52bf6bf8f636ccfceff877fa2d2de
|
|
| BLAKE2b-256 |
d0b9f14a3b2dd067b4191bc779cedccfcd23ee0fb0595da5a40b473df7b65101
|