trungleduc / jupyterview Goto Github PK

View Code? Open in Web Editor NEW

54.0 10.0 7.0 79.48 MB

VTK Data visualization extension for JupyterLab

Home Page: https://trungleduc.github.io/jupyterview

License: BSD 3-Clause "New" or "Revised" License

TypeScript 90.74% JavaScript 2.88% Python 1.77% CSS 4.61%

jupyter jupyterlab jupyterlab-extension vtk visualization

jupyterview's Introduction

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 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:

jupyterview's People

Contributors

Stargazers

Watchers

Forkers

jtpio wangyf bjlittle tkoyama010 mattofficeuk

jupyterview's Issues

JupyterHub extension does not appear

I successfully installed the extension via pip as stated in README. Then, I restarted the service (and the server afterward when the extension was not working). The extension is listed in the extension list (see below) but it does not appear in JupyterHub GUI. Double clicking one of the sample files from this repo gives an error (see screenshot below). May I ask for help?

jupyter-XXX-singleuser@jupyter:~$ jupyter labextension list
JupyterLab v3.6.3
/var/lib/private/XXX/.local/share/jupyter/labextensions
        jupyter-matplotlib v0.11.3 enabled OK
        @jupyter-widgets/jupyterlab-manager v3.1.4 enabled OK (python, jupyterlab_widgets)

/home/jupyter/mambaforge/envs/jupyter/share/jupyter/labextensions
        jupyterlab_pygments v0.2.2 enabled OK (python, jupyterlab_pygments)
        jupyter-threejs v2.4.1 enabled OK (python, pythreejs)
        nbdime-jupyterlab v2.1.1 enabled OK
        jupyter_cadquery v2.0.2 enabled OK (python, jupyter_cadquery_widgets)
        ipyparallel-labextension v8.6.1 enabled OK
        jupyterview v0.5.1 enabled OK (python, jupyterview)
        jupyterlab-datawidgets v7.1.2 enabled OK
        webgui_jupyter_widgets v0.2.5 enabled OK (python, webgui_jupyter_widgets)
        @jupyterlab/git v0.41.0 enabled OK (python, jupyterlab-git)
        @lckr/jupyterlab_variableinspector v3.0.9 enabled OK (python, lckr_jupyterlab_variableinspector)

Other labextensions (built into JupyterLab)
   app dir: /home/jupyter/mambaforge/envs/jupyter/share/jupyter/lab

possible / planned to use with Voila?

jupyterview looks great - thanks so much!

i'd like to try and use it with https://github.com/ladybug-tools/honeybee-vtk
where the VTK rendering would displayed in voila...

is it possible (or planned) to integrate with Voila for making Apps?

many thanks

Problem loading .pvd file

I have a .pvd file (size 6,5 kB) , which I want to load with jupyterview. However, upon opening the file it gets stuck on loading forever. Other file formats such as .vtu load just fine, since I have the same data in .vtu as well. If I open the .pvd file in Paraview, it does work and it shows everything correctly. I would greatly appreciate any help or advice on how to fix this :)

Read mesh files

Hi,

I just discovered your amazing extensions and installed it with ananonda/python39/win. I can read vtu/vtk files but when it comes to others mesh files (gmsh msh or mesh Medit files) the viewer enter an infinite loop. Jupyterview relies on meshio to read various mesh files, i can manually use meshio. What's wrong ?

Best regards.

JupyterView Roadpath

@trungleduc Thanks for jupyterview, it's pretty darn awesome 😍

Just thought I'd share with you jupyterview visualising some AWI-CM FESOM climate data, where each vtk mesh consists of 126,859 cells and 2,283,462 points 👍

Also, I have a couple of questions:

I was just wondering what the roadpath is for jupyterview? Do you have any plans that you're able to share?
Are there plans to extend jupyterview to allow more than one VTK object to be added to the scene? Or, if that's already possible, how do you do it?
Is it easy for you to share instructions on how to publish jupyterview and run with jupyterlite?

Ping @koldunovn (yeah, I know it's not the triangulated version of the mesh, but still very cool!)

fesom-jupyterview.mp4

specific an icon

Hi, why you can specific an icon for your extension? thanks

Visualize multiple files together.

Hello, thanks for this nice extension.
I have not figured a way to open multiple mesh files in one window (.obj files for exemple).
Can you provide a way to do this or could you add this as feature, i figured it very simular to Glance and should not be very complicated.

Thank you in advance

0.5.0 Release Plan

This is an issue for 0.5.0 release planning. Please feel free to submit feature requests you want to have in the next release.

trungleduc / jupyterview Goto Github PK

jupyterview's Introduction

jupyterview

VTK Data visualization extension for JupyterLab

Features

Requirements

Install

Contributing

Development install

Development uninstall

Packaging the extension

Thanks

jupyterview's People

Contributors

Stargazers

Watchers

Forkers

jupyterview's Issues

Recommend Projects

Recommend Topics

Recommend Org