Skip to content

Commit ef1e715

Browse files
authored
Update README section about using setup.py (#228)
1 parent 65ecf39 commit ef1e715

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ conda install dpctl
4242
Build and Install with setuptools
4343
=================================
4444
dpCtl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
45+
`setup.py` requires environment variable `ONEAPI_ROOT` and following packages
46+
installed:
47+
- `cython`
48+
- `numpy`
49+
- `cmake` - for building C API
50+
- `ninja` - only on Windows
51+
52+
Activate DPC++ compiler:
53+
```bash
54+
export ONEAPI_ROOT=/opt/intel/oneapi
55+
source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh
56+
```
4557

4658
For install:
4759
```cmd
@@ -81,10 +93,11 @@ Run python examples:
8193
for script in `ls examples/python/`; do echo "executing ${script}"; python examples/python/${script}; done
8294
```
8395

84-
Examples of building Cython extensions with DPC++ compiler, that interoperate with dpCtl can be found in
85-
folder `cython`.
96+
Examples of building Cython extensions with DPC++ compiler, that interoperate
97+
with dpCtl can be found in folder `cython`.
8698

87-
Each example in `cython` folder can be built using `CC=clang CXX=dpcpp python setup.py build_ext --inplace`.
99+
Each example in `cython` folder can be built using
100+
`CC=clang CXX=dpcpp python setup.py build_ext --inplace`.
88101
Please refer to `run.py` script in respective folders to execute extensions.
89102

90103
Tests

0 commit comments

Comments
 (0)