Skip to content

Commit 0f9751a

Browse files
author
Diptorup Deb
authored
Minor edits to the quick start guide. (#457)
1 parent c759a50 commit 0f9751a

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

docs/docfiles/user_guides/QuickStart.rst

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,16 @@ Installing from oneAPI
1414
----------------------
1515

1616
Dpctl is available as part of the oneAPI Intel Distribution of Python (IDP).
17-
Please follow `oneAPI installation guide`_ to install oneAPI. In this guide it
18-
is assumed oneAPI is installed in the standard location and the environment
19-
variable ``ONEAPI_ROOT`` points to the following installation root directory:
17+
Please follow `oneAPI installation guide`_ to install oneAPI. In this quick
18+
start guide, it is assumed oneAPI is installed in the standard location and the
19+
environment variable ``ONEAPI_ROOT`` points to the following installation root
20+
directory:
2021

2122
- Windows: ``C:\Program Files (x86)\Intel\oneAPI\``
2223
- Linux: ``/opt/intel/oneapi``
2324

24-
Once oneAPI is installed, dpctl is ready to be used by setting up the IDP that
25-
is available inside oneAPI. IDP can be set up as follows:
25+
Once oneAPI is installed, dpctl is ready to be used by setting up IDP from
26+
the oneAPI installation. IDP can be set up as follows:
2627

2728
On Linux
2829

@@ -44,26 +45,26 @@ On Windows
4445
The ``dpctl.lsplatform()`` function is new in dpctl 0.7 and will be
4546
available in oneAPI 2021.3. If you are following the guide on an older
4647
oneAPI installation, use ``dpctl.dump()``. If no GPU platforms are shown,
47-
make source your system has a GPU and has the necessary GPU drivers. You can
48-
install GPU drivers by following the `GPU driver installation guide`_.
48+
make sure your system has a supported GPU and has the necessary GPU drivers
49+
installed. You can install GPU drivers by following the
50+
`GPU driver installation guide`_.
4951

5052
Install Wheel package from Pypi
5153
-------------------------------
5254

53-
1. Install dpctl
55+
Dpctl can also be istalled from Pypi.
5456

5557
.. code-block:: bash
5658
5759
python -m pip install --index-url https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple dpctl
5860
5961
.. note::
6062

61-
Dpctl wheel package is placed on Pypi, but some of its dependencies
62-
(like Intel numpy) are available only in Anaconda Cloud. That is why install
63-
command requires additional Intel Pypi channel from Anaconda Cloud.
64-
65-
2. Set path to Performance Libraries in case of using ``venv`` or system Python.
66-
63+
The dpctl wheel package is available on Pypi, but some of the dependencies
64+
(like Intel numpy) are available only in Anaconda Cloud. For this reason,
65+
please install the extra packages needed by dpctl from the Intel channel in
66+
Anaconda cloud. Additionally, you will need to set the ``LD_LIBRARY_PATH``
67+
or ``PATH`` correctly.
6768

6869
On Linux
6970

@@ -82,8 +83,8 @@ Building from source
8283

8384
To build dpctl from source, we need dpcpp and GPU drivers (and optionally CPU
8485
OpenCL drivers). It is preferable to use the dpcpp compiler packaged as part of
85-
oneAPI. However, it is possible to use a custom build of dpcpp and use that to
86-
build dpctl, especially if you want to enable CUDA support.
86+
oneAPI. However, it is possible to use a custom build of dpcpp to build dpctl,
87+
especially if you want to enable CUDA support.
8788

8889
Building using oneAPI dpcpp
8990
~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)