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.4.tar.gz (20.1 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.4-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: easy_vitessce-0.0.4.tar.gz
  • Upload date:
  • Size: 20.1 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.4.tar.gz
Algorithm Hash digest
SHA256 e52d325b179fa75b6c0e53b454cd58ce86774849a4d4572ac429404b2957faf8
MD5 ff063a314b9e124640582b96a2041053
BLAKE2b-256 739ed59bce320054a721b4032ac1379c7b9a438d1063fee4127fbeaf70f98858

See more details on using hashes here.

File details

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

File metadata

  • Download URL: easy_vitessce-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 17.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f20369fca741eecaa690db0bcd72de4db7ac4e59d1a3709ab52fe5afc09d4aed
MD5 a00d44ec6d269cad5074acb1abcc1e17
BLAKE2b-256 58beafe283f6732b7252573cf211314679d4bcf85a3461670bd651f13f27de62

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