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.0.tar.gz (97.0 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.0-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for omicverse_notebook-0.1.0.tar.gz
Algorithm Hash digest
SHA256 289647ed0775ea79e5f46c084ffa4c2f896cae699fa0a15af005d5940dfdb906
MD5 d23ba91716243ea16b0cf72f0c1886a6
BLAKE2b-256 b7320921e122dfc0bc6699594af03e3fe8bdc3f2ab2567a34944517962c4a9a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omicverse_notebook-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc3869a9622be8ce9f3e67a755a373a53228560c8b38820c926b3daf13f67132
MD5 60b4c27e972a673697435a054b506e49
BLAKE2b-256 ff9cb6c3e39ec860c9d2b5e84282fc371f7869d2a5125d1e726b57d052d39ecd

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