Skip to main content

Streamlit component that allows you to show PyVista 3d visualizations

Project description

🧊 stpyvista

Streamlit component to show PyVista 3D visualizations

Installation instructions

pip install stpyvista

Usage instructions

Streamlit Cloud

import streamlit as st
import pyvista as pv
from stpyvista import stpyvista

# pythreejs does not support scalar bars :(
pv.global_theme.show_scalar_bar = False 

## Initialize a plotter object
plotter = pv.Plotter(window_size=[400,400])

## Create a mesh with a cube 
mesh = pv.Cube(center=(0,0,0))

## Add some scalar field associated to the mesh
mesh['myscalar'] = mesh.points[:, 2]*mesh.points[:, 0]

## Add mesh to the plotter
plotter.add_mesh(mesh, scalars='myscalar', cmap='bwr', line_width=1)
plotter.add_scalar_bar()

## Final touches
plotter.view_isometric()
plotter.background_color = 'white'

## Pass a key to avoid re-rendering at each time something changes in the page
stpyvista(plotter, key="pv_cube")

Log changes

v 0.0.8 - Remove excessive whitespace below the rendered component. - Can pass additional kwargs to panel.pane.vtk, e.g. setting an orientation_widget. Check panel-vtk for details on valid kwargs.
v 0.0.6 - Replaced pythreejs backend for panel backend. This is a temporary solution as pyvista will remove panel support in favor of trame.
v 0.0.5 - Support transparent backgrounds to blend with streamlit's web app theme. - Add a control to spin along a certain axis the first mesh passed to the plotter.
v 0.0.4 - Pass a key to the stpyvista component to avoid re-rendering at every streamlit interaction - Using ipywidgets `embed_minimal_html` directly instead of pyvista `export_html`. - Update examples as a multipage streamlit app

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stpyvista-0.0.8.tar.gz (19.4 kB view hashes)

Uploaded Source

Built Distribution

stpyvista-0.0.8-py3-none-any.whl (19.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page