Skip to main content

A package to easily use Vitessce to create interactive plots for single-cell data

Project description

Easy Vitessce

Open In Colab

🪄 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.umap
  • sc.pl.tsne
  • sc.pl.pca
  • sc.pl.embedding
  • sc.pl.spatial
  • sc.pl.violin
  • sc.pl.dotplot
  • sc.pl.heatmap
  • sdata.pl (.render_images, .render_labels, and .render_shapes)

See 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.configure_plots(disable_plots = ["embedding", "violin", "spatialdata-plot"])

Reactivating Interactive Plots:

ev.configure_plots(enable_plots = ["spatialdata-plot"])

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easy_vitessce-0.0.8.tar.gz (20.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easy_vitessce-0.0.8-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file easy_vitessce-0.0.8.tar.gz.

File metadata

  • Download URL: easy_vitessce-0.0.8.tar.gz
  • Upload date:
  • Size: 20.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for easy_vitessce-0.0.8.tar.gz
Algorithm Hash digest
SHA256 6d8548af219163773672ecdbe8bdb360814ce17d8bc2d3481610a0fe8dd08e5f
MD5 06190556721d17597e74fdad232d18b4
BLAKE2b-256 8599a913727426b81650bf3ceff18d9d5ae546ddaa6ab0ae667eb6a0d6cfa658

See more details on using hashes here.

File details

Details for the file easy_vitessce-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: easy_vitessce-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for easy_vitessce-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 589dd6a4927b208e5d19b601ed161d9c735343ffe8f6560cb0b3a73aff674f4b
MD5 19581038630b566a30208221340a0308
BLAKE2b-256 63af0756c5f3f8fb64cd1943047a888d2275fd3c186c7ae38bd4b2990f835093

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page