python-pyopencl

https://salsa.debian.org/opencl-team/python-pyopencl

Repository

README.rst

PyOpenCL: Pythonic Access to OpenCL, with Arrays and Algorithms
===============================================================

.. |badge-gitlab-ci| image:: https://gitlab.tiker.net/inducer/pyopencl/badges/main/pipeline.svg
    :alt: Gitlab Build Status
    :target: https://gitlab.tiker.net/inducer/pyopencl/commits/main
.. |badge-github-ci| image:: https://github.com/inducer/pyopencl/workflows/CI/badge.svg?branch=main&event=push
    :alt: Github Build Status
    :target: https://github.com/inducer/pyopencl/actions?query=branch%3Amain+workflow%3ACI+event%3Apush
.. |badge-pypi| image:: https://badge.fury.io/py/pyopencl.svg
    :alt: Python Package Index Release Page
    :target: https://pypi.org/project/pyopencl/
.. |badge-zenodo| image:: https://zenodo.org/badge/1575307.svg
    :alt: Zenodo DOI for latest release
    :target: https://zenodo.org/badge/latestdoi/1575307

|badge-gitlab-ci| |badge-github-ci| |badge-pypi| |badge-zenodo|

PyOpenCL lets you access GPUs and other massively parallel compute
devices from Python. It tries to offer computing goodness in the
spirit of its sister project `PyCUDA `__:

* Object cleanup tied to lifetime of objects. This idiom, often
  called `RAII `__
  in C++, makes it much easier to write correct, leak- and
  crash-free code.

* Completeness. PyOpenCL puts the full power of OpenCL's API at
  your disposal, if you wish.  Every obscure ``get_info()`` query and
  all CL calls are accessible.

* Automatic Error Checking. All CL errors are automatically
  translated into Python exceptions.

* Speed. PyOpenCL's base layer is written in C++, so all the niceties
  above are virtually free.

* Helpful and complete `Documentation `__
  as well as a `Wiki `__.

* Liberal license. PyOpenCL is open-source under the
  `MIT license `__
  and free for commercial, academic, and private use.

* Broad support. PyOpenCL was tested and works with Apple's, AMD's, and Nvidia's
  CL implementations.

Simple 4-step `install instructions `__
using Conda on Linux and macOS (that also install a working OpenCL implementation!)
can be found in the `documentation `__.

What you'll need if you do *not* want to use the convenient instructions above and
instead build from source:

* g++/clang new enough to be compatible with nanobind (specifically, full support of C++17 is needed)
* `numpy `__, and
* an OpenCL implementation. (See this `howto `__
  for how to get one.)

Links
-----

* `Documentation `__
  (read how things work)
* `Python package index `__
  (download releases, including binary wheels for Linux, macOS, Windows)
* `Conda Forge `__
  (download binary packages for Linux, macOS, Windows)
* `Github `__
  (get latest source code, file bugs)

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Kloeckner"
  given-names: "Andreas"
  orcid: "https://orcid.org/0000-0003-1228-519X"
- family-names: "Yu"
  given-names: "Yichao"
- family-names: "Wala"
  given-names: "Matt"
- family-names: "Fernando"
  given-names: "Isuru"
- family-names: "Bencun"
  given-names: "Marko"
- family-names: "Kulkarni"
  given-names: "Kaushik"
- family-names: "Diener"
  given-names: "Matthias"
- family-names: "Gao"
  given-names: "Hao"
- family-names: "Fikl"
  given-names: "Alex"
- family-names: "Weiner"
  given-names: "Zach"
- family-names: "Weigert"
  given-names: "Martin"
- family-names: "Palmer"
  given-names: "Rebecca"
- family-names: "Latham"
  given-names: "Shane"
- family-names: "Magno"
  given-names: "Gonçalo"
- family-names: "Fuller"
  given-names: "Henry"
- family-names: "Mackenzie"
  given-names: "Jonathan"
- family-names: "Niarchos"
  given-names: "Sotiris"
- family-names: "Gill"
  given-names: "Shahzaib"
- family-names: "Gohlke"
  given-names: "Christoph"
- family-names: "Bhosale"
  given-names: "Aditya"
- family-names: "Rothberg"
  given-names: "Alex"
- family-names: "Ey"
  given-names: "Emanuel"
- family-names: "Rapp"
  given-names: "Holger"
- family-names: "van der Walt"
  given-names: "Stefan"
# Removed pending resolution of https://github.com/zenodo/zenodo/issues/2343
# - alias: "gw0"
- family-names: "Thalhammer"
  given-names: "Gregor"
- family-names: "Kieffer"
  given-names: "Jerome"
- family-names: "Poliarnyi"
  given-names: "Nikolai"
- family-names: "Bollinger"
  given-names: "Drew"
- family-names: "Nitz"
  given-names: "Alex"
- family-names: "Bokota"
  given-names: "Grzegorz"
  orcid: 'https://orcid.org/0000-0002-5470-1676'

title: "PyOpenCL"
version: 2022.1.3
doi: 10.5281/zenodo.6533956
date-released: 2022-03-10
url: "https://github.com/inducer/pyopencl"
license: MIT