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.1a1.tar.gz (492.0 kB view details)

Uploaded Source

Built Distribution

tiledb_jupyter_bioimg-0.1.1a1-py3-none-any.whl (984.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a1.tar.gz
Algorithm Hash digest
SHA256 de5dbff4ff00709c3b599f8c67bda8ad5cd25882131738236a0689c619f906ee
MD5 694a18a3a52f7a49c871a5a7626e45ce
BLAKE2b-256 28ec37e12e759b18eb6d28c1f6fda38b935b293a01c4bfe587f0d6c6c6c06c07

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 68b2a4ae689d2ca6871dae2a5d28ff1d0ff37640b957d198dd7194bf02402ef8
MD5 fb5928e098ad35dc4acb17ee92fdbffb
BLAKE2b-256 d15f3f3989138a2e0542506fb7e4e648b6a3e6f29e60be470030be3185aa4f80

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