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.6.0

Project description

CI Documentation Status PyPI version

wgpu-py

Next generation GPU API for Python

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

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

  • Coverage of the WebGPU spec is nearly complete.
  • Test coverage of the API is 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

The wheels include the prebuilt binaries. If you want to use a custom build instead, you can set the environment variable WGPU_LIB_PATH. You probably also want to install glwf (for desktop) and/or jupyter_rfb (for Jupyter).

Platform requirements

Under the hood, wgpu runs on Vulkan, Metal, or DX12. The wgpu-backend is selected automatically, but can be overridden by setting the WGPU_BACKEND_TYPE environment variable to "Vulkan", "Metal", "D3D12", "D3D11", or "OpenGL".

On Windows 10+, things should just work. On older Windows versions you may need to install the Vulkan drivers. You may want to force "Vulkan" while "D3D12" is less mature.

On Linux, it's advisable to install the proprietary drivers of your GPU (if you have a dedicated GPU). You may need to apt install mesa-vulkan-drivers. Wayland currently only works with the GLFW canvas (and is unstable).

On MacOS you need at least 10.13 (High Sierra) to have Vulkan support.

Usage

Also see the online documentation.

The full API is accessable via the main namespace:

import wgpu

But to use it, you need to select a backend first. You do this by importing it. There is currently only one backend:

import wgpu.backend.rs

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.

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.

Changing the upstream wgpu-native version

  • Use the optional arguments to python download-wgpu-native.py --help to download a different version of the upstream wgpu-native binaries.
  • The file wgpu/resources/wgpu_native-version will be updated by the script to track which version we depend upon.

Example screenshot verification

Include the comment # test_example = true in an example to have pytest run it as part of the test suite.

To support testing an example, 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.

By default the test will simply verify that the example can be executed without an error, and that an image can be rendered using the canvas.

If a screenshot for the example is available in the examples/screenshots folder, the test will additionally verify that the rendered image matches the screenshot.

You can (re)generate the reference screenshot like so: pytest -k test_examples --regenerate-screenshots

If CI fails on screenshot verification, the build will regenerate screenshots and make them available as build artifacts so you can download and inspect the differences, and debug locally.

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.6.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

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

This version

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.7.4.tar.gz (88.9 kB view details)

Uploaded Source

Built Distributions

wgpu-0.7.4-py3-none-win_amd64.whl (5.1 MB view details)

Uploaded Python 3 Windows x86-64

wgpu-0.7.4-py3-none-win32.whl (4.7 MB view details)

Uploaded Python 3 Windows x86

wgpu-0.7.4-py3-none-manylinux_2_24_x86_64.whl (27.5 MB view details)

Uploaded Python 3 manylinux: glibc 2.24+ x86-64

wgpu-0.7.4-py3-none-manylinux_2_24_i686.whl (27.8 MB view details)

Uploaded Python 3 manylinux: glibc 2.24+ i686

wgpu-0.7.4-py3-none-macosx_11_0_arm64.whl (5.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

wgpu-0.7.4-py3-none-macosx_10_9_x86_64.whl (5.1 MB view details)

Uploaded Python 3 macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: wgpu-0.7.4.tar.gz
  • Upload date:
  • Size: 88.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4.tar.gz
Algorithm Hash digest
SHA256 b17bc431b4027f0e0e87605a735ea5d9d2659fb13892afb024c7f698facb72ce
MD5 37792e8f9da1c42431122e0383d05d10
BLAKE2b-256 3e6dcb9ea2daa4d4926bc22812961a1f0785b8d276253d51821f121547ca772d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgpu-0.7.4-py3-none-win_amd64.whl
  • Upload date:
  • Size: 5.1 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 3fce6b6ab598f1c360c8fd06b7f707bbc90c85950aadbc7de0593a0b47ce05e0
MD5 8cc7f8a4f95ebcee1601956552eca1c7
BLAKE2b-256 91d11f8a2b866c4db663da1109c5e73ad027054057b51c2ed1fd3e5197a25109

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgpu-0.7.4-py3-none-win32.whl
  • Upload date:
  • Size: 4.7 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 ef2695ff959495f0bbae160a8e26692ebb4e3060b2e88c49428f9fa3bf4dc82d
MD5 0c3930cc592c71cee9bc1f255b15afaf
BLAKE2b-256 5ccb47e072ed72e641af5e4abe9139c62f01d06b5d760b39417022b4771d0cd3

See more details on using hashes here.

File details

Details for the file wgpu-0.7.4-py3-none-manylinux_2_24_x86_64.whl.

File metadata

  • Download URL: wgpu-0.7.4-py3-none-manylinux_2_24_x86_64.whl
  • Upload date:
  • Size: 27.5 MB
  • Tags: Python 3, manylinux: glibc 2.24+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4-py3-none-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 fee87ae4e0d607cec6582406a7a485224af10d1a4810d22a6af017a9092e2413
MD5 e9edd45b311192c5800e70d289975161
BLAKE2b-256 e4ed21c6e46fe4c27ea5a4af8efdfd988ee00ca3d73563f830a884960d331b0c

See more details on using hashes here.

File details

Details for the file wgpu-0.7.4-py3-none-manylinux_2_24_i686.whl.

File metadata

  • Download URL: wgpu-0.7.4-py3-none-manylinux_2_24_i686.whl
  • Upload date:
  • Size: 27.8 MB
  • Tags: Python 3, manylinux: glibc 2.24+ i686
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4-py3-none-manylinux_2_24_i686.whl
Algorithm Hash digest
SHA256 39b7f40ae69a82deb1a6427fdc74d3fc3dbf9fc39c2984f71c97f234ff65a19c
MD5 60749cc85822cdb1ca33afaca1ad6066
BLAKE2b-256 ec774c0eb64be6b701f119fa994030ef6021c6729c3523b68732306482a3204d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgpu-0.7.4-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 5.0 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2253b3b556d76078d35c94737b99d50deedc73342fa095b9657e8b9f5a45f75b
MD5 28016f9da86deac4ab1e07c94e307673
BLAKE2b-256 c0cbff63147174b7a5f9b00ddab8fa0187e9862f989af7ca4a0cba31c13a796f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgpu-0.7.4-py3-none-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 5.1 MB
  • Tags: Python 3, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for wgpu-0.7.4-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 be10689be462ae34bc518a2a129517c1f6a39371401d946f7e3f50c7cdf5e757
MD5 811db941ee9ef0f29013411a99e21688
BLAKE2b-256 b99e7497a981cd835988d85daca4fe01068400ed234e6e704cee278486dccf89

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