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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tiledb_jupyter_bioimg-0.1.1.tar.gz
  • Upload date:
  • Size: 493.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7f37ed0d8f5df91c45e34673fb1b329f089723fdf8c13e1f40c1d39db8d1d946
MD5 09c84df7cea8fef9398e74e48fe2d0bb
BLAKE2b-256 e49e02a3f51de93f8c17c67c3757583bf5a5ba3cc3471f12ed4af5c451862b00

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledb_jupyter_bioimg-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e35a26b0f347d111387cd4a0c8905e7a9a4a1206b2e422cb07345966ccdec15b
MD5 10533103e0cc6d73c17db8f6257c26fd
BLAKE2b-256 584d38633dc535fc98615889e01d3d84fb7236c9e554e4696bd57ab305a5923e

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