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

Build Status Documentation Status

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.
  • Until WebGPU settles as a standard, its specification may change, and with that our API will probably too.

Installation

pip install wgpu
pip install python-shader  # optional - our examples use this

The library ships with Rust binaries for Windows, MacOS and Linux. If you want to use a custom build instead, you can set the environment variable WGPU_LIB_PATH.

Platform requirements

Under the hood, wgpu runs on Vulkan or Metal, and eventually also DX12 or OpenGL.

On Windows 10, things should just work. On older Windows versions you may need to install the Vulkan drivers (or wait for the DX12 backend to become more 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:

# GLFW is a great lightweight windowing toolkit. Install with `pip install glfw`
from wgpu.gui.glfw import WgpuCanvas

# Visualizations can be embedded as a widget in a Qt application.
# Import 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

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.

Web support

We are considering future support for compiling (Python) visualizations to the web via PScript and Flexx. We try to keep that option open as long as it does not get in the way too much. No promises.

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 python setup.py develop, this will also install our only runtime dependency cffi
  • 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.

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

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

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

This version

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

Uploaded Source

Built Distributions

wgpu-0.2.0-py3-none-win_amd64.whl (1.4 MB view details)

Uploaded Python 3 Windows x86-64

wgpu-0.2.0-py3-none-win32.whl (1.2 MB view details)

Uploaded Python 3 Windows x86

wgpu-0.2.0-py3-none-manylinux1_x86_64.whl (1.3 MB view details)

Uploaded Python 3

wgpu-0.2.0-py3-none-manylinux1_i686.whl (1.3 MB view details)

Uploaded Python 3

wgpu-0.2.0-py3-none-macosx_10_13_x86_64.whl (1.4 MB view details)

Uploaded Python 3 macOS 10.13+ x86-64

File details

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

File metadata

  • Download URL: wgpu-0.2.0.tar.gz
  • Upload date:
  • Size: 58.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wgpu-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2c94d261dac233b0ea7ab471fa87e23e8684fe700c10ec3d997f394845746c5e
MD5 8c04c51eba745d0f4f93f0b4b34b4d26
BLAKE2b-256 ee6fec8c0a4a545f871186402d9a2c18e23b9aa441b239f3eddfc65ac5d42ecf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgpu-0.2.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wgpu-0.2.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 91aa5453bd8e8cee38f0d463892f49ec715ec1675340b0538a6dfbe74747f31b
MD5 dedc15e085b1ec07c2f3361d69981017
BLAKE2b-256 7cf35e66ba2c63250b2c651216c4b5a603b0172ef224be9701a24d55e806935b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgpu-0.2.0-py3-none-win32.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wgpu-0.2.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 a0aee559185f19883427b27d4f04115f284c076e5468f52e3ae6c6a2a669acc6
MD5 96ec4a84c4a957e81a41bff895a8341f
BLAKE2b-256 e81d8cfc2f71a826336b60b07542612d4590f6ea66e7b7dd416a383709b3f784

See more details on using hashes here.

File details

Details for the file wgpu-0.2.0-py3-none-manylinux1_x86_64.whl.

File metadata

  • Download URL: wgpu-0.2.0-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wgpu-0.2.0-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 bdb0a9a2a857ebead51402a86f0947f73bb52fe32041c3f5fb002289e730cab7
MD5 886b963790442a542b9a98980d83ca82
BLAKE2b-256 ee603db9c7179a96e9f398bd2b617d521608597195a4c375f41c6c5ec809e7c7

See more details on using hashes here.

File details

Details for the file wgpu-0.2.0-py3-none-manylinux1_i686.whl.

File metadata

  • Download URL: wgpu-0.2.0-py3-none-manylinux1_i686.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wgpu-0.2.0-py3-none-manylinux1_i686.whl
Algorithm Hash digest
SHA256 64c4b8006f7f16eea1443ed957a072e8971c5c86ab97d5a0a8dca7dcd8ab05a2
MD5 64e1cc647b493b9e2b36c02d9171bca4
BLAKE2b-256 61097c6632d61faf8935e17d38d11b5deb682756a88e9442b118414fc6297e20

See more details on using hashes here.

File details

Details for the file wgpu-0.2.0-py3-none-macosx_10_13_x86_64.whl.

File metadata

  • Download URL: wgpu-0.2.0-py3-none-macosx_10_13_x86_64.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3, macOS 10.13+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wgpu-0.2.0-py3-none-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 a52d75d23bef7b28f894e92057924f4f8fe0c1b10685a580ad72d2961b8755e3
MD5 b9383340c6ec68d92e7135f7c9baf3d8
BLAKE2b-256 938d5eec2b726d153e43c45a7c1c78fe84a255433b8f6d62576fb12035ca8972

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