https://github.com/edsaac/stpyvista
🧊 Show 3D visualizations from PyVista in Streamlit
https://github.com/edsaac/stpyvista
python pyvista streamlit visualization
Last synced: about 1 year ago
JSON representation
🧊 Show 3D visualizations from PyVista in Streamlit
- Host: GitHub
- URL: https://github.com/edsaac/stpyvista
- Owner: edsaac
- License: gpl-3.0
- Created: 2022-09-01T18:33:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T14:15:53.000Z (over 1 year ago)
- Last Synced: 2025-04-03T07:39:17.530Z (about 1 year ago)
- Topics: python, pyvista, streamlit, visualization
- Language: HTML
- Homepage: https://stpyvista.streamlit.app
- Size: 5.17 MB
- Stars: 90
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🧊 stpyvista
Show PyVista visualizations in Streamlit.
Take a PyVista plotter object and show it on Streamlit as an interactive-ish component (as in it can be zoomed in/out, moved and rotated, but the visualization state is not returned). It can use either [Panel](https://panel.holoviz.org/reference/panes/VTK.html#working-with-pyvista) or [Trame](https://docs.pyvista.org/user-guide/jupyter/trame#trame-jupyter) to export the PyVista plotter to HTML; `stpyvista` places it within an iframe in Streamlit.
******
### 📦 Installation
```sh
pip install stpyvista
```
******
### 📚 Demo and documentation
******
### ✨ Minimal example
Render a cube
```python
import streamlit as st
import pyvista as pv
from stpyvista import stpyvista
## Initialize a plotter object
plotter = pv.Plotter(window_size=[400,400])
## Create a mesh with a cube
mesh = pv.Cube()
## Add some scalar field associated to the mesh
mesh['my_scalar'] = mesh.points[:, 2] * mesh.points[:, 0]
## Add mesh to the plotter
plotter.add_mesh(mesh, scalars='my_scalar', cmap='bwr')
## Final touches
plotter.view_isometric()
plotter.add_scalar_bar()
plotter.background_color = 'white'
## Pass a key to avoid re-rendering at each page change
stpyvista(plotter, key="pv_cube")
```
****
### 🎈 Deploying to Streamlit Community Cloud
- By default, Community Cloud will run Python 3.12 🎈. Check this on New App → Advanced settings... → Python version.
- Add `stpyvista` to the `requirements.txt` file.
- Install `procps`, `libgl1-mesa-glx` and `xvfb` by adding them to the `packages.txt` file.
- The Community Cloud is a Debian headless machine and Pyvista requires a virtual framebuffer to work. `stpyvista.utils.start_xvfb` checks if Xvfb is running and [starts it](https://docs.pyvista.org/version/stable/api/utilities/_autosummary/pyvista.start_xvfb) if it was not.
```python
from stpyvista.utils import start_xvfb
if "IS_XVFB_RUNNING" not in st.session_state:
start_xvfb()
st.session_state.IS_XVFB_RUNNING = True
```
****
### 🚩 Known issues
- [x] [**`cadquery`**](https://github.com/edsaac/stpyvista/issues/25) conflicts: `cadquery` bundles an outdated version of `vtk`, which ends up conflicting with the `vtk` version that `pyvista` requires. Current solution is to install `stpyvista` **before** cadquery in a virtual environment. For fixing instructions, check [this post on discuss](https://discuss.streamlit.io/t/solved-importerror-vtk-version-conflict-with-cadquery-stpyvista-on-streamlit-cloud/91840).
- [ ] [`NSInternalInconsistencyException`](https://github.com/edsaac/stpyvista/issues/14) thrown when running on macOS. Current solution is to deploy using a VM.
#### 🍹 Solved issues
- [x] [`RuntimeError`](https://github.com/edsaac/stpyvista/issues/17) thrown when running Python 3.9. Upgrading to `panel>=1.4.0` or using Python 3.10 fixes this.
- [x] [Buggy colormaps](https://github.com/edsaac/stpyvista/issues/19) when using `panel==1.4.0`. This [issue](https://github.com/holoviz/panel/issues/6627) was fixed with `panel==1.4.1`.
- [x] [`cmocean==4.0.1`](https://github.com/matplotlib/cmocean/releases/tag/v4.0.1) will raise an exception while trying to register its colormaps to matplotlib, making PyVista to crash. This [issue](https://github.com/matplotlib/cmocean/issues/107) was fixed in `cmocean==4.0.3`.
****
### 🍏 Also check
* The PyVista project at [https://www.pyvista.org/](https://www.pyvista.org/)
* Working with Panel and Pyvista [https://panel.holoviz.org](https://panel.holoviz.org/reference/panes/VTK.html#working-with-pyvista)
* @blackary['s blog post](https://blog.streamlit.io/how-to-build-your-own-streamlit-component/) on how to build a custom component
* Other stuff from me on [https://edsaac.me](https://edsaac.me)