Next generation GPU API for Python

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Almar from gravatar.com Almar Avatar for berendkleinhaneveld from gravatar.com berendkleinhaneveld Avatar for Korijn from gravatar.com Korijn

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD 2-Clause
  • Author: Almar Klein
  • Requires: Python >=3.8.0

Project description

CI Documentation Status PyPI version

wgpu-py

A Python implementation of WebGPU - the next generation GPU API.

Introduction

In short, this is a Python lib wrapping wgpu-native and exposing it with a Pythonic API similar to the WebGPU spec.

The OpenGL API is old and showing it's cracks. New API's like Vulkan, Metal and DX12 provide a modern way to control the GPU, but these API's are too low-level for general use. The WebGPU API follows the same concepts, but with a simpler (higher level) spelling. The Python wgpu library brings the WebGPU API to Python.

To get an idea of what this API looks like have a look at triangle.py and the other examples.

Status

Note

The wgpu-API has not settled yet, use with care!

  • Coverage of the WebGPU spec is complete enough to build e.g. pygfx.
  • Test coverage of the API is close to 100%.
  • Support for Windows, Linux, and MacOS (Intel and M1).
  • Until WebGPU settles as a standard, its specification may change, and with that our API will probably too. Check the changelog when you upgrade!

Installation

pip install wgpu glfw

Linux users should make sure that pip >= 20.3. That should do the trick on most systems. See getting started for details.

Usage

Also see the online documentation and the examples.

The full API is accessable via the main namespace:

import wgpu

To render to the screen you can use a variety of GUI toolkits:

# The auto backend selects either the glfw, qt or jupyter backend
from wgpu.gui.auto import WgpuCanvas, run, call_later

# Visualizations can be embedded as a widget in a Qt application.
# Import PySide6, PyQt6, PySide2 or PyQt5 before running the line below.
# The code will detect and use the library that is imported.
from wgpu.gui.qt import WgpuCanvas

# Visualizations can be embedded as a widget in a wx application.
from wgpu.gui.wx import WgpuCanvas

Some functions in the original wgpu-native API are async. In the Python API, the default functions are all sync (blocking), making things easy for general use. Async versions of these functions are available, so wgpu can also work well with Asyncio or Trio.

License

This code is distributed under the 2-clause BSD license.

Projects using wgpu-py

  • pygfx - A python render engine running on wgpu.
  • shadertoy - Shadertoy implementation using wgpu-py.
  • tinygrad - deep learning framework
  • fastplotlib - A fast plotting library
  • xdsl - A Python Compiler Design Toolkit (optional wgpu interpreter)

Developers

  • Clone the repo.
  • Install devtools using pip install -r dev-requirements.txt (you can replace pip with pipenv to install to a virtualenv).
  • Install wgpu-py in editable mode by running pip install -e ., this will also install runtime dependencies as needed.
  • Run python download-wgpu-native.py to download the upstream wgpu-native binaries.
    • Or alternatively point the WGPU_LIB_PATH environment variable to a custom build.
  • Use black . to apply autoformatting.
  • Use flake8 . to check for flake errors.
  • Use pytest . to run the tests.
  • Use pip wheel --no-deps . to build a wheel.

Updating to a later version of WebGPU or wgpu-native

To update to upstream changes, we use a combination of automatic code generation and manual updating. See the codegen utility for more information.

Testing

The test suite is divided into multiple parts:

  • pytest -v tests runs the core unit tests.
  • pytest -v examples tests the examples.
  • pytest -v wgpu/__pyinstaller tests if wgpu is properly supported by pyinstaller.
  • pytest -v codegen lints the generated binding code.

There are two types of tests for examples included:

Type 1: Checking if examples can run

When running the test suite, pytest will run every example in a subprocess, to see if it can run and exit cleanly. You can opt out of this mechanism by including the comment # run_example = false in the module.

Type 2: Checking if examples output an image

You can also (independently) opt-in to output testing for examples, by including the comment # test_example = true in the module. Output testing means the test suite will attempt to import the canvas instance global from your example, and call it to see if an image is produced.

To support this type of testing, ensure the following requirements are met:

  • The WgpuCanvas class is imported from the wgpu.gui.auto module.
  • The canvas instance is exposed as a global in the module.
  • A rendering callback has been registered with canvas.request_draw(fn).

Reference screenshots are stored in the examples/screenshots folder, the test suite will compare the rendered image with the reference.

Note: this step will be skipped when not running on CI. Since images will have subtle differences depending on the system on which they are rendered, that would make the tests unreliable.

For every test that fails on screenshot verification, diffs will be generated for the rgb and alpha channels and made available in the examples/screenshots/diffs folder. On CI, the examples/screenshots folder will be published as a build artifact so you can download and inspect the differences.

If you want to update the reference screenshot for a given example, you can grab those from the build artifacts as well and commit them to your branch.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Almar from gravatar.com Almar Avatar for berendkleinhaneveld from gravatar.com berendkleinhaneveld Avatar for Korijn from gravatar.com Korijn

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD 2-Clause
  • Author: Almar Klein
  • Requires: Python >=3.8.0

Release history Release notifications | RSS feed

0.19.0

0.18.1

0.18.0

0.17.3

0.16.0

0.15.3

This version

0.15.2

0.15.1

0.15.0

0.14.1

0.14.0

0.13.2

0.13.1

0.13.0

0.12.0

0.11.0

0.10.0

0.9.5

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.7

0.7.6

0.7.5

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.0

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.4.0

0.3.0

0.2.0

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.0.1

Download files

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

Source Distribution

wgpu-0.15.2.tar.gz (155.5 kB view details)

Uploaded Source

Built Distributions

wgpu-0.15.2-py3-none-win_amd64.whl (2.7 MB view details)

Uploaded Python 3 Windows x86-64

wgpu-0.15.2-py3-none-win32.whl (2.5 MB view details)

Uploaded Python 3 Windows x86

wgpu-0.15.2-py3-none-manylinux_2_28_x86_64.whl (3.5 MB view details)

Uploaded Python 3 manylinux: glibc 2.28+ x86-64

wgpu-0.15.2-py3-none-manylinux_2_28_aarch64.whl (3.6 MB view details)

Uploaded Python 3 manylinux: glibc 2.28+ ARM64

wgpu-0.15.2-py3-none-macosx_11_0_arm64.whl (2.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

wgpu-0.15.2-py3-none-macosx_10_9_x86_64.whl (2.0 MB view details)

Uploaded Python 3 macOS 10.9+ x86-64

File details

Details for the file wgpu-0.15.2.tar.gz.

File metadata

  • Download URL: wgpu-0.15.2.tar.gz
  • Upload date:
  • Size: 155.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for wgpu-0.15.2.tar.gz
Algorithm Hash digest
SHA256 d931104fd1d4379cd8f91bdbd03f51c2046497a28aabf2ceb69f4735d4d87cd5
MD5 6ac28c3c350cf8aa0cddb63a5f3e7610
BLAKE2b-256 a58c2a4ecf2c2138da2ba8f7cca7d912f063ad29f4adaf189f608f3244b020f4

See more details on using hashes here.

File details

Details for the file wgpu-0.15.2-py3-none-win_amd64.whl.

File metadata

  • Download URL: wgpu-0.15.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for wgpu-0.15.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ba980401a3f543c0aa9ee0dad5639783ac82593a034bec638d660e6b82a10248
MD5 adfa15d9caf7410f1951c4693c0ecf38
BLAKE2b-256 2a0709fdedf04105313f29bf53ca14c08637fc59bb5e2b14b8e7052bcb7ea31f

See more details on using hashes here.

File details

Details for the file wgpu-0.15.2-py3-none-win32.whl.

File metadata

  • Download URL: wgpu-0.15.2-py3-none-win32.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for wgpu-0.15.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 a03cdfccc6a3c466eca0dbde713d8352262c9c9bbf1cec84ed5d90a5a4a92e1f
MD5 4af3bc7302c598db3cddf6e1fbda92d8
BLAKE2b-256 d4dc5079f0aaf0b8c160e583a7a36e745e92292532dabf3fd32ba593164b60b2

See more details on using hashes here.

File details

Details for the file wgpu-0.15.2-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for wgpu-0.15.2-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 96c5f07130dccfe5474d7d082edc7ac05c4d2cc20633905e77c5cf65c465ec94
MD5 be48ea907afdb957e616afa1da3962c0
BLAKE2b-256 0b202d519e83a74da2e98f3033bc042d9d0e4f13d7b2775d92e81939aa241c17

See more details on using hashes here.

File details

Details for the file wgpu-0.15.2-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for wgpu-0.15.2-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 034c56082eef59e2294ba0f7d29f555c89f7502508c307fbdc03c370d4845212
MD5 ddac236f5cc6dc680ce282c43355c2ed
BLAKE2b-256 b00ee7227d8651a37dda392a6deb0ea00491d8a9eddd7168a5ca10354993c97f

See more details on using hashes here.

File details

Details for the file wgpu-0.15.2-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for wgpu-0.15.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4c5559431a52d2d46481ca6edfbaf26a31e1b0c7104794a9ce31a7973e171a49
MD5 764f4d67fb3d1c1abcd2d030edcf9c72
BLAKE2b-256 fffbb9a45d55491c8b6aefb0b3c08f170e3af4df0024b5076ce6e4ec4ab5f279

See more details on using hashes here.

File details

Details for the file wgpu-0.15.2-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for wgpu-0.15.2-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 a9997d917ae74251e08dcf764fca247acabe3d77982739e52d46a0d08c234e27
MD5 5d93f7aea1177b6a7a48e9339cdd42a2
BLAKE2b-256 c39c9dbf857db5e252ed57afcdf194636bc7b7ac160da38dd4897211632207f1

See more details on using hashes here.

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