A Jupyterlab VTK viewer extension.
Project description
jupyterview
VTK Data visualization extension for JupyterLab
jupyterview is an extension that adds the VTK
data visualization capability to JupyterLab.
Powered by Kitware's vtk.js
and itk-wasm
library, jupyterview is a pure frontend extension, it does not require any kernel to operate and fully supports the Real-Time Collaboration feature of JupyterLab.
jupyterview is fully compatible with jupyterlite
, it is available online at jupyterview demo link.
Features
- Visualize structured and unstructured data (
.vtu
,.vtp
,.vtk
flies).
- Visualize and animate
.pvd
files.
- Visualize mesh supported by
meshio
library. Full list of supported formats is available at https://github.com/nschloe/meshio. To openmed
files,h5py
need to be installed.
https://user-images.githubusercontent.com/4451292/173418573-1839d689-763f-42ba-add3-4eaac4c87d7e.mp4
- Multiple display modes:
Surface
,Surface with Edge
,Wireframe
andPoints
- Color scale and isocolor effet.
- Warp by scalar effet.
Requirements
- JupyterLab >= 3.0
Install
To install the extension, execute:
pip install jupyterview
or with mamba/conda
conda install -c conda-forge jupyterview
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 jupyterview 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
Development uninstall
pip uninstall jupyterview
In development mode, you will also need to remove the symlink created by jupyter labextension develop
command. To find its location, you can run jupyter labextension list
to figure out where the labextensions
folder is located. Then you can remove the symlink named jupyterview
within that folder.
Packaging the extension
See RELEASE
Thanks
The following libraries / open-source projects were used or inspired in the development of jupyterview:
Project details
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 jupyterview-0.7.0.tar.gz
.
File metadata
- Download URL: jupyterview-0.7.0.tar.gz
- Upload date:
- Size: 18.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e887e129838fba3fcdfd81f19f9fe2c8c56c2f51900617467973fe76f7115c4 |
|
MD5 | 66f41c938414c18786f37b08ddd9fbc5 |
|
BLAKE2b-256 | 56947c3a4bb8689d5a52109f062cc722c093302473f9dda839cb4a91411da09a |
File details
Details for the file jupyterview-0.7.0-py3-none-any.whl
.
File metadata
- Download URL: jupyterview-0.7.0-py3-none-any.whl
- Upload date:
- Size: 12.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 703c5e60ba15bfe7a4c8e96f29b0158c18a2318820c93013dab2b6bc26b91c32 |
|
MD5 | 941a516bce63ad8a8c0af1c2e7ded38b |
|
BLAKE2b-256 | 22d064064e93888b8587ac0f64454cda7a11c80a3cee86b9fceb0e9970d0a3bc |