From 1ebbd5c2ed8f81e3fe4b04d04947eb5a1e6b0b61 Mon Sep 17 00:00:00 2001 From: Matthias Diener Date: Thu, 9 May 2024 18:22:34 -0500 Subject: [PATCH] Update install docs - remove non-functional link to Christoph Gohlke's binary wheels - remove link to older wiki - add basic source install docs --- doc/misc.rst | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/doc/misc.rst b/doc/misc.rst index 9bcd79d4..fe89693d 100644 --- a/doc/misc.rst +++ b/doc/misc.rst @@ -177,19 +177,28 @@ To install pyopencl with oclgrind, an OpenCL debugger do:: For example, installing PyOpenCL from pip followed by OCL-ICD from Conda Forge can redirect the ICD loader, removing access to system-wide ICDs. -Installing via Christoph Gohlke's binary wheels (Windows) ---------------------------------------------------------- - -Christoph Gohlke distributes `binary wheels for PyOpenCL on Windows -`__. - Installing from source ---------------------- -Information on how to install PyOpenCL *from source* is still available on the -`Former PyOpenCL Wiki `__, but that should -mostly not be necessary unless you have very specific needs or would like to modify -PyOpenCL yourself. +Installing PyOpenCL *from source* should mostly not be necessary unless you +have very specific needs or would like to modify PyOpenCL yourself. +You can find generic installation instructions for ``nanobind``-based packages `here `__. + +For PyOpenCL, the process is as follows: + +.. code-block:: bash + + $ cd pyopencl + + # non-editable install: + $ pip install -v . + + # editable install - make sure to disable build isolation: + $ pip install --no-build-isolation -ve . + + # editable install with automatic recompilation if needed: + $ pip install --no-build-isolation -Ceditable.rebuild=true -ve . + Tips ==== -- GitLab