docs(docker): add example for multi-user

examples/docker/Dockerfile

@@ -0,0 +1,11 @@
+FROM --platform=linux/amd64 kitware/trame:py3.10
+
+RUN apt-get update \
+ && apt-get install -y libosmesa6-dev libxrender1 \
+ && rm -rf /var/lib/apt/lists/*
+
+RUN apt-get install -y libosmesa6-dev libxrender1
+
+COPY --chown=trame-user:trame-user . /deploy
+
+RUN /opt/trame/entrypoint.sh build

examples/docker/README.md

@@ -0,0 +1,19 @@
+# Multi-user Docker Setup
+
+This directory capture what is needed for setting up a docker image using vtklocal.
+
+## Building the docker image
+
+The following command lines assume to be ran within the directory containing this README.md
+
+```
+docker build --progress=plain  -t trame-wasm .
+```
+
+## Running image
+
+```
+docker run -p 8080:80 -it trame-wasm 
+```
+
+Then open your browser to `http://localhost:8080/`.

examples/docker/app.py

@@ -0,0 +1,207 @@
+import vtk
+
+from trame.app import get_server
+from trame.ui.html import DivLayout
+from trame.widgets import html, client, vtklocal, trame as tw, vuetify3 as v3
+from trame.decorators import TrameApp, change
+from trame.assets.remote import HttpFile
+from trame.assets.local import to_url
+
+FULL_SCREEN = "position:absolute; left:0; top:0; width:100vw; height:100vh;"
+K_RANGE = [0.0, 15.6]
+P1 = [-0.4, 0, 0.05]
+P2 = [-0.4, 0, 1.5]
+
+BIKE = HttpFile(
+    "/deploy/bike.vtp",
+    "https://github.com/Kitware/trame-app-bike/raw/master/data/bike.vtp",
+)
+TUNNEL = HttpFile(
+    "/deploy/tunnel.vtu",
+    "https://github.com/Kitware/trame-app-bike/raw/master/data/tunnel.vtu",
+)
+IMAGE = HttpFile(
+    "/deploy/seeds.jpg",
+    "https://github.com/Kitware/trame-app-bike/raw/master/data/seeds.jpg",
+)
+
+if not BIKE.local:
+    BIKE.fetch()
+
+if not TUNNEL.local:
+    TUNNEL.fetch()
+
+if not IMAGE.local:
+    IMAGE.fetch()
+
+
+def create_vtk_pipeline():
+    resolution = 50
+
+    renderer = vtk.vtkRenderer()
+    renderWindow = vtk.vtkRenderWindow()
+    renderWindow.AddRenderer(renderer)
+    renderWindow.OffScreenRenderingOn()
+
+    renderWindowInteractor = vtk.vtkRenderWindowInteractor()
+    renderWindowInteractor.SetRenderWindow(renderWindow)
+    renderWindowInteractor.GetInteractorStyle().SetCurrentStyleToTrackballCamera()
+
+    bikeReader = vtk.vtkXMLPolyDataReader()
+    bikeReader.SetFileName(BIKE.path)
+
+    tunnelReader = vtk.vtkXMLUnstructuredGridReader()
+    tunnelReader.SetFileName(TUNNEL.path)
+    tunnelReader.Update()
+
+    lineSeed = vtk.vtkLineSource()
+    lineSeed.SetPoint1(*P1)
+    lineSeed.SetPoint2(*P2)
+    lineSeed.SetResolution(resolution)
+    lineSeed.Update()
+
+    lineWidget = vtk.vtkLineWidget2()
+    lineWidgetRep = lineWidget.GetRepresentation()
+    lineWidgetRep.SetPoint1WorldPosition(P1)
+    lineWidgetRep.SetPoint2WorldPosition(P2)
+    lineWidget.SetInteractor(renderWindowInteractor)
+
+    streamTracer = vtk.vtkStreamTracer()
+    streamTracer.SetInputConnection(tunnelReader.GetOutputPort())
+    streamTracer.SetSourceConnection(lineSeed.GetOutputPort())
+    streamTracer.SetIntegrationDirectionToForward()
+    streamTracer.SetIntegratorTypeToRungeKutta45()
+    streamTracer.SetMaximumPropagation(3)
+    streamTracer.SetIntegrationStepUnit(2)
+    streamTracer.SetInitialIntegrationStep(0.2)
+    streamTracer.SetMinimumIntegrationStep(0.01)
+    streamTracer.SetMaximumIntegrationStep(0.5)
+    streamTracer.SetMaximumError(0.000001)
+    streamTracer.SetMaximumNumberOfSteps(2000)
+    streamTracer.SetTerminalSpeed(0.00000000001)
+
+    tubeFilter = vtk.vtkTubeFilter()
+    tubeFilter.SetInputConnection(streamTracer.GetOutputPort())
+    tubeFilter.SetRadius(0.01)
+    tubeFilter.SetNumberOfSides(6)
+    tubeFilter.CappingOn()
+    tubeFilter.Update()
+
+    bike_mapper = vtk.vtkPolyDataMapper()
+    bike_actor = vtk.vtkActor()
+    bike_mapper.SetInputConnection(bikeReader.GetOutputPort())
+    bike_actor.SetMapper(bike_mapper)
+    renderer.AddActor(bike_actor)
+
+    stream_mapper = vtk.vtkPolyDataMapper()
+    stream_actor = vtk.vtkActor()
+    stream_mapper.SetInputConnection(tubeFilter.GetOutputPort())
+    stream_actor.SetMapper(stream_mapper)
+    renderer.AddActor(stream_actor)
+
+    lut = vtk.vtkLookupTable()
+    lut.SetHueRange(0.7, 0)
+    lut.SetSaturationRange(1.0, 0)
+    lut.SetValueRange(0.5, 1.0)
+
+    stream_mapper.SetLookupTable(lut)
+    stream_mapper.SetColorModeToMapScalars()
+    stream_mapper.SetScalarModeToUsePointData()
+    stream_mapper.SetArrayName("k")
+    stream_mapper.SetScalarRange(K_RANGE)
+
+    renderWindow.Render()
+    renderer.ResetCamera()
+    renderer.SetBackground(0.4, 0.4, 0.4)
+
+    lineWidget.On()
+
+    return renderWindow, lineSeed, lineWidget
+
+
+@TrameApp()
+class App:
+    def __init__(self, server=None):
+        self.server = get_server(server)
+        self.rw, self.seed, self.widget = create_vtk_pipeline()
+        self._build_ui()
+
+        # reserve state variable for widget update
+        self.state.line_widget = {"p1": P1, "p2": P2}
+        self.state.trame__title = "trame + VTK.wasm"
+
+    @property
+    def state(self):
+        return self.server.state
+
+    @property
+    def ctrl(self):
+        return self.server.controller
+
+    @change("line_widget")
+    def _on_widget_update(self, line_widget, **_):
+        if line_widget is None:
+            return
+
+        p1 = line_widget.get("p1")
+        p2 = line_widget.get("p2")
+
+        self.seed.SetPoint1(p1)
+        self.seed.SetPoint2(p2)
+
+        if line_widget.get("widget_update", False):
+            self.widget.representation.point1_world_position = p1
+            self.widget.representation.point2_world_position = p2
+
+        # prevent requesting geometry too often
+        self.ctrl.view_update()
+
+    def _build_ui(self):
+        with DivLayout(self.server):
+            client.Style("body { margin: 0; }")
+            with v3.VCard(
+                style="position: absolute; top: 1rem; left: 1rem; width: 20vw; height: calc(20vw + 4rem); z-index: 1;"
+            ):
+                tw.LineSeed(
+                    image=to_url(IMAGE.path),
+                    point_1=("line_widget.p1",),
+                    point_2=("line_widget.p2",),
+                    bounds=("[-0.399, 1.80, -1.12, 1.11, -0.43, 1.79]",),
+                    update_seed="line_widget = { ...$event, widget_update: 1 }",
+                    n_sliders=2,
+                )
+            with html.Div(style=FULL_SCREEN):
+                with vtklocal.LocalView(self.rw) as view:
+                    view.update_throttle.rate = 20
+                    self.ctrl.view_update = view.update_throttle
+                    self.widget_id = view.register_widget(self.widget)
+                    view.listeners = (
+                        "listeners",
+                        {
+                            self.widget_id: {
+                                "InteractionEvent": {
+                                    "line_widget": {
+                                        "p1": (
+                                            self.widget_id,
+                                            "WidgetRepresentation",
+                                            "Point1WorldPosition",
+                                        ),
+                                        "p2": (
+                                            self.widget_id,
+                                            "WidgetRepresentation",
+                                            "Point2WorldPosition",
+                                        ),
+                                    },
+                                },
+                            },
+                        },
+                    )
+
+
+def main():
+    app = App()
+    app.server.start()
+
+
+if __name__ == "__main__":
+    main()

examples/docker/setup/apps.yml

@@ -0,0 +1,11 @@
+trame:
+  cmd:
+    - python
+    - /deploy/app.py
+    - --host
+    - ${host}
+    - --port
+    - ${port}
+    - --authKey
+    - ${secret}
+    - --server

examples/docker/setup/initialize.sh

@@ -0,0 +1,3 @@
+# Run the app once at build time to download files
+# --timeout 1 => will auto exit after 2s
+python /deploy/app.py --server --timeout 2

examples/docker/setup/requirements.txt

@@ -0,0 +1,5 @@
+trame
+trame-vuetify
+trame-vtklocal
+trame-components
+vtk>=9.4