@@ -9,26 +9,40 @@ Getting Started
9
9
===============
10
10
11
11
12
- Installing pre-built packages
13
- -----------------------------
12
+ Installing pre-built conda packages
13
+ -----------------------------------
14
14
15
15
``numba-dpex `` along with its dependencies can be installed using ``conda ``.
16
16
It is recommended to use conda packages from the ``anaconda.org/intel `` channel
17
- to get the latest production releases. Nighly builds of ``numba-dpex `` are
18
- available on the ``dppy/label/dev `` conda channel.
17
+ to get the latest production releases.
19
18
20
19
.. code-block :: bash
21
20
22
- conda create -n numba-dpex-env numba-dpex dpnp dpctl dpcpp-llvm-spirv spirv-tools -c intel -c conda-forge
21
+ conda create -n numba-dpex-env \
22
+ numba-dpex dpnp dpctl dpcpp-llvm-spirv spirv-tools \
23
+ -c intel -c conda-forge
24
+
25
+ To try out the bleeding edge, the latest packages built from tip of the main
26
+ source trunk can be installed from the ``dppy/label/dev `` conda channel.
27
+
28
+ .. code-block :: bash
29
+
30
+ conda create -n numba-dpex-env \
31
+ numba-dpex dpnp dpctl dpcpp-llvm-spirv spirv-tools \
32
+ -c dppy/label/dev -c intel -c conda-forge
33
+
34
+
23
35
24
36
Building from source
25
37
--------------------
26
38
27
- ``numba-dpex `` can be built from source using either ``conda-build `` or ``setuptools ``.
39
+ ``numba-dpex `` can be built from source using either ``conda-build `` or
40
+ ``setuptools ``.
28
41
29
42
Steps to build using ``conda-build ``:
30
43
31
- 1. Create a conda environment
44
+ 1. Ensure ``conda-build `` is installed in the ``base `` conda environment or
45
+ create a new conda environment with ``conda-build `` installed.
32
46
33
47
.. code-block :: bash
34
48
@@ -45,22 +59,34 @@ Steps to build using ``conda-build``:
45
59
46
60
.. code-block :: bash
47
61
48
- conda install numba-dpex
62
+ conda install -c local numba-dpex
49
63
50
64
Steps to build using ``setup.py ``:
51
65
66
+ As before, a conda environment with all necessary dependencies is the suggested
67
+ first step.
68
+
52
69
.. code-block :: bash
53
70
54
- conda create -n numba-dpex-env dpctl dpnp numba spirv-tools dpcpp-llvm-spirv llvmdev pytest -c intel -c conda-forge
71
+ # Create a conda environment that hass needed dependencies installed
72
+ conda create -n numba-dpex-env \
73
+ dpctl dpnp numba spirv-tools dpcpp-llvm-spirv llvmdev pytest \
74
+ -c intel -c conda-forge
75
+ # Activate the environment
55
76
conda activate numba-dpex-env
77
+ # Clone the numba-dpex repository
78
+ git clone https://github.com/IntelPython/numba-dpex.git
79
+ cd numba-dpex
80
+ python setup.py develop
56
81
57
82
Building inside Docker
58
83
----------------------
59
84
60
- A Dockerfile is provided on the GitHub repository to easily build ``numba-dpex ``
85
+ A Dockerfile is provided on the GitHub repository to build ``numba-dpex ``
61
86
as well as its direct dependencies: ``dpctl `` and ``dpnp ``. Users can either use
62
87
one of the pre-built images on the ``numba-dpex `` GitHub page or use the
63
- bundled Dockerfile to build ``numba-dpex `` from source.
88
+ bundled Dockerfile to build ``numba-dpex `` from source. Using the Dockerfile
89
+ also ensures that all device drivers and runtime libraries are pre-installed.
64
90
65
91
Building
66
92
~~~~~~~~
0 commit comments