Using Catalyst, the analysis is done after each simulation step, without needing to save the whole simulation data on the disk. The analysis step can output data on the disk every time step, every n time steps, or based on a condition.
+ +Meet [trame-catalyst](https://gitlab.kitware.com/keu-public/trame-catalyst-demo), a trame application for live visualizing simulation data sent through Catalyst. It can be a good alternative to the ParaView Catalyst live client. In fact, it features a simpler interface, as you can only see the raw data. Since this is a web app, it doesn’t require any client-side installation (other than a web browser), and multiple people can view the results simultaneously. What’s more, it uses remote rendering, so you can easily monitor your simulation from any device, without needing a powerful GPU on each client. + + +With trame-catalyst, the client lives in the browser.
+ +## Showcase + +This app features a full screen ParaView remote view where the simulation data can be shown. On the left, you can find some information about the simulation (connection status, current time step) and play/pause, connect/disconnect, and reset camera buttons. When connected to a simulation, the simulation channels are listed on the right side, with combo boxes to adjust the representation and the color array. + +Let’s try it out with two different simulations: + +The first simulation is a toy particle simulation that [you can find here](https://gitlab.kitware.com/keu-public/catalyst/simulator). Simply launch the trame-catalyst app, and then launch the simulation. The application will automatically pause the simulation when it connects. + + + +The second simulation is an example taken from the [ParaView Catalyst examples repository](https://gitlab.kitware.com/paraview/catalyst-examples/-/tree/master/ParaView/PythonImageData) and integrated into the trame-catalyst demo repository. + + + +## Try it yourself + +You can try trame-catalyst with your own simulation by downloading the app from [its repository](https://gitlab.kitware.com/keu-public/trame-catalyst-demo)! + +Launch the application using PVPython from a [ParaView release](https://www.paraview.org/download/): + +```shell +# Create venv +uv sync + +# Launch the application +/path/to/paraview/bin/pvpython --venv .venv src/trame_catalyst_demo/app/main.py +``` + +In parallel, you can launch any simulation that uses Catalyst. If you don’t have any, you can launch the example included in this repository. To run the simulation, you’ll need to build Catalyst with the `CATALYST_WRAP_PYTHON=ON` CMake option. + +```shell +# Download the extra python modules needed to run the simulation +uv sync --extra simulation + +# Setup environment variables for the simulation +export CATALYST_IMPLEMENTATION_PATHS=/path/to/paraview/lib/catalyst +export PYTHONPATH=/path/to/catalyst/lib/python3.14/site-packages/ + +# Launch the example simulation +uv run src/trame_catalyst_demo/example/fedriver.py src/trame_catalyst_demo/example/pipeline.py +``` + +The app will automatically pause the simulation when it is connected. You can unpause it using the play/pause button. + +## Conclusion + +Although this application can be used as-is, its main purpose is to demonstrate that visualizing simulation data live on the web is very easy with ParaView, Catalyst, and trame. + +Looking to take your application to new heights? [Contact our team](https://www.kitware.com/contact/) of experts for development and support services, and fast-track your success with trame. + +Tags: + +[Catalyst](https://www.kitware.com/tag/catalyst/) | [In Situ](https://www.kitware.com/tag/in-situ/) | [ParaView Catalyst](https://www.kitware.com/tag/paraview-catalyst/) | [Simulation Tools](https://www.kitware.com/tag/simulation-tools/) | [Trame](https://www.kitware.com/tag/trame/) | [Web Visualization](https://www.kitware.com/tag/web-visualization/) diff --git a/docs/vitepress/examples/apps/trame-catalyst.md b/docs/vitepress/examples/apps/trame-catalyst.md new file mode 100644 index 00000000..b43eab59 --- /dev/null +++ b/docs/vitepress/examples/apps/trame-catalyst.md @@ -0,0 +1 @@ +[](https://gitlab.kitware.com/keu-public/trame-catalyst-demo/) diff --git a/docs/vitepress/guide/intro/widgets.md b/docs/vitepress/guide/intro/widgets.md index 39e62462..b13c59b4 100644 --- a/docs/vitepress/guide/intro/widgets.md +++ b/docs/vitepress/guide/intro/widgets.md @@ -28,6 +28,7 @@ | **2D** | | | 👍 [annotations](https://github.com/Kitware/trame-annotations "Widgets for image and video annotations") | trame-annotations | 3 | 4 | | [bbox](https://github.com/Kitware/trame-bbox "Widget to draw and/or interact with bounding boxes") [🏗️](# "This component has been pushed to capture the current development state but is currently lacking funding to complete it.") | trame-bbox | 2 & 3 | 1 | +| | 🆕[flow](https://github.com/Kitware/trame-flow "VueFlow node editor") | trame-flow | 3 | 1 | | | 🆕👍 [image_tools](https://github.com/Kitware/trame-image-tools "Widgets to zoom/pan images with annotation overlay") | trame-image-tools | 3 | 6 | **3D** | | | [vtk, paraview](https://github.com/Kitware/trame-vtk "Interface with VTK and/or ParaView") | trame-vtk | 2 & 3 | 15 |