Skip to content

Commit e9eeca7

Browse files
npolina4vtavana
andauthored
Add build documentation for custom SYCL targets (#2026)
* Add build documentation for custom SYCL targets * Add RPATH for build with onemkl * Update doc/quick_start_guide.rst Co-authored-by: vtavana <[email protected]> --------- Co-authored-by: vtavana <[email protected]>
1 parent e5506bf commit e9eeca7

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ if(_use_onemkl_interfaces)
121121
GIT_TAG f2d2dcb4213a435bb60fbb88320c5f24892423ce
122122
)
123123
FetchContent_MakeAvailable(onemkl_interfaces_library)
124+
set(CMAKE_INSTALL_RPATH "${CMAKE_BINARY_DIR}/lib")
124125
endif()
125126

126127
if(WIN32)

doc/quick_start_guide.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,27 @@ Alternatively, to develop on Linux OS, you can use the driver script:
116116
117117
python scripts/build_locally.py
118118
119+
Building for custom SYCL targets
120+
--------------------------------
121+
Project ``dpnp`` is written using generic SYCL and supports building for multiple SYCL targets,
122+
subject to limitations of `CodePlay <https://codeplay.com/>`_ plugins implementing SYCL
123+
programming model for classes of devices.
124+
125+
Building ``dpnp`` for these targets requires that these CodePlay plugins be installed into DPC++
126+
installation layout of compatible version. The following plugins from CodePlay are supported:
127+
128+
- `oneAPI for NVIDIA(R) GPUs <codeplay_nv_plugin_>`_
129+
130+
.. _codeplay_nv_plugin: https://developer.codeplay.com/products/oneapi/nvidia/
131+
132+
Building ``dpnp`` also requires `building Data Parallel Control Library for custom SYCL targets.
133+
<https://intelpython.github.io/dpctl/latest/beginners_guides/installation.html#building-for-custom-sycl-targets>`_
134+
135+
Build ``dpnp`` as follows:
136+
137+
.. code-block:: bash
138+
139+
python scripts/build_locally.py --target=cuda
119140
120141
Testing
121142
=======

0 commit comments

Comments
 (0)