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

Uploaded Source

Built Distribution

tiledb_jupyter_bioimg-0.1.1a2-py3-none-any.whl (984.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a2.tar.gz
Algorithm Hash digest
SHA256 bfcf6f85a14d4b5628315d4cd36151d138385a8ca83d6a26e5429e00103a4eef
MD5 ee2a20efb17b79201c4ba57b0a2e2894
BLAKE2b-256 9a589209fd407b2374e85030bbedfd6d79cb9c8164a2e17e46837f27923c5d74

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 0effc5a06b1204cb59f8557ce7a7393810f97382ff1511ab99e0e86d7da8f225
MD5 b61c3383a45b31ab951047a264c4eae1
BLAKE2b-256 36cd4b1399ec9c725990b211c6450397764567a2e103c8e084ba6fa14b48489e

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