Skip to content

Update README section about using setup.py #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 16, 2020
Merged

Update README section about using setup.py #228

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ conda install dpctl
Build and Install with setuptools
=================================
dpCtl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
`setup.py` requires environment variable `ONEAPI_ROOT` and following packages
installed:
- `cython`
- `numpy`
- `cmake` - for building C API
- `ninja` - only on Windows

Activate DPC++ compiler:
```bash
export ONEAPI_ROOT=/opt/intel/oneapi
source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh
```

For install:
```cmd
Expand Down Expand Up @@ -81,10 +93,11 @@ Run python examples:
for script in `ls examples/python/`; do echo "executing ${script}"; python examples/python/${script}; done
```

Examples of building Cython extensions with DPC++ compiler, that interoperate with dpCtl can be found in
folder `cython`.
Examples of building Cython extensions with DPC++ compiler, that interoperate
with dpCtl can be found in folder `cython`.

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

Tests
Expand Down