Skip to content

Latest commit

 

History

History
107 lines (69 loc) · 4.43 KB

README.md

File metadata and controls

107 lines (69 loc) · 4.43 KB
Raw

jupyterview

Github Actions Status Lite Binder GitHub license PyPI version Conda Version

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).

vtu

  • Visualize and animate .pvd files.

pvd

  • Visualize mesh supported by meshio library. Full list of supported formats is available at https://github.com/nschloe/meshio. To open med files, h5py need to be installed.
jv3.mp4
  • Multiple display modes: Surface, Surface with Edge, Wireframe and Points
  • 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: