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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a4.tar.gz
Algorithm Hash digest
SHA256 91c9133822763d5b89c22cff9556b8106f5dc6fb490c9fcbcd0b2197f92b27b3
MD5 8c2a876f89b540f596e639d2e545ece7
BLAKE2b-256 b106a221b000c65971a31916f215c95516d09b183fda576a403317dbece35666

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a4-py3-none-any.whl
Algorithm Hash digest
SHA256 d59ea801783344105179dd8f39c2a4d50ee9b26397202657ceead4758ad824bf
MD5 f3866bd071e2fa9f44ca4eb3779d923d
BLAKE2b-256 232348ae7de227074d0c6e0628b57ba8f36759bd8836131e49ecd20a20963b69

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