Skip to main content

OmicVerse-inspired DataFrame and AnnData previews for JupyterLab

Project description

omicverse-notebook

JupyterLab plugin that brings the omicverse-web DataFrame and AnnData preview ideas into a standalone package.

It provides:

  • Rich output renderers for pandas.DataFrame, pandas.Series, and anndata.AnnData
  • A JupyterLab command that opens an OmicVerse Notebook panel for inspecting kernel variables by name
  • Automatic formatter activation for the active notebook or console kernel when the JupyterLab frontend extension is loaded
  • Color-coded DataFrame columns, sticky headers, compact shape cards, and AnnData slot summaries

Scope

This package intentionally focuses on the display layer:

  • kernel-side Python helpers turn variables into JSON preview payloads
  • JupyterLab frontend plugins render those payloads and provide a lightweight inspector UI

It does not depend on the omicverse-web Flask APIs.

Install

Development install:

cd omicverse-notebook
pip install -e .

For an end-user install, build a wheel first so the prebuilt labextension is bundled:

cd omicverse-notebook
jlpm install
jlpm build:prod
pip install .

Enable rich output

If the frontend extension is loaded correctly, it will try to enable formatters automatically for the active notebook or console kernel.

Manual fallback:

%load_ext omicverse_notebook

Or:

from omicverse_notebook import enable_formatters
enable_formatters()

After that, displaying a DataFrame or AnnData object in a notebook cell will use the OmicVerse renderers.

Inspector usage

Open Command Palette and run:

OmicVerse Notebook: Open

If rich output still does not appear in an already-running kernel, run:

OmicVerse Notebook: Enable Kernel Formatters

Then inspect variables like:

df
adata
adata.obs
adata.layers["counts"]
adata.obsm["X_umap"]

Notes

  • The inspector executes a small helper snippet in the current kernel and expects the Python package to be installed in that kernel environment.
  • AnnData is optional on install, but AnnData previews only activate if anndata is available in the kernel.

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

omicverse_notebook-0.1.3.tar.gz (720.2 kB view details)

Uploaded Source

Built Distribution

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

omicverse_notebook-0.1.3-py3-none-any.whl (664.1 kB view details)

Uploaded Python 3

File details

Details for the file omicverse_notebook-0.1.3.tar.gz.

File metadata

  • Download URL: omicverse_notebook-0.1.3.tar.gz
  • Upload date:
  • Size: 720.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.10

File hashes

Hashes for omicverse_notebook-0.1.3.tar.gz
Algorithm Hash digest
SHA256 31b96b51747b22139a2cd1a85fdf52ba3c2e1c286af73933b1fd6ecde176df63
MD5 3773e1a91a3709a85ce41e01f340d696
BLAKE2b-256 193ecbd2325494961170409a1b436ad95e3eea38b033dec7e7b85573dad2e9f9

See more details on using hashes here.

File details

Details for the file omicverse_notebook-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for omicverse_notebook-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 14c43bb53edaee2ea124ff36d8c36bc6917e42cba5dbc14a819516a4f7d4cb22
MD5 e75074a0bf68ee3e8835a6de5c0d0ace
BLAKE2b-256 534f9005a6ed366af5e937cd46c33e9e6c0d3b7a0270e3a1ba15eb0c942d5ac0

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