Remote Controlled Area

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

The client-side code is split into a framework-agnostic core (js-components) and Vue/React adapters that depend on it. Install and build the core first, then the adapter(s) you need.

cd js-components
npm i

cd ../vue-components
npm i
npm run build

# optional React adapter
cd ../react-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.

The codec is negotiated when the video-decoder display mounts: the client asks the server which codecs it can encode (trame.rca.video.codecs), filters them with VideoDecoder.isConfigSupported, and sends the accepted list back (trame.rca.video.negotiate). The server then creates the encoder with vtkEncoderFactory preferences Hardware=true;Codec=<accepted list>. No frames are pushed before negotiation. Pass on_video_codec to create_view_handler to be told what was selected (codec, backend, hardware, label or error).

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

Release files for trame-rca 2.11.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for trame-rca 2.11.5
File	Size	Uploaded
trame_rca-2.11.5.tar.gz	68.8 kB	Sep 25, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for trame-rca 2.11.5
File	Interpreter	ABI	Platform	Reset
trame_rca-2.11.5-py3-none-any.whl 78.3 kB Sep 25, 2026	Python 3	none	any	Details

Total release size: 147.1 kB

Release files / trame_rca-2.11.5.tar.gz

Download URL	trame_rca-2.11.5.tar.gz
Size	68.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`f03ad9f7bf9ec022f023a2721c9b348ea152aa75ce47903e5ae05a5fe56cd4de`
BLAKE2b-256 checksum How to use checksums	`9793a0ec389b366fbd11a37f80b1404c72936979610f0fbb8d020ad9c6e1ed24`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Kitware/trame-rca
Publishing commit: github.com/Kitware/trame-rca/tree/814ef762f4c7e64e9d498cc592ec238203598160

Workflow

Publishing configuration: github.com/Kitware/trame-rca/blob/814ef762f4c7e64e9d498cc592ec238203598160/.github/workflows/test_and_release.yml
Publishing logs: github.com/Kitware/trame-rca/actions/runs/36168795322/attempts/1

Artifact

Subject: trame_rca-2.11.5.tar.gz
SHA-256 checksum: f03ad9f7bf9ec022f023a2721c9b348ea152aa75ce47903e5ae05a5fe56cd4de Verifying attestations

Release files / trame_rca-2.11.5-py3-none-any.whl

Download URL	trame_rca-2.11.5-py3-none-any.whl
Size	78.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5972edca903fa766e4b2d1a81627bcbb80a499dfcc8a730f1538a7b0f2e01a1d`
BLAKE2b-256 checksum How to use checksums	`e85d52079fd123f2d9a290030bd83953c5292f2932d18e5409f5acf3fef7473b`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Kitware/trame-rca
Publishing commit: github.com/Kitware/trame-rca/tree/814ef762f4c7e64e9d498cc592ec238203598160

Workflow

Publishing configuration: github.com/Kitware/trame-rca/blob/814ef762f4c7e64e9d498cc592ec238203598160/.github/workflows/test_and_release.yml
Publishing logs: github.com/Kitware/trame-rca/actions/runs/36168795322/attempts/1

Artifact

Subject: trame_rca-2.11.5-py3-none-any.whl
SHA-256 checksum: 5972edca903fa766e4b2d1a81627bcbb80a499dfcc8a730f1538a7b0f2e01a1d Verifying attestations