Skip to content

Commit cac382b

Browse files
author
Diptorup Deb
committed
Improvements to getting_started guide.
1 parent 3473dbd commit cac382b

File tree

1 file changed

+37
-11
lines changed

1 file changed

+37
-11
lines changed

docs/source/getting_started.rst

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,40 @@ Getting Started
99
===============
1010

1111

12-
Installing pre-built packages
13-
-----------------------------
12+
Installing pre-built conda packages
13+
-----------------------------------
1414

1515
``numba-dpex`` along with its dependencies can be installed using ``conda``.
1616
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.
1918

2019
.. code-block:: bash
2120
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+
2335
2436
Building from source
2537
--------------------
2638

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``.
2841

2942
Steps to build using ``conda-build``:
3043

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.
3246

3347
.. code-block:: bash
3448
@@ -45,22 +59,34 @@ Steps to build using ``conda-build``:
4559

4660
.. code-block:: bash
4761
48-
conda install numba-dpex
62+
conda install -c local numba-dpex
4963
5064
Steps to build using ``setup.py``:
5165

66+
As before, a conda environment with all necessary dependencies is the suggested
67+
first step.
68+
5269
.. code-block:: bash
5370
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
5576
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
5681
5782
Building inside Docker
5883
----------------------
5984

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``
6186
as well as its direct dependencies: ``dpctl`` and ``dpnp``. Users can either use
6287
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.
6490

6591
Building
6692
~~~~~~~~

0 commit comments

Comments
 (0)