Next generation GPU API for Python

Project description

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 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, PyQt5, PySide or PyQt4 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.

Project details

Release history Release notifications | RSS feed

0.19.0

Nov 4, 2024

0.18.1

Sep 17, 2024

0.18.0

Sep 16, 2024

0.17.3

Sep 11, 2024

0.16.0

Jun 13, 2024

0.15.3

Jun 12, 2024

0.15.2

May 13, 2024

0.15.1

Mar 30, 2024

0.15.0

Mar 7, 2024

0.14.1

Feb 15, 2024

0.14.0

Feb 13, 2024

0.13.2

Dec 21, 2023

0.13.1

Dec 8, 2023

0.13.0

Nov 24, 2023

0.12.0

Nov 15, 2023

0.11.0

Oct 11, 2023

0.10.0

Oct 9, 2023

0.9.5

Oct 2, 2023

0.9.4

Feb 23, 2023

0.9.3

Feb 20, 2023

0.9.2

Feb 17, 2023

0.9.1

Feb 14, 2023

0.9.0

Jan 25, 2023

0.8.4

Jan 10, 2023

0.8.3

Jan 6, 2023

0.8.2

Oct 6, 2022

0.8.1

Apr 29, 2022

0.8.0

Apr 20, 2022

0.7.7

Apr 12, 2022

0.7.6

Mar 28, 2022

0.7.5

Mar 17, 2022

0.7.4

Feb 4, 2022

0.7.3

Jan 25, 2022

0.7.2

Dec 24, 2021

0.7.1

Dec 22, 2021

This version

0.7.0

Dec 21, 2021

0.6.0

Dec 16, 2021

0.5.9

Oct 11, 2021

0.5.8

Oct 9, 2021

0.5.7

Oct 7, 2021

0.5.6

Aug 29, 2021

0.5.5

Aug 9, 2021

0.5.4

Jun 11, 2021

0.5.3

Jun 4, 2021

0.5.2

May 23, 2021

0.5.1

May 23, 2021

0.4.0

May 21, 2021

0.3.0

Jul 5, 2020

0.2.0

Apr 16, 2020

0.1.6

Apr 1, 2020

0.1.5

Feb 12, 2020

0.1.4

Feb 7, 2020

0.1.3

Jan 29, 2020

0.1.2

Jan 15, 2020

0.1.1

Jan 14, 2020

0.0.1

Dec 23, 2019

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

Uploaded Dec 21, 2021 Source

Built Distributions

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

Uploaded Dec 21, 2021 Python 3 Windows x86-64

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

Uploaded Dec 21, 2021 Python 3 Windows x86

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

Uploaded Dec 21, 2021 Python 3 manylinux: glibc 2.24+ x86-64

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

Uploaded Dec 21, 2021 Python 3 manylinux: glibc 2.24+ i686

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

Uploaded Dec 21, 2021 Python 3 macOS 11.0+ ARM64

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

Uploaded Dec 21, 2021 Python 3 macOS 10.9+ x86-64

File details

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

File metadata

Download URL: wgpu-0.7.0.tar.gz
Upload date: Dec 21, 2021
Size: 86.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0.tar.gz
Algorithm	Hash digest
SHA256	`d66f70b2240c9ed6d64b6ea22be42b7c572bbaff77d372b743167573c73e435f`
MD5	`d669e31d5d02f1adb8d68c7d84a75e8f`
BLAKE2b-256	`04610b7dc71bc4736cb9a0b95e4fb2686880765e4c4195586ee46fc2fbe8cff6`

See more details on using hashes here.

File details

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

File metadata

Download URL: wgpu-0.7.0-py3-none-win_amd64.whl
Upload date: Dec 21, 2021
Size: 5.1 MB
Tags: Python 3, Windows x86-64
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0-py3-none-win_amd64.whl
Algorithm	Hash digest
SHA256	`ffd01f5577fa60e0bbdd91cbe577597684765776d4d217442d5b9e1bcb5c8fbe`
MD5	`60216022472f824a133166c3f7d2635a`
BLAKE2b-256	`efae14a1747d9be68299b6ecd97e0353ab4a7756e9818c4fc13c3299b9da7e12`

See more details on using hashes here.

File details

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

File metadata

Download URL: wgpu-0.7.0-py3-none-win32.whl
Upload date: Dec 21, 2021
Size: 4.7 MB
Tags: Python 3, Windows x86
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0-py3-none-win32.whl
Algorithm	Hash digest
SHA256	`1d82886cc4b879fbf8039ec90738cc4e5ec618c5980cf8787b2d31cc4a85732f`
MD5	`f6dbf486531d7f7644991e3c79dbab21`
BLAKE2b-256	`c8cdb3eed2b9f888749a3b4fd308b3bc61f6415663db4b4fff7f70350202af8a`

See more details on using hashes here.

File details

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

File metadata

Download URL: wgpu-0.7.0-py3-none-manylinux_2_24_x86_64.whl
Upload date: Dec 21, 2021
Size: 27.5 MB
Tags: Python 3, manylinux: glibc 2.24+ x86-64
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0-py3-none-manylinux_2_24_x86_64.whl
Algorithm	Hash digest
SHA256	`5ddd54735c930b63c29682f57bfb08f98fa7bcecdd5bbeb1c8749d0ba441db6e`
MD5	`7b192c8eb843a7d22a0328d3d9d9adf7`
BLAKE2b-256	`4c40d9feceb0b60a22319948e466e625e799d2b56672301ed66165b4d0b9cae4`

See more details on using hashes here.

File details

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

File metadata

Download URL: wgpu-0.7.0-py3-none-manylinux_2_24_i686.whl
Upload date: Dec 21, 2021
Size: 27.8 MB
Tags: Python 3, manylinux: glibc 2.24+ i686
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0-py3-none-manylinux_2_24_i686.whl
Algorithm	Hash digest
SHA256	`2196006211d4cb9e3664991a7d597c2b554c6b717f14bc81e2fd59533f17e65f`
MD5	`d58c33b688593148a7cf7c4b424a5c6a`
BLAKE2b-256	`3988139cb48d79c2e88313925fdf7c7e1ddb399301a490f42583ab597e143674`

See more details on using hashes here.

File details

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

File metadata

Download URL: wgpu-0.7.0-py3-none-macosx_11_0_arm64.whl
Upload date: Dec 21, 2021
Size: 5.0 MB
Tags: Python 3, macOS 11.0+ ARM64
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0-py3-none-macosx_11_0_arm64.whl
Algorithm	Hash digest
SHA256	`bd2c291c8ec1f3443c2900f434a7d7b4076c3b05c7afe6e7b1e141aeacca910f`
MD5	`1acff9087840120940bfd5a53fa5b0a3`
BLAKE2b-256	`6820c1d6194fbbbe6d2717a0ec23555c732c997f85ef8f33b49d1291f09f8b5f`

See more details on using hashes here.

File details

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

File metadata

Download URL: wgpu-0.7.0-py3-none-macosx_10_9_x86_64.whl
Upload date: Dec 21, 2021
Size: 5.1 MB
Tags: Python 3, macOS 10.9+ x86-64
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for wgpu-0.7.0-py3-none-macosx_10_9_x86_64.whl
Algorithm	Hash digest
SHA256	`fcd959738d2e5bedb747d7ee7cc2ce63888c3d48480348031e72698de5f5e07d`
MD5	`58002eedba8cd48a147f1d3df7f6286b`
BLAKE2b-256	`9e976e7317ac8ed3b6c0dec8075418236a203998fa85ab910337419843172b6e`