pyvista-js 0.2.1

PyVista-like API for vtk.js

pyvista-js

PyVista-like API for vtk.js - Bring intuitive 3D visualization to the browser.

Vision

Provide a familiar PyVista interface that works seamlessly in browser environments (Pyodide, stlite, JupyterLite) by leveraging vtk.js under the hood.

Quick Example (Goal)

import pyvista_js as pv
import streamlit as st

# Create a plotter
plotter = pv.Plotter()

# Add a mesh
mesh = pv.Sphere()
plotter.add_mesh(mesh, color="red", opacity=0.8)

# Display in browser
plotter.show()

Features (Planned)

• 🎨 PyVista-like API - Familiar interface for PyVista users
• 🌐 Browser-native - Runs entirely in the browser via Pyodide
• ⚡ vtk.js powered - Leverages the power of vtk.js for rendering
• 📊 Streamlit/stlite support - Easy integration with web frameworks
• 🔧 Lightweight - No server required, pure client-side

Installation

pip install pyvista-js

For Pyodide/stlite:

import micropip

await micropip.install("pyvista-js")

Usage

Basic Example

import pyvista_js as pv

# Create a plotter
plotter = pv.Plotter()

# Add a mesh
mesh = pv.Sphere(radius=1.0)
plotter.add_mesh(mesh, color="red", opacity=0.8)

# Display (in Pyodide/browser environment)
plotter.show()

Streamlit/stlite Example

import streamlit as st
import pyvista_js as pv

st.title("3D Visualization")

# Create visualization
plotter = pv.Plotter()
sphere = pv.Sphere()
plotter.add_mesh(sphere, color="blue")

# Display in Streamlit
pv.pyvista_chart(plotter, height=600)

API Design

Core Classes

# Plotter - Main visualization interface
plotter = pv.Plotter()
plotter.add_mesh(mesh, **kwargs)
plotter.show()

# Geometric objects
sphere = pv.Sphere(radius=1.0, center=(0, 0, 0))
cube = pv.Cube()
cylinder = pv.Cylinder()

# Mesh operations
mesh.points  # NumPy array of vertices
mesh.faces  # Cell connectivity

Comparison with PyVista

Feature	PyVista	pyvista-js
Backend	VTK (C++)	vtk.js (WebGL)
Environment	Desktop	Browser
Installation	pip install pyvista	pip install pyvista-js
Rendering	Native OpenGL	WebGL
Server Required	Optional	No

Status

🚀 Beta - Core functionality implemented!

• Core Plotter API
• Basic geometric primitives (Sphere, Cube, Cylinder)
• Mesh rendering with vtk.js
• PyVista compatibility layer
• Streamlit/stlite integration
• Advanced mesh operations
• Comprehensive documentation
• More examples

Contributing

Contributions are welcome! This project aims to:

1. Provide PyVista-like API for browser environments
2. Leverage vtk.js for efficient WebGL rendering
3. Enable 3D visualization in Pyodide/stlite applications

Related Projects

• PyVista - 3D plotting and mesh analysis
• vtk.js - VTK for the Web
• stlite - Serverless Streamlit

License

BSD 3-Clause License - See LICENSE for details.

This project uses vtk.js which is also licensed under BSD 3-Clause License.

Acknowledgments

• Built on top of vtk.js
• Inspired by PyVista
• Designed for Pyodide environments

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tetsuo Koyama 🤔 📖 💻 👀 🐛

All Contributors 📖

pre-commit 🚧

Claude 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!