Skip to content

Commit 5db0cce

Browse files
committed
Update docs and example build instructions to remove python setup.py develop
1 parent ad31a0d commit 5db0cce

File tree

4 files changed

+34
-9
lines changed

4 files changed

+34
-9
lines changed

docs/doc_sources/contributor_guides/building.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,16 @@ To develop, run:
129129

130130
.. code-block:: bash
131131
132-
python setup.py develop -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx
132+
python setup.py build_ext --inplace -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx
133+
python -m pip install -e .
133134
134135
.. tab-item:: Windows
135136
:sync: win
136137

137138
.. code-block:: bat
138139
139-
python setup.py develop -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icx
140+
python setup.py build_ext --inplace -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icx
141+
python -m pip install -e .
140142
141143
142144
Developing can be streamlined using the driver script:
@@ -169,7 +171,8 @@ the relevant CMake variables, for example:
169171

170172
.. code-block:: bash
171173
172-
python setup.py develop -- -G Ninja -DCMAKE_C_COMPILER:PATH=$(which clang) -DCMAKE_CXX_COMPILER:PATH=$(which clang++)
174+
python setup.py build_ext --inplace -G Ninja -DCMAKE_C_COMPILER:PATH=$(which clang) -DCMAKE_CXX_COMPILER:PATH=$(which clang++)
175+
python -m pip install -e .
173176
174177
175178
Or you can use the driver script:

examples/cython/sycl_buffer/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,14 @@ oneMKL.
1414

1515
> **NOTE:** Make sure oneAPI is activated, $ONEAPI_ROOT must be set.
1616
17-
To compile the example, run:
17+
To compile the example on Linux, run:
18+
```bash
19+
CC=icx CXX=icpx python setup.py build_ext --inplace -G Ninja
1820
```
19-
python setup.py develop
21+
22+
On Windows, run:
23+
```bash
24+
CC=icx CXX=icx python setup.py build_ext --inplace -G Ninja
2025
```
2126

2227
## Running

examples/cython/use_dpctl_sycl/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,14 @@ written in Cython.
99

1010
## Building
1111

12+
To build the example on Linux, run:
1213
```bash
13-
python setup.py develop
14+
CC=icx CXX=icpx python setup.py build_ext --inplace -G Ninja
15+
```
16+
17+
On Windows, run:
18+
```bash
19+
CC=icx CXX=icx python setup.py build_ext --inplace -G Ninja
1420
```
1521

1622
## Testing

examples/pybind11/onemkl_gemv/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
> **NOTE:** Install scikit-build and dpcpp before next steps.
77
8-
To build, run:
9-
```sh
10-
python setup.py develop -- -G "Ninja" \
8+
To build on Linux, run:
9+
```bash
10+
python setup.py build_ext --inplace -- -G "Ninja" \
1111
-DCMAKE_C_COMPILER:PATH=icx \
1212
-DCMAKE_CXX_COMPILER:PATH=icpx \
1313
-DTBB_LIBRARY_DIR=$CONDA_PREFIX/lib \
@@ -16,6 +16,17 @@ python setup.py develop -- -G "Ninja" \
1616
-DTBB_INCLUDE_DIR=${CONDA_PREFIX}/include
1717
```
1818

19+
To build on Windows, run:
20+
```bash
21+
python setup.py build_ext --inplace -- -G "Ninja" \
22+
-DCMAKE_C_COMPILER:PATH=icx \
23+
-DCMAKE_CXX_COMPILER:PATH=icx \
24+
-DTBB_LIBRARY_DIR=$CONDA_PREFIX/lib \
25+
-DMKL_LIBRARY_DIR=${CONDA_PREFIX}/lib \
26+
-DMKL_INCLUDE_DIR=${CONDA_PREFIX}/include \
27+
-DTBB_INCLUDE_DIR=${CONDA_PREFIX}/include
28+
```
29+
1930
## Running
2031

2132
To run the example, use:

0 commit comments

Comments
 (0)