WebGPU API for Python for local and Pyodide development
This library provides a Python wrapper around the WebGPU API that runs in the browser via Pyodide or connects to a local Python instance. It is intended for interactive visualization and compute in environments such as Jupyter notebooks and plain HTML pages.
The package bundles a small rendering framework (scenes, cameras, labels, colormaps) and utilities to work with WGSL shaders from Python. It is used in higher level frameworks like ngsolve_webgpu for GPU-accelerated finite element visualizations in the browser.
Features
- Browser-based GPU access via WebGPU from local Python and Pyodide.
- Python-first API for creating renderers, scenes and simple GUI controls.
- Jupyter integration through a
webgpu.jupyterhelper module. - WGSL tooling:
- simple
#importmechanism for shader code - conditional compilation using
#ifdef/#else/#endif
- simple
- Ready-to-use building blocks:
Renderer,Scene,Camera,Labels,Colormap,Clipping,Font- utilities for GPU buffers and bindings
Requirements
- Python 3.8 or newer
- A browser with WebGPU support (for example a recent Chrome or Edge)
- For notebook use: JupyterLab or Jupyter Notebook
To check WebGPU support in your browser, you can use common WebGPU capability pages (for example WebGPU report pages linked from the project website).
Installation
From PyPI
pip install webgpu
From source
git clone https://github.com/CERBSim/webgpu
cd webgpu
pip install -e .
Documentation
The full project documentation, including API reference, tutorials and user guide, is published at:
Examples
The repository contains several examples:
- examples/first_shader.ipynb – minimal example drawing a triangle with custom WGSL shader code.
- examples/websocket.ipynb – example using the websocket link.
- docs/introduction.ipynb – overview and introductory material.
Additional, more advanced examples in docs/*.ipynb (compute, instanced shapes, selection).
Browser support
This library relies on the browser’s WebGPU implementation. In practice this means:
- A recent Chromium-based browser (Chrome, Edge) or Firefox is recommended.
- Some platforms may require enabling experimental WebGPU flags.
- Mobile and non-Chromium browsers may have partial or no support.
If WebGPU is not available, initialization will fail. See project documentation and browser-specific WebGPU status pages for details and troubleshooting.
License
This project is licensed under the terms of the LGPL-2.1-or-later. See the LICENSE file for details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file webgpu-1.5.4-py3-none-any.whl.
File metadata
- Download URL: webgpu-1.5.4-py3-none-any.whl
- Upload date:
- Size: 299.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b684076565558fa3c07ddb66e2a4ee6306352c4cb6a132d4e15350214259d619
|
|
| MD5 |
a37e34cb693df9f21a2f04957e46ad4a
|
|
| BLAKE2b-256 |
51ea0398b7cad8ce3cf519414205559b8578c63aeefa480a80b8fe8db6f2bf0a
|
Provenance
The following attestation bundles were made for webgpu-1.5.4-py3-none-any.whl:
Publisher:
deploy.yml on CERBSim/webgpu
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
webgpu-1.5.4-py3-none-any.whl -
Subject digest:
b684076565558fa3c07ddb66e2a4ee6306352c4cb6a132d4e15350214259d619 - Sigstore transparency entry: 2334892148
- Sigstore integration time:
-
Permalink:
CERBSim/webgpu@37210eae72adb24d5fc7e133a72372699e5cc68b -
Branch / Tag:
refs/tags/v1.5.4 - Owner: https://github.com/CERBSim
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy.yml@37210eae72adb24d5fc7e133a72372699e5cc68b -
Trigger Event:
push
-
Statement type:
