https://github.com/kitware/trame-vtklocal

VTK Local Rendering using VTK/WASM to match server side rendering pipeline on the client side.
https://github.com/kitware/trame-vtklocal

trame trame-maintenance-program

Last synced: about 2 months ago
JSON representation

VTK Local Rendering using VTK/WASM to match server side rendering pipeline on the client side.

• Host: GitHub
• URL: https://github.com/kitware/trame-vtklocal
• Owner: Kitware
• License: other
• Created: 2024-02-19T21:40:38.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-10-16T20:02:21.000Z (3 months ago)
• Last Synced: 2024-10-18T19:10:03.427Z (3 months ago)
• Topics: trame, trame-maintenance-program
• Language: JavaScript
• Homepage:
• Size: 20.1 MB
• Stars: 15
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==============

trame-vtklocal

==============

VTK Local Rendering using VTK/WASM to match server side rendering pipeline on the client side.

The current code base is still at its infancy but we aim to make it the default implementation for local rendering using VTK/ParaView with trame.

License

----------------------------------------

This library is OpenSource and follow the Apache Software License

Installation

----------------------------------------

.. code-block:: console

    pip install trame-vtklocal 

    # We need a VTK that has its wasm counterpart

    # This is the first version available with it

    # For ParaView (not yet supported), VTK don't need to be installed

    pip install "vtk==9.4.0rc2" --extra-index-url https://wheels.vtk.org

Development

----------------------------------------

Build and install the Vue components

.. code-block:: console

    cd vue-components

    npm i

    npm run build

    cd -

Install the library

.. code-block:: console

    pip install -e .

Optionally, you can develop with bleeding edge VTK by following these steps. Make sure you've these tools

1. git

2. CMake

3. Ninja

4. Python

5. NodeJS >= 22.0.0: https://nodejs.org/en/download/package-manager

6. Emscripten SDK: See https://emscripten.org/docs/getting_started/downloads.html#download-and-install

.. code-block:: console

    # Compile VTK for wasm32 architecture using emscripten. Build artifacts can be found in dev/vtk/build/wasm

    ./utils/build_vtk.sh -u https://gitlab.kitware.com/vtk/vtk.git -b master -t wasm32 -p RelWithDebInfo

    # Compile VTK with python wrappings using system C++ compiler. Build artifacts can be found in dev/vtk/build/py

    ./utils/build_vtk.sh -u https://gitlab.kitware.com/vtk/vtk.git -b master -t py -p RelWithDebInfo

    # Set environment variables

    source ./utils/dev_environment.sh -b master -p RelWithDebInfo

Running examples

----------------------------------------

.. code-block:: console

    pip install trame trame-vtklocal trame-vuetify trame-vtk

    # We need a VTK that has its wasm counterpart

    # This is the first version available with it

    # For ParaView (not yet supported), VTK don't need to be installed

    pip install "vtk==9.3.20240810.dev0" --extra-index-url https://wheels.vtk.org

    # regular trame app

    python ./examples/vtk/cone.py 

Some example are meant to test and validate WASM rendering.

Some will default for remote rendering but if you want to force them to use WASM just run `export USE_WASM=1` before executing them.

SharedArrayBuffer

----------------------------------------

To enable SharedArrayBuffer within trame you can just set the following on the server

.. code-block:: console

    server.http_headers.shared_array_buffer = True

This will download the threaded WASM version. Otherwise, the non-threaded version will be used as it does not require SharedArrayBuffer.