Skip to content

Commit 51b41b8

Browse files
Updated quick start guide to reflect changes in setup
1 parent c7529c6 commit 51b41b8

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

docs/docfiles/user_guides/QuickStart.rst

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Dpctl can also be istalled from Pypi.
5050

5151
.. code-block:: bash
5252
53-
python -m pip install --index-url https://pypi.anaconda.org/intel/simple --extra-index-url https://pypi.org/simple dpctl
53+
python -m pip install --index-url https://pypi.anaconda.org/intel/simple dpctl
5454
5555
.. note::
5656

@@ -133,33 +133,41 @@ After building the conda package you may install it by executing:
133133
3.18 instead.
134134

135135

136-
Build and install with setuptools
137-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136+
Build and install with scikit-build
137+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138138

139-
To build using Python ``setuptools``, the following packages should be
139+
To build using Python ``setuptools`` and ``scikit-build``, the following Python packages should be
140140
installed:
141141

142142
- ``cython``
143143
- ``numpy``
144144
- ``cmake``
145+
- ``scikit-build``
145146
- ``ninja`` (only on Windows)
146147
- ``gtest`` (optional to run C API tests)
148+
- ``gmock`` (optional to run C API tests)
147149
- ``pytest`` (optional to run Python API tests)
148150

149-
Once the prerequisites are installed, building using ``setuptools`` involves The
150-
usual steps
151+
Once the prerequisites are installed, building using ``scikit-build`` involves the usual steps, to build and install:
152+
153+
.. code-block:: bash
151154
152-
to build and install
155+
python setup.py install -- -G Unix\ Makefiles -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON
156+
157+
, and to develop:
153158

154159
.. code-block:: bash
155160
156-
python setup.py install
161+
python setup.py develop -G Unix\ Makefiles -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON
162+
163+
On Windows, use ``icx`` for both C and CXX compilers, and use :code:`-G Ninja` for cmake generator.
157164

158-
, and to develop.
165+
Developing on Linux can also be done using driver script:
159166

160167
.. code-block:: bash
161168
162-
python setup.py develop
169+
python scripts/build_sycl_nightly.py --oneapi
170+
163171
164172
Building using custom dpcpp
165173
---------------------------
@@ -168,12 +176,18 @@ It is possible to build dpctl from source using .. _DPC++ toolchain: https://git
168176
instead of the DPC++ compiler that comes with oneAPI. One reason for doing this
169177
may be to enable support for CUDA devices.
170178

171-
Following steps in `Build and install with setuptools`_ use command line
179+
Following steps in `Build and install with scikit-build`_ use command line
172180
option :code:`--sycl-compiler-prefix`, for example:
173181

174182
.. code-block:: bash
175183
176-
python setup.py develop --sycl-compiler-prefix=${DPCPP_ROOT}/llvm/build
184+
python setup.py develop -- -G Unix\ Makefiles -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ONE -DDPCTL_DPCPP_HOME_DIR=${DPCPP_ROOT}/llvm/build -DDPCTL_DPCPP_FROM_ONEAPI=OFF
185+
186+
Alterantively, the driver script can be used
187+
188+
.. code-block:: bash
189+
190+
python scripts/build_sycl_nightly.py --c-compiler=clang --cxx-compiler=clang++ --compiler-root=${DPCPP_ROOT}/llvm/build
177191
178192
Available options and their descriptions can be retrieved using option
179193
:code:`--help`.

0 commit comments

Comments
 (0)