From 183680373c385cf9a5aed074158f1a24b6b64bad Mon Sep 17 00:00:00 2001 From: Sergey Pokhodenko Date: Wed, 12 Aug 2020 21:20:34 +0300 Subject: [PATCH 1/5] Update README --- README.md | 45 ++++++++++++++++++++++++++++++--------------- 1 file changed, 30 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d03324f2ce..b3106cd10b 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,36 @@ What? A lightweight Python package exposing a subset of OpenCL and SYCL functionalities. +Requirements +============ +- Install Conda +- Install Intel oneAPI + - Set environment variable `ONEAPI_ROOT` + - Windows: `C:\Program Files (x86)\Intel\oneAPI\` + - Linux: `/opt/intel/oneapi` +- Install OpenCL HD graphics drivers -How to install? -=== -1. Install oneAPI and OpenCL HD graphics drivers. -2. Install conda or miniconda (you can use the conda that comes with oneAPI). -3. [Optional] Create and activate a conda environment: +Building and Install Conda Package +================================== +1. Create and activate conda build environment +```bash +conda create -n build-env conda-build +conda activate build-env +``` +2. Build conda package +```bash +conda build conda-recipe +``` +3. Install conda package +```bash +conda install pydppl +``` - ```bash - conda env create -n dppl-env -f scripts/environment.yml` - conda activate dppl-env - ``` -4. Run `./scripts/build_for_conda.sh` +Examples +======== +See examples in folder `examples`. -Examples: -=== - Run create_sycl_queues.py under examples. - - `python examples/create_sycl_queues.py` +Run examples: +```bash +python examples/create_sycl_queues.py +``` From d0f092b1a32aca0a5bb3ffa6b8cbd2a039d12459 Mon Sep 17 00:00:00 2001 From: Sergey Pokhodenko Date: Wed, 12 Aug 2020 23:20:48 +0300 Subject: [PATCH 2/5] Add workaround for Windows long file names --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b3106cd10b..8f3d208db9 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ conda activate build-env ```bash conda build conda-recipe ``` +On Windows to cope with long file names: +```cmd +conda build --croot=C:/tmp conda-recipe +``` 3. Install conda package ```bash conda install pydppl From 8dc0ba1bb39b986b2b3fc635ceeebd4c939062d6 Mon Sep 17 00:00:00 2001 From: Sergey Pokhodenko Date: Wed, 12 Aug 2020 23:50:02 +0300 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f3d208db9..e9ee06ad70 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ conda activate build-env ```bash conda build conda-recipe ``` -On Windows to cope with long file names: +On Windows to cope with [long file names](https://github.com/IntelPython/pydppl/issues/15): ```cmd conda build --croot=C:/tmp conda-recipe ``` From 669f23ad7d41b462bf572849387a9d1807fc3338 Mon Sep 17 00:00:00 2001 From: Sergey Pokhodenko Date: Wed, 12 Aug 2020 23:55:35 +0300 Subject: [PATCH 4/5] Add oneAPI environment activation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e9ee06ad70..c2be850ca3 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,19 @@ conda build --croot=C:/tmp conda-recipe conda install pydppl ``` +Using PyDPPL +============ +PyDPPL relies on SYCL runtime. With Intel oneAPI installed you should activate it. + +On Windows: +```cmd +call "%ONEAPI_ROOT%\compiler\latest\env\vars.bat" +``` +On Linux: +```bash +source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh +``` + Examples ======== See examples in folder `examples`. From 5f3edaf03be25eaf45a5a9e4ec0cd14f34436b9f Mon Sep 17 00:00:00 2001 From: Sergey Pokhodenko Date: Wed, 12 Aug 2020 23:58:13 +0300 Subject: [PATCH 5/5] Fix: Build and Install Conda Package --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c2be850ca3..b657d0d00c 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Requirements - Linux: `/opt/intel/oneapi` - Install OpenCL HD graphics drivers -Building and Install Conda Package +Build and Install Conda Package ================================== 1. Create and activate conda build environment ```bash