vtk-demo 0.1.0__tar.gz

vtk_demo-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+.venv/
+.nox/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+
+# Written by `vtk-demo run export.bunny-html`
+exports/
+
+# Window settings written by Dear ImGui (hello_imgui) demos
+*.ini

vtk_demo-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to vtk-demo
+
+## Development setup
+
+With [uv](https://docs.astral.sh/uv/), set up a `.venv` with every extra and
+the development dependencies (for your editor, or to run the demos from the
+checkout):
+
+```bash
+uv sync --all-extras --dev
+uv run vtk-demo list
+```
+
+Lint, tests and builds go through [nox](https://nox.thea.codes/) (the same
+sessions run in CI):
+
+```bash
+uvx nox                   # lint + tests on Python 3.10 to 3.13
+uvx nox -s tests-3.12     # a single Python version
+uvx nox -s tests-3.12 -- -k galaxy   # extra arguments are passed to pytest
+uvx nox -s format         # ruff --fix and ruff format
+uvx nox -s build          # sdist + wheel in dist/, smoke tested
+```
+
+## Adding a demo
+
+1. Build the scene in `vtk_demo/scenes/` as a `build_*(renderer, ...)` function,
+   in plain VTK (no PyVista).
+2. Add `vtk_demo/apps/<group>/<name>.py` with a `main()` reading `sys.argv`.
+3. Register it in `DEMOS` (`vtk_demo/apps/__init__.py`).
+4. Add a 1280×800 screenshot to `docs/screenshots/` and to the gallery in the [README](README.md#gallery).
+
+## Releasing
+
+Commits on `main` follow [Conventional Commits](https://www.conventionalcommits.org/)
+(`fix:` → patch, `feat:` → minor, `feat!:` / `BREAKING CHANGE:` → major;
+`major_on_zero = false` keeps breaking changes on the minor while in `0.x`).
+
+Releases are manual: **Actions › Release › Run workflow** on `main`. The workflow
+runs the tests, then [python-semantic-release](https://python-semantic-release.readthedocs.io/)
+bumps `__version__`, updates `CHANGELOG.md`, commits, tags `vX.Y.Z` and creates
+the GitHub release. The wheel and sdist built with `uvx nox -s build` are attached to
+the release and published to PyPI. Use `dry_run` to preview the next version,
+or `force` to pick the bump yourself.
+
+Preview locally with:
+
+```bash
+uvx --from python-semantic-release semantic-release --noop version --print
+```

vtk_demo-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vtk_demo-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.5
+Name: vtk-demo
+Version: 0.1.0
+Summary: Fancy VTK / PyVista scenes and demo applications that show off VTK capabilities and performance
+Project-URL: Homepage, https://github.com/Kitware/vtk-demo
+Project-URL: Source, https://github.com/Kitware/vtk-demo
+Project-URL: Issues, https://github.com/Kitware/vtk-demo/issues
+Project-URL: Changelog, https://github.com/Kitware/vtk-demo/blob/main/CHANGELOG.md
+Author-email: Sebastien Jourdain <sebastien.jourdain@kitware.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: demo,pyvista,trame,visualization,vtk,wasm,webgpu
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pyvista>=0.48
+Requires-Dist: vtk>=9.5
+Provides-Extra: all
+Requires-Dist: imgui-bundle; (python_version >= '3.11') and extra == 'all'
+Requires-Dist: trame-pyvista>=0.2.1; extra == 'all'
+Requires-Dist: trame-vtk; extra == 'all'
+Requires-Dist: trame-vtklocal>=1.7.2; extra == 'all'
+Requires-Dist: trame-vuetify; extra == 'all'
+Requires-Dist: trame>=3.12; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: nox[uv]>=2025.2.9; extra == 'dev'
+Provides-Extra: export
+Requires-Dist: trame-vtklocal>=1.7.2; extra == 'export'
+Provides-Extra: imgui
+Requires-Dist: imgui-bundle; (python_version >= '3.11') and extra == 'imgui'
+Provides-Extra: trame
+Requires-Dist: trame-pyvista>=0.2.1; extra == 'trame'
+Requires-Dist: trame-vtk; extra == 'trame'
+Requires-Dist: trame-vtklocal>=1.7.2; extra == 'trame'
+Requires-Dist: trame-vuetify; extra == 'trame'
+Requires-Dist: trame>=3.12; extra == 'trame'
+Description-Content-Type: text/markdown
+
+# vtk-demo
+
+Fancy VTK / PyVista scenes that show off VTK capabilities and performance:
+GPU instancing, composite datasets, PBR, transparency, huge point clouds, live
+simulations… plus the demo applications built on them (VTK.wasm + WebGPU in
+the browser with trame, standalone HTML exports, and Dear ImGui).
+
+## Install
+
+```bash
+pip install vtk-demo              # scenes only (vtk, pyvista)
+pip install "vtk-demo[trame]"     # + web applications
+pip install "vtk-demo[export]"    # + standalone HTML export
+pip install "vtk-demo[all]"
+```
+
+## Reusable scenes
+
+`vtk_demo.scenes` is plain VTK and numpy, through VTK's Python friendly API
+(keyword constructors, snake_case properties, numpy backed arrays, `>>`
+pipelines). Every `build_*` function fills a `vtkRenderer` (actors,
+background, camera) and returns a few statistics:
+
+```python
+import vtkmodules.vtkInteractionStyle  # noqa: F401
+import vtkmodules.vtkRenderingOpenGL2  # noqa: F401
+from vtkmodules.vtkRenderingCore import (
+    vtkRenderer,
+    vtkRenderWindow,
+    vtkRenderWindowInteractor,
+)
+
+from vtk_demo.scenes import build_glyph_island
+
+renderer = vtkRenderer()
+n_actors, n_instances, n_triangles = build_glyph_island(renderer)
+window = vtkRenderWindow(size=(1280, 800))
+window.AddRenderer(renderer)
+interactor = vtkRenderWindowInteractor(render_window=window)
+interactor.Start()
+```
+
+PyVista only comes in with the applications, through a small adapter that
+builds a scene into a plotter and keeps the scene's camera:
+
+```python
+import pyvista as pv
+from vtk_demo.pyvista_adapter import add_scene
+from vtk_demo.scenes import build_glyph_island
+
+plotter = pv.Plotter()
+n_actors, n_instances, n_triangles = add_scene(plotter, build_glyph_island)
+plotter.show()
+```
+
+| Module | What it provides |
+| --- | --- |
+| `scenes.instancing` | `InstanceLayer`: many copies of one mesh, drawn with a `vtkGlyph3DMapper` (`glyph_actor`), one actor per copy (`instance_actors`) or baked into one mesh (`bake_layer`) |
+| `scenes.composite` | `composite_actor`, `scattered_collection`, `partitioned_collection`: many meshes in one `vtkCompositePolyDataMapper` actor |
+| `scenes.island` | The 43k object voxel island, drawn four ways: `build_glyph_island`, `build_actor_island`, `build_archipelago`, `build_partitioned_island` |
+| `scenes.pbr` | `build_pbr_scene`: PBR materials and image based lighting |
+| `scenes.transparency` | `build_transparency_scene`: depth peeling stress test |
+| `scenes.galaxy` | `build_galaxy_scene`: tens of millions of points |
+| `scenes.wave` | `WaveSurface`, `build_wave_scene`: a mesh updated live by a simulation |
+| `scenes.isosurface` | `Isosurface`, `build_isosurface_scene`: live `vtkFlyingEdges3D` contour |
+| `scenes.bunny` | `build_bunny_scene` |
+| `scenes.benchmark` | `build_sphere_mesh`, `build_sphere_actors`: synthetic throughput scenes |
+| `scenes.primitives` | Shapes (`cube`, `cylinder`, `cone`, `arrow`, `icosphere`, `super_ellipsoid`, `trefoil`) and textures (`stone_tiles_texture`, `image_texture`) |
+| `scenes.core` | VTK and numpy helpers: `mesh_actor`, `make_property`, `rgb`, `lookup_table`, `vtk_points`, `transformed`, `set_camera`… |
+| `scenes.datasets` | `bunny`, `lucy`, `head`, `sky_box`: example data, downloaded once to `~/.cache/vtk-demo` (or `$VTK_DEMO_DATA`) |
+
+## Demo applications
+
+```bash
+vtk-demo list
+vtk-demo run trame.glyph            # VTK.wasm on WebGL 2
+vtk-demo run trame.glyph --webgpu   # WebGPU in the browser and on the server
+vtk-demo run trame.galaxy --help
+```
+
+Demos are grouped by UI toolkit, under `vtk_demo.apps`:
+
+- **trame**: `contour`, `galaxy`, `animation`, `pbr`,
+  `pbr-legacy`, `transparency`, `glyph`
+- **export**: `bunny-html`, a self-contained VTK.wasm HTML page
+- **imgui**: `contour`, the trame contour demo as a native desktop window
+
+Every demo is also a runnable module, e.g. `python -m vtk_demo.apps.trame.glyph`.
+
+The SimpleViewer based trame demos report first frame and interaction times:
+see `vtk_demo/apps/trame/observability.py` (`--obs-log`, `--obs-verbose`, `--no-hud`).
+
+### Gallery
+
+Each demo with its default options, VTK.wasm (or vtk.js) on WebGL 2 in Chrome:
+
+| | |
+| --- | --- |
+| `trame.contour`: isosurface of a CT scan, filtered on the server | `trame.galaxy`: millions of points with VTK.wasm 64-bit |
+| ![trame.contour](docs/screenshots/trame-contour.jpg) | ![trame.galaxy](docs/screenshots/trame-galaxy.jpg) |
+| `trame.animation`: wave equation stepped in numpy, streamed live | `trame.glyph`: 43k object voxel island, GPU instancing |
+| ![trame.animation](docs/screenshots/trame-animation.jpg) | ![trame.glyph](docs/screenshots/trame-glyph.jpg) |
+| `trame.pbr`: PBR materials and image based lighting | `trame.pbr-legacy`: the same scene with vtk.js |
+| ![trame.pbr](docs/screenshots/trame-pbr.jpg) | ![trame.pbr-legacy](docs/screenshots/trame-pbr-legacy.jpg) |
+| `trame.transparency`: depth peeling stress test | `export.bunny-html`: self-contained HTML page, no server |
+| ![trame.transparency](docs/screenshots/trame-transparency.jpg) | ![export.bunny-html](docs/screenshots/export-bunny-html.jpg) |
+
+### Notes
+
+- `--webgpu` also asks the server to render with WebGPU, which needs a VTK
+  built with `VTK_ENABLE_WEBGPU=ON`; otherwise the server falls back to OpenGL,
+  as shown in the chip when rendering remotely.
+- VTK's WebGPU backend has no PBR shaders yet: `pbr --webgpu` is Phong shaded.
+- The uv setup (`uv sync`, nox, CI) pins a VTK nightly from
+  [wheels.vtk.org](https://wheels.vtk.org) (`[tool.uv]` in `pyproject.toml`):
+  with VTK 9.7.1, VTK.wasm keeps drawing the first frame of `trame.animation`.
+  `pip install vtk-demo` uses the latest VTK release instead; to get a nightly
+  with pip: `pip install --pre --extra-index-url https://wheels.vtk.org "vtk>9.7.1"`.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the development setup, how to add a
+demo and how releases are made.
+
+## License
+
+[Apache License 2.0](LICENSE)

vtk_demo-0.1.0/README.md

@@ -0,0 +1,127 @@
+# vtk-demo
+
+Fancy VTK / PyVista scenes that show off VTK capabilities and performance:
+GPU instancing, composite datasets, PBR, transparency, huge point clouds, live
+simulations… plus the demo applications built on them (VTK.wasm + WebGPU in
+the browser with trame, standalone HTML exports, and Dear ImGui).
+
+## Install
+
+```bash
+pip install vtk-demo              # scenes only (vtk, pyvista)
+pip install "vtk-demo[trame]"     # + web applications
+pip install "vtk-demo[export]"    # + standalone HTML export
+pip install "vtk-demo[all]"
+```
+
+## Reusable scenes
+
+`vtk_demo.scenes` is plain VTK and numpy, through VTK's Python friendly API
+(keyword constructors, snake_case properties, numpy backed arrays, `>>`
+pipelines). Every `build_*` function fills a `vtkRenderer` (actors,
+background, camera) and returns a few statistics:
+
+```python
+import vtkmodules.vtkInteractionStyle  # noqa: F401
+import vtkmodules.vtkRenderingOpenGL2  # noqa: F401
+from vtkmodules.vtkRenderingCore import (
+    vtkRenderer,
+    vtkRenderWindow,
+    vtkRenderWindowInteractor,
+)
+
+from vtk_demo.scenes import build_glyph_island
+
+renderer = vtkRenderer()
+n_actors, n_instances, n_triangles = build_glyph_island(renderer)
+window = vtkRenderWindow(size=(1280, 800))
+window.AddRenderer(renderer)
+interactor = vtkRenderWindowInteractor(render_window=window)
+interactor.Start()
+```
+
+PyVista only comes in with the applications, through a small adapter that
+builds a scene into a plotter and keeps the scene's camera:
+
+```python
+import pyvista as pv
+from vtk_demo.pyvista_adapter import add_scene
+from vtk_demo.scenes import build_glyph_island
+
+plotter = pv.Plotter()
+n_actors, n_instances, n_triangles = add_scene(plotter, build_glyph_island)
+plotter.show()
+```
+
+| Module | What it provides |
+| --- | --- |
+| `scenes.instancing` | `InstanceLayer`: many copies of one mesh, drawn with a `vtkGlyph3DMapper` (`glyph_actor`), one actor per copy (`instance_actors`) or baked into one mesh (`bake_layer`) |
+| `scenes.composite` | `composite_actor`, `scattered_collection`, `partitioned_collection`: many meshes in one `vtkCompositePolyDataMapper` actor |
+| `scenes.island` | The 43k object voxel island, drawn four ways: `build_glyph_island`, `build_actor_island`, `build_archipelago`, `build_partitioned_island` |
+| `scenes.pbr` | `build_pbr_scene`: PBR materials and image based lighting |
+| `scenes.transparency` | `build_transparency_scene`: depth peeling stress test |
+| `scenes.galaxy` | `build_galaxy_scene`: tens of millions of points |
+| `scenes.wave` | `WaveSurface`, `build_wave_scene`: a mesh updated live by a simulation |
+| `scenes.isosurface` | `Isosurface`, `build_isosurface_scene`: live `vtkFlyingEdges3D` contour |
+| `scenes.bunny` | `build_bunny_scene` |
+| `scenes.benchmark` | `build_sphere_mesh`, `build_sphere_actors`: synthetic throughput scenes |
+| `scenes.primitives` | Shapes (`cube`, `cylinder`, `cone`, `arrow`, `icosphere`, `super_ellipsoid`, `trefoil`) and textures (`stone_tiles_texture`, `image_texture`) |
+| `scenes.core` | VTK and numpy helpers: `mesh_actor`, `make_property`, `rgb`, `lookup_table`, `vtk_points`, `transformed`, `set_camera`… |
+| `scenes.datasets` | `bunny`, `lucy`, `head`, `sky_box`: example data, downloaded once to `~/.cache/vtk-demo` (or `$VTK_DEMO_DATA`) |
+
+## Demo applications
+
+```bash
+vtk-demo list
+vtk-demo run trame.glyph            # VTK.wasm on WebGL 2
+vtk-demo run trame.glyph --webgpu   # WebGPU in the browser and on the server
+vtk-demo run trame.galaxy --help
+```
+
+Demos are grouped by UI toolkit, under `vtk_demo.apps`:
+
+- **trame**: `contour`, `galaxy`, `animation`, `pbr`,
+  `pbr-legacy`, `transparency`, `glyph`
+- **export**: `bunny-html`, a self-contained VTK.wasm HTML page
+- **imgui**: `contour`, the trame contour demo as a native desktop window
+
+Every demo is also a runnable module, e.g. `python -m vtk_demo.apps.trame.glyph`.
+
+The SimpleViewer based trame demos report first frame and interaction times:
+see `vtk_demo/apps/trame/observability.py` (`--obs-log`, `--obs-verbose`, `--no-hud`).
+
+### Gallery
+
+Each demo with its default options, VTK.wasm (or vtk.js) on WebGL 2 in Chrome:
+
+| | |
+| --- | --- |
+| `trame.contour`: isosurface of a CT scan, filtered on the server | `trame.galaxy`: millions of points with VTK.wasm 64-bit |
+| ![trame.contour](docs/screenshots/trame-contour.jpg) | ![trame.galaxy](docs/screenshots/trame-galaxy.jpg) |
+| `trame.animation`: wave equation stepped in numpy, streamed live | `trame.glyph`: 43k object voxel island, GPU instancing |
+| ![trame.animation](docs/screenshots/trame-animation.jpg) | ![trame.glyph](docs/screenshots/trame-glyph.jpg) |
+| `trame.pbr`: PBR materials and image based lighting | `trame.pbr-legacy`: the same scene with vtk.js |
+| ![trame.pbr](docs/screenshots/trame-pbr.jpg) | ![trame.pbr-legacy](docs/screenshots/trame-pbr-legacy.jpg) |
+| `trame.transparency`: depth peeling stress test | `export.bunny-html`: self-contained HTML page, no server |
+| ![trame.transparency](docs/screenshots/trame-transparency.jpg) | ![export.bunny-html](docs/screenshots/export-bunny-html.jpg) |
+
+### Notes
+
+- `--webgpu` also asks the server to render with WebGPU, which needs a VTK
+  built with `VTK_ENABLE_WEBGPU=ON`; otherwise the server falls back to OpenGL,
+  as shown in the chip when rendering remotely.
+- VTK's WebGPU backend has no PBR shaders yet: `pbr --webgpu` is Phong shaded.
+- The uv setup (`uv sync`, nox, CI) pins a VTK nightly from
+  [wheels.vtk.org](https://wheels.vtk.org) (`[tool.uv]` in `pyproject.toml`):
+  with VTK 9.7.1, VTK.wasm keeps drawing the first frame of `trame.animation`.
+  `pip install vtk-demo` uses the latest VTK release instead; to get a nightly
+  with pip: `pip install --pre --extra-index-url https://wheels.vtk.org "vtk>9.7.1"`.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the development setup, how to add a
+demo and how releases are made.
+
+## License
+
+[Apache License 2.0](LICENSE)