|
3 | 3 | A lightweight Python package exposing a subset of OpenCL and SYCL
|
4 | 4 | functionalities.
|
5 | 5 |
|
| 6 | +Requirements |
| 7 | +============ |
| 8 | +- Install Conda |
| 9 | +- Install Intel oneAPI |
| 10 | + - Set environment variable `ONEAPI_ROOT` |
| 11 | + - Windows: `C:\Program Files (x86)\Intel\oneAPI\` |
| 12 | + - Linux: `/opt/intel/oneapi` |
| 13 | +- Install OpenCL HD graphics drivers |
6 | 14 |
|
7 |
| -How to install? |
8 |
| -=== |
9 |
| -1. Install oneAPI and OpenCL HD graphics drivers. |
10 |
| -2. Install conda or miniconda (you can use the conda that comes with oneAPI). |
11 |
| -3. [Optional] Create and activate a conda environment: |
| 15 | +Build and Install Conda Package |
| 16 | +================================== |
| 17 | +1. Create and activate conda build environment |
| 18 | +```bash |
| 19 | +conda create -n build-env conda-build |
| 20 | +conda activate build-env |
| 21 | +``` |
| 22 | +2. Build conda package |
| 23 | +```bash |
| 24 | +conda build conda-recipe |
| 25 | +``` |
| 26 | +On Windows to cope with [long file names](https://github.com/IntelPython/pydppl/issues/15): |
| 27 | +```cmd |
| 28 | +conda build --croot=C:/tmp conda-recipe |
| 29 | +``` |
| 30 | +3. Install conda package |
| 31 | +```bash |
| 32 | +conda install pydppl |
| 33 | +``` |
12 | 34 |
|
13 |
| - ```bash |
14 |
| - conda env create -n dppl-env -f scripts/environment.yml` |
15 |
| - conda activate dppl-env |
16 |
| - ``` |
17 |
| -4. Run `./scripts/build_for_conda.sh` |
| 35 | +Using PyDPPL |
| 36 | +============ |
| 37 | +PyDPPL relies on SYCL runtime. With Intel oneAPI installed you should activate it. |
18 | 38 |
|
19 |
| -Examples: |
20 |
| -=== |
21 |
| - Run create_sycl_queues.py under examples. |
| 39 | +On Windows: |
| 40 | +```cmd |
| 41 | +call "%ONEAPI_ROOT%\compiler\latest\env\vars.bat" |
| 42 | +``` |
| 43 | +On Linux: |
| 44 | +```bash |
| 45 | +source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh |
| 46 | +``` |
22 | 47 |
|
23 |
| - `python examples/create_sycl_queues.py` |
| 48 | +Examples |
| 49 | +======== |
| 50 | +See examples in folder `examples`. |
| 51 | + |
| 52 | +Run examples: |
| 53 | +```bash |
| 54 | +python examples/create_sycl_queues.py |
| 55 | +``` |
0 commit comments