Skip to content

Finish making all the examples use best practice #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jourdain merged 6 commits into from
May 7, 2026
Merged

Finish making all the examples use best practice #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae41918
docs(examples): convert base example using the TrameApp base class
UlysseDurand May 5, 2026
a3bdcdf
docs(examples): update examples to use TrameApp
UlysseDurand May 5, 2026
99c57ae
docs(examples): put const global on the module rather than in the class
UlysseDurand May 5, 2026
fb4773e
docs(examples): update the example to use the TrameApp class
UlysseDurand May 5, 2026
3a3c29d
docs(examples): make the user import trame-components
UlysseDurand May 5, 2026
12d3b6d
docs(examples): change **kwargs with **_kwargs because they are unused
UlysseDurand May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions 00_setup/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout

# -----------------------------------------------------------------------------
# Get a server to work with
# -----------------------------------------------------------------------------

server = get_server()
class App(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

# -----------------------------------------------------------------------------
# GUI
# -----------------------------------------------------------------------------

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")

# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app = App()
app.server.start()

if __name__ == "__main__":
server.start()
main()
19 changes: 13 additions & 6 deletions 01_vtk/app_cone.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout

# -----------------------------------------------------------------------------
# Get a server to work with
# -----------------------------------------------------------------------------

server = get_server()
class AppCone(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

# -----------------------------------------------------------------------------
# GUI
# -----------------------------------------------------------------------------

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")

# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app = AppCone()
app.server.start()

if __name__ == "__main__":
server.start()
main()
34 changes: 20 additions & 14 deletions 01_vtk/app_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout
from trame.widgets import vtk, vuetify3
from trame.widgets import vtk, vuetify3 as v3

from vtkmodules.vtkFiltersSources import vtkConeSource
from vtkmodules.vtkRenderingCore import (
Expand Down Expand Up @@ -44,23 +44,29 @@
# Trame
# -----------------------------------------------------------------------------

server = get_server()
ctrl = server.controller
class AppFlow(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")

with layout.content:
with vuetify3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")

with self.ui.content:
with v3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)

# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app_flow = AppFlow()
app_flow.server.start()

if __name__ == "__main__":
server.start()
main()
35 changes: 21 additions & 14 deletions 01_vtk/solution_cone.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout
from trame.widgets import vtk, vuetify3
from trame.widgets import vtk, vuetify3 as v3

from vtkmodules.vtkFiltersSources import vtkConeSource
from vtkmodules.vtkRenderingCore import (
Expand Down Expand Up @@ -44,24 +44,31 @@
# Trame
# -----------------------------------------------------------------------------

server = get_server()
ctrl = server.controller
class AppCone(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")

with layout.content:
with vuetify3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
html_view = vtk.VtkLocalView(renderWindow)
ctrl.on_server_ready.add(html_view.update)
with self.ui.content:
with v3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
html_view = vtk.VtkLocalView(renderWindow)
self.ctrl.on_server_ready.add(html_view.update)
Copy link
Copy Markdown
Collaborator

@jourdain jourdain May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that line is not needed anymore. (self.ctrl.on_server_ready.add)

Copy link
Copy Markdown
Contributor Author

@UlysseDurand UlysseDurand May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line removed in

Copy link
Copy Markdown
Contributor Author

@UlysseDurand UlysseDurand May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is addressed in

#9



# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app = AppCone()
app.server.start()

if __name__ == "__main__":
server.start()
main()
33 changes: 20 additions & 13 deletions 01_vtk/solution_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import os
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout
from trame.widgets import vtk, vuetify3
from trame.widgets import vtk, vuetify3 as v3

from vtkmodules.vtkCommonColor import vtkNamedColors
from vtkmodules.vtkCommonCore import vtkLookupTable
Expand Down Expand Up @@ -127,23 +127,30 @@
# GUI
# -----------------------------------------------------------------------------

server = get_server()
ctrl = server.controller
class AppFlow(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")

with layout.content:
with vuetify3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)
with self.ui.content:
with v3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)


# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app_flow = AppFlow()
app_flow.server.start()

if __name__ == "__main__":
server.start()
main()
36 changes: 21 additions & 15 deletions 01_vtk/solution_ray_cast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

# Web imports
import os
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout
from trame.widgets import vtk, vuetify3
from trame.widgets import vtk, vuetify3 as v3

# -----------------------------------------------------------------------------
# Example: SimpleRayCast
Expand Down Expand Up @@ -97,24 +97,30 @@
# Web Application setup
# -----------------------------------------------------------------------------

server = get_server()
ctrl = server.controller
class RayCastApp(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")

with layout.content:
with vuetify3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkRemoteView(renWin)
# view = vtk.VtkLocalView(renWin)
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")
with self.ui.content:
with v3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkRemoteView(renWin)
# view = vtk.VtkLocalView(renWin)


# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app_ray_cast = RayCastApp()
app_ray_cast.server.start()

if __name__ == "__main__":
server.start()
main()
34 changes: 21 additions & 13 deletions 02_layouts/app_cone.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import SinglePageLayout
from trame.widgets import vtk, vuetify3
from trame.widgets import vtk, vuetify3 as v3

from vtkmodules.vtkFiltersSources import vtkConeSource
from vtkmodules.vtkRenderingCore import (
Expand Down Expand Up @@ -44,23 +44,31 @@
# Trame
# -----------------------------------------------------------------------------

server = get_server()
ctrl = server.controller
class AppCone(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

with SinglePageLayout(server) as layout:
layout.title.set_text("Hello trame")
def _build_ui(self):
with SinglePageLayout(self.server) as self.ui:
self.ui.title.set_text("Hello trame")

with layout.content:
with vuetify3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)
with self.ui.content:
with v3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
html_view = vtk.VtkLocalView(renderWindow)
self.ctrl.on_server_ready.add(html_view.update)


# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app = AppCone()
app.server.start()

if __name__ == "__main__":
server.start()
main()
33 changes: 21 additions & 12 deletions 02_layouts/solution_FullScreenPage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from trame.app import get_server
from trame.app import TrameApp
from trame.ui.vuetify3 import VAppLayout
from trame.widgets import vtk, vuetify3
from trame.widgets import vtk, vuetify3 as v3

from vtkmodules.vtkFiltersSources import vtkConeSource
from vtkmodules.vtkRenderingCore import (
Expand Down Expand Up @@ -44,20 +44,29 @@
# Trame
# -----------------------------------------------------------------------------

server = get_server()
ctrl = server.controller
class AppCone(TrameApp):
def __init__(self, server=None):
super().__init__(server)
self._build_ui()

def _build_ui(self):
with VAppLayout(self.server) as self.ui:
with self.ui.root:
with v3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)
self.ctrl.on_server_ready.add(view.update)

with VAppLayout(server) as layout:
with layout.root:
with vuetify3.VContainer(
fluid=True,
classes="pa-0 fill-height",
):
view = vtk.VtkLocalView(renderWindow)

# -----------------------------------------------------------------------------
# Main
# -----------------------------------------------------------------------------

def main():
app = AppCone()
app.server.start()

if __name__ == "__main__":
server.start()
main()
Loading