From a5427c1ee4dae4bedb1306e7efd166a826aaaa8f Mon Sep 17 00:00:00 2001
From: Grzegorz Bokota <bokota+github@gmail.com>
Date: Sat, 21 May 2022 17:51:02 +0200
Subject: [PATCH] Update inforamation about provided wheels versions (#565)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* add orcid information
* update documentation
* add more information about versions
* try to fix doc
* Apply suggestions from code review
Co-authored-by: Andreas Klöckner <inform@tiker.net>
Co-authored-by: Andreas Klöckner <inform@tiker.net>
---
CITATION.cff | 1 +
doc/misc.rst | 18 +++++++++++-------
2 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/CITATION.cff b/CITATION.cff
index 06e29440..e1e24f2a 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -63,6 +63,7 @@ authors:
given-names: "Alex"
- family-names: "Bokota"
given-names: "Grzegorz"
+ orcid: 'https://orcid.org/0000-0002-5470-1676'
title: "PyOpenCL"
version: 2022.1.3
diff --git a/doc/misc.rst b/doc/misc.rst
index 74d80681..ff71ae7a 100644
--- a/doc/misc.rst
+++ b/doc/misc.rst
@@ -133,18 +133,22 @@ and it is packaged so that the OpenCL drivers that are registered in the OS
using registry keys are automatically available.
-Installing from PyPI with Linux wheels
---------------------------------------
+Installing from PyPI wheels
+---------------------------
+
+PyOpenCL distributes wheels for most popular OSs and Python versions.
+To check available versions please visit `PyPI page for PyOpenCL <https://pypi.org/project/pyopencl/>`__.
+
-PyOpenCL distributes ``manylinux1`` wheels in PyPI. These wheels are compatible with
-GLIBC>=2.5 based distributions.
+On Linux, the wheels come with `OCL-ICD <https://github.com/OCL-dev/ocl-icd>`__ bundled and
+configured to use any OpenCL implementation supporting the ICD interface and listed
+in :file:`/etc/OpenCL/vendors`.
+Wheels for Windows and MacOS are built using the ICD Loader from the Khronos Group.
-On Linux, type::
+To install, type::
pip install pyopencl
-The wheels comes with OCL-ICD bundled and configured to use any OpenCL implementation
-supporting ICD interface installed in :file:`/etc/OpenCL/vendors`
You can also install the following CPU based OpenCL implementation using pip shipped as binary
wheels. Note that pyopencl has to be installed using a wheel for pyopencl to recognize these
--
GitLab