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

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.6.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.6-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: easy_vitessce-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 f9b24ed0b36d53fbdc83e373d675c41072bf639b07f55e1cc634923b662e51be
MD5 23e25966b858c32194662a240a41acd6
BLAKE2b-256 a053650ca9380356aeddcde48a2528b5c21cbadc932f895ef536852c5debef68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: easy_vitessce-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 22.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 134fe3d9305500ecc3cf1ff8ed98faad48585f85adc02d92769c44adc93a10d0
MD5 3ab81920d0db23c6adce1335a186a37c
BLAKE2b-256 f7542ed980614bb59bc53ad9aa6e3576cbc99b79873b4e67752b40ffbe6c83ca

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