Skip to content

Commit 2c2da3a

Browse files
committed
Update the documentation to reflect the new compilation requirements.
1 parent db9df08 commit 2c2da3a

1 file changed

Lines changed: 23 additions & 33 deletions

File tree

doc/installation.rst

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,40 @@ The library is routinely tested on OS X and linux and, less
55
frequently, on Windows. The OS most frequently tested are:
66

77
- Debian 6
8-
- Ubuntu 14.04
9-
- Mac OS X 10.11
8+
- Ubuntu 16.04
9+
- Mac OS X 10.12
1010
- Windows 7
1111

1212
It should also work on any decently recent OS not listed here. If you
1313
get an error during the build on your favorite OS, please report it
1414
and we will attempt to fix it.
1515

16-
Requirements
17-
------------
16+
Build Requirements
17+
------------------
1818

1919
- cmake >= 3.0 (cmake_).
2020
- a c99-compliant compiler (or MSVC if on windows).
21-
- (optional) CUDA >= 6.5 (cuda_).
22-
- (optional) NVIDIA NCCL (nccl_).
23-
- (optional) OpenCL runtime.
24-
- (optional) clBLAS (clblas_).
2521
- (optional) libcheck (check_) to run the C tests.
2622
- (optional) python (python_) for the python bindings.
2723
- (optional) mako (mako_) for development or running the python bindings.
2824
- (optional) Cython >= 0.21 (cython_) for the python bindings.
2925
- (optional) nosetests (nosetests_) to run the python tests.
3026

31-
.. note::
32-
If you have neither an OpenCL runtime or a CUDA runtime, the
33-
library might still build, but will be rather useless.
27+
Run Requirements
28+
----------------
3429

35-
.. note::
36-
We support CUDA GPUs with `compute capability 2.0 (Fermi)
37-
<https://developer.nvidia.com/cuda-gpus>`_ and up.
30+
No matter what was available at build time, this library comes with
31+
dynamic loaders for the following library. You don't need to have any
32+
of this available, but you won't be able to use associated
33+
functionality.
3834

39-
.. note::
40-
In the case you want to build with collective operation support for CUDA,
41-
you will need CUDA GPUs with `compute capability 3.0 (Kepler)
42-
<https://developer.nvidia.com/cuda-gpus>`_ and up plus CUDA >= 7.
35+
* For CUDA:
36+
- CUDA (cuda_) version 7.0 or more, with the appropriate driver
37+
- (optional) NCCL (nccl_) for the collectives interface
38+
39+
* For OpenCL:
40+
- OpenCL version 1.1 or more
41+
- (optional) clBLAS (_clblas) or CLBlast (_clblast) for blas functionality
4342

4443
Download
4544
--------
@@ -125,18 +124,8 @@ can also reboot the machine to do that.
125124
Mac-specific instructions
126125
-------------------------
127126

128-
To get the compiler you need to install Xcode which is available for
129-
free from the App Store. Don't forget to install the command-line
130-
tools afterwards.
131-
132-
On Xcode 4.x these are installed by going to the download tab of the
133-
preferences window and selecting the "Command-line Tools" download.
134-
135-
If you have Xcode 5, ensure you update to 5.0.2 or later. Prior
136-
versions will not look in /usr/local for includes or libraries and
137-
this will cause a lot of errors. You can update by using the
138-
"Software Update..." function of the Apple menu or by running
139-
'xcode-select --install' on the command line.
127+
The only supported compile is the clang version that comes with Xcode.
128+
Select the appropriate version of Xcode for you version of macOS.
140129

141130
It might be possible to use a version of gcc built using Homebrew or
142131
MacPorts, but this is untested and unsupported.
@@ -177,9 +166,8 @@ Running Tests
177166
everything is ok even if you intend on just using the C library.
178167

179168
To run the C tests, enter the build directory (the one where you ran
180-
cmake) and run 'make test'. It will run using the first OpenCL and
181-
the first CUDA device it finds skipping these if the corresponding
182-
backend wasn't built.
169+
cmake), select a target device by exporting DEVICE (or
170+
GPUARRAY_TEST_DEVICE) and run 'make test'.
183171

184172
If you get an error message similar to this one:
185173

@@ -215,6 +203,8 @@ you can confirm which device it is running on.
215203

216204
.. _clblas: https://github.com/clMathLibraries/clBLAS
217205

206+
.. _clblast: https://github.com/CNugteren/CLBlast
207+
218208
.. _cuda: https://developer.nvidia.com/category/zone/cuda-zone
219209

220210
.. _nccl: https://github.com/NVIDIA/nccl

0 commit comments

Comments
 (0)