Skip to content

Commit d0606c8

Browse files
author
Rastislav Turanyi
committed
Update documentation
1 parent 3372795 commit d0606c8

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/source/installation.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,45 @@ At this stage, the only way to install ``hmat_lib`` is from source:
66
From Source
77
===========
88

9+
Dependencies
10+
------------
11+
12+
The following dependencies must first be installed before building:
13+
14+
C Compiler
15+
^^^^^^^^^^
16+
17+
The following C compilers have been tested for building ``hmat_lib``:
18+
19+
* gcc
20+
* Clang
21+
* AppleClang
22+
23+
.. important::
24+
``hmat_lib`` uses OpenMP for parallelisation, so the compiler has to support
25+
OpenMP if this is desirable - without it, a single-threaded code will be
26+
produced.
27+
28+
Math Libraries
29+
^^^^^^^^^^^^^^
30+
31+
Both BLAS and LAPACK routines are used throughout ``hmat_lib``, so some
32+
implementation that provides both of these is required.
33+
34+
.. warning::
35+
While the specific implementation of the math libraries does not matter in
36+
general, it **must** export Fortran-style symbols. Therefore, some
37+
implementations that only provide special interfaces (e.g. Apple's
38+
Accelerate) will currently fail to build.
39+
40+
41+
Testing Libraries
42+
^^^^^^^^^^^^^^^^^
43+
44+
`Criterion <https://github.com/Snaipe/Criterion>`_ is used for running tests,
45+
so it must be installed before tests can be built.
46+
47+
948
CMake
1049
-----
1150

0 commit comments

Comments
 (0)