A jupyterlab extension to visualize bioimages in TileDB format
Project description
tiledb_jupyter_bioimg
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>>", {"token": "<<TILEDB_API_TOKEN>>>"})
Common issues
If you get error Uncaught (in promise) Error: No provider for: jupyter.extensions.jupyterWidgetRegistry. please make sure you are using correct version of ipywidgets (v8).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tiledb_jupyter_bioimg-0.2.1a1.tar.gz.
File metadata
- Download URL: tiledb_jupyter_bioimg-0.2.1a1.tar.gz
- Upload date:
- Size: 455.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 72b88078af9504073b97bc284fda9f11c21c489d73dbfbeada1f4e19047f00df |
|
| MD5 | 7b9a036307ec7599ce7f6a387985287a |
|
| BLAKE2b-256 | 8f5059f2e720ada9ae946acb823eca22a173e05acd72efc2ab1a8905b9d013ad |
Provenance
File details
Details for the file tiledb_jupyter_bioimg-0.2.1a1-py3-none-any.whl.
File metadata
- Download URL: tiledb_jupyter_bioimg-0.2.1a1-py3-none-any.whl
- Upload date:
- Size: 905.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b9b0610ea382f626be4041d554780f9128947c15367f8204a786efacc2ba44f6 |
|
| MD5 | ee1ebcf7d4eceb56baaa2f3d4e4c65aa |
|
| BLAKE2b-256 | 9daabaa6dea44b1fe1ba2f6f11fed716bc0348da9d98e06699a4ceb28890210b |
