Skip to main content

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.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.2.tar.gz (19.5 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.2-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: easy_vitessce-0.0.2.tar.gz
  • Upload date:
  • Size: 19.5 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.2.tar.gz
Algorithm Hash digest
SHA256 33aa9a7bc7d81a2b947cf56c088230e152bb91b9c58c8ed64db163cd15b30d72
MD5 2e9657f69a47c383d23910465bdcb524
BLAKE2b-256 7d8afc56e9d227e722229fa9a9d1111184203fb01a67b7a30e13d963db169ac6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: easy_vitessce-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 15.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2ec20d443808f223c68726a4bda1cf738787cd0670779c4ba168724327d1040b
MD5 0b43b6acb581b8e32b03bb84bf0fb72d
BLAKE2b-256 d923b9fbbb2969d759816b243373bffc8dc6a3c8a487f6d7108ee468dca7e320

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