A threejs-like render engine based on wgpu
Project description
Pygfx
Pygfx' purpose is to bring powerful and reliable visualization to the Python world. 🚀
Pygfx (pronounced "py-graphics") is built on wgpu, enabling superior performance and reliability compared to OpenGL-based solutions. It is designed for simplicity and versatility: with its modular architecture, you can effortlessly assemble graphical scenes for diverse applications, from scientific visualization to video game rendering.
[User Guide] [Example Gallery] [API Reference]
Professional support
Need help? We offer the following professional services:
- Priority Support: Rest assured with our dedicated support, prioritizing your needs for quick issue resolution and feature implementation.
- Integration Support: Get assistance with integrating Pygfx into your application, ensuring a smooth transition and optimal performance.
- Customized Solutions: Whether it's crafting specific visualizations or developing shaders, we work closely with you to create tailored solutions that address your unique requirements.
- Training and Workshops: We provide informative training sessions and workshops aimed at boosting skills and knowledge.
Also checkout the sponsors page. For further inquiries reach out to us at support@pygfx.org.
Installation
pip install -U pygfx glfw
To work correctly, Pygfx needs some window to render to. Glfw is one
lightweight option, but there are others, too. If you use a different
wgpu-compatible window manager or only render offscreen you may choose to omit
glfw. Examples of alternatives include: jupyter_rfb
(rendering in Jupyter),
PyQt
, PySide
, or wx
.
In addition there are some platform
requirements, see the wgpu docs. In
essence, you need modern (enough) graphics drivers, and pip>=20.3
.
Status
We're currently working towards version 1.0
, which means that the API
can change with each version. We expect to reach 1.0
near the end of
2024, at which point we start caring about backwards compatibility.
This means that until then, you should probably pin the Pygfx version that you're using, and check the release notes when you update.
Usage Example
Note The example below is designed against the
main
branch, and may not work on the latest release from pypi, while we're in beta.
Note A walkthrough of this example can be found in the guide.
import pygfx as gfx
import pylinalg as la
cube = gfx.Mesh(
gfx.box_geometry(200, 200, 200),
gfx.MeshPhongMaterial(color="#336699"),
)
rot = la.quat_from_euler((0, 0.01), order="XY")
def animate():
cube.local.rotation = la.quat_mul(rot, cube.local.rotation)
if __name__ == "__main__":
gfx.show(cube, before_render=animate)
Feature Highlights
Some of Pygfx's key features are:
- SDF based text rendering (example)
- order-independent transparency (OIT) (example)
- lights, shadows, and physically based rendering (PBR) (example)
- event system with built-in picking (example)
- texture and color mapping supporting 1D, 2D and 3D data (example)
And many more! Check out our feature demos in the docs.
License
Pygfx is licensed under the BSD 2-Clause "Simplified" License. This means:
- :white_check_mark: It is free (and open source) forever. :cupid:
- :white_check_mark: You can use it commercially.
- :white_check_mark: You can distribute it and freely make changes.
- :x: You can not hold us accountable for the results of using Pygfx.
Contributing
See CONTRIBUTING.md.
Development Install
To get a working dev install of Pygfx you can use the following steps:
# Click the Fork button on GitHub and navigate to your fork
git clone <address_of_your_fork>
cd pygfx
# if you use a venv, create and activate it
pip install -e ".[dev,docs,examples]"
pytest tests
Testing
The test suite is divided into three parts; unit tests for the core, unit tests for the examples, and screenshot tests for the validation examples.
pytest -v tests
runs the core unit tests.pytest -v examples
tests the examples.
The screenshot tests are difficult to guarantee across all development platforms and are best run on our CI where more predictable outcomes can be achieved. They can run on a local linux machine by selecting the software rendering adapter and the tests with the command
PYGFX_WGPU_ADAPTER_NAME=llvmpipe pytest examples -k test_examples_compare
Note that our pytest.ini
file contains the environment variable
PYGFX_DISABLE_SYSTEM_FONTS=1
to help ensure consistency across system
installations.
Code of Conduct
Our code of conduct can be found here: Code of Conduct
Spelling and pronunciation
Lowercase "pygfx" is used in code. You can refer to the project in written text using "Pygfx". Pygfx is pronounced as pie-graphics.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pygfx-0.5.0.tar.gz
.
File metadata
- Download URL: pygfx-0.5.0.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 693a0d80515bfc94b0578859bba542c786569086bd62fd4de26d256fad54c12c |
|
MD5 | 9c12b3aa09b8f6b151eb368bed63e752 |
|
BLAKE2b-256 | cabdc38d7d5a58c7955be01bbad95ada28ab0a349c1f638ab4519dae09841fe6 |
Provenance
File details
Details for the file pygfx-0.5.0-py3-none-any.whl
.
File metadata
- Download URL: pygfx-0.5.0-py3-none-any.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1ea6f1b1603264070337268a099c89ef69785e056d36fa6022d5e31ed8cdc6d |
|
MD5 | 33e99d5e0135a94f7dbb745d6da7de4d |
|
BLAKE2b-256 | 4ea561ed33d89524d78db9f64189a7fea204cdde2556597696f50987b55ef44d |