trame-rca 2.8.0

Remote Controlled Area widget for trame

Remote Controlled Area widget for trame provide components and communication infrastructure to display remote generated image based content while allowing interaction forwarding such as mouse, touch and multi-pointer devices.

This library aims to provide a core that can then be extended or specialized for any backend. But its initial integration will be focused toward VTK and/or ParaView for enabling interactive remote rendering. But because it aims to be generic, you should be able to rely on its core to connect and drive any kind of backend that could produce images/video-stream and react to mouse interaction.

License

trame-rca is made available under the Apache Software License.

Development

Build and install the Vue components

cd vue-components
npm i
npm run build
cd -

Install the component

pip install -e .

Optional dependencies

TurboJPEG

Faster Jpeg encoding using TurboJPEG.

macOS system install

# macOS
brew install jpeg-turbo

Windows install

Download and install from Github: https://github.com/libjpeg-turbo/libjpeg-turbo/releases

Linux install

# RHEL/CentOS/Fedora
# YUM doc: https://libjpeg-turbo.org/Downloads/YUM

# Ubuntu
apt-get install libturbojpeg

Once your system is ready, you can try our code example:

pip install trame trame-vuetify vtk
pip install "trame-rca[turbo]"

# other encoders: jpeg, avif, turbo-jpeg, png, webp
python ./examples/01_vtk/vtk_cone_simple.py --encoder turbo-jpeg

Video encoding with VTKStreaming

VTKStreaming provides tools for encoding and streaming frames from a VTK OpenGL render window using video codecs. When NVENC is available, it enables H.264/H.265 hardware encoding; otherwise, software encoding falls back to VP9 via libvpx.

You can try our code example:

pip install trame trame-vuetify vtk
pip install "trame-rca[vtkstreaming]"

python ./examples/05_video/vtk_cone_simple_video.py

In order to use source-build of vtkstreaming, please clone [VTKStreaming](https://github.com/Kitware/VTKStreaming.git) one level up outside the trame-rca directory, checkout the wheel branch, and install it inside the trame-rca virtual environment

cd ..
git clone https://github.com/Kitware/VTKStreaming.git
cd VTKstreaming
uv pip install --group dev          # build deps into active venv; index from tool.uv.index
uv pip install -e . --no-build-isolation
cd ../trame-rca

python ./examples/05_video/vtk_cone_simple_video.py