Skip to main content

A jupyterlab extension to visualize bioimages in TileDB format

Project description

tiledb_jupyter_bioimg

Github Actions Status

A jupyterlab extension to visualize bioimages in TileDB format

Requirements

  • JupyterLab >= 3.0

Install

pip install tiledb_jupyter_bioimg

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the tiledb_jupyter_bioimg directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall tiledb_jupyter_bioimg

Usage

from tiledb_jupyter_bioimg import Render

Render("<<NAMESPACE>>", "<<GROUP_ID>>")

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

tiledb_jupyter_bioimg-0.1.1a5.tar.gz (489.8 kB view details)

Uploaded Source

Built Distribution

tiledb_jupyter_bioimg-0.1.1a5-py3-none-any.whl (978.6 kB view details)

Uploaded Python 3

File details

Details for the file tiledb_jupyter_bioimg-0.1.1a5.tar.gz.

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a5.tar.gz
Algorithm Hash digest
SHA256 0debe92fd21ad8547fda7bed31c23cae5ac265750c9b3fda809d36165463480e
MD5 347bc52e5c34f305d4d3d29fe964b5c1
BLAKE2b-256 f09cd1c91292e56533b31bf6ab3d784e0f989fb140f7111505a5bde8f1ab6553

See more details on using hashes here.

Provenance

File details

Details for the file tiledb_jupyter_bioimg-0.1.1a5-py3-none-any.whl.

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a5-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f23d859910e30b2a3b7a9d1819eb2b9a317c6574604001432ab104d23aabdd
MD5 8391e126799aeaa84cad98d564d720bf
BLAKE2b-256 99d2e2f8e4588553093a6e20d4254b863dc3cf60657ef1f50431dc6988185d1b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page