FDownload.dox 3.4 KB
Newer Older
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
1
2
/*! \page install Downloading, Building and Installing ScalFMM
*
3
4
5
6
* On this page, you will find all the requirements for building and installing ScalFMM.
*
* \tableofcontents
*
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
7
8
9
10
11
12
13
14
15
16
17
18
19
* \section download Download ScalFMM
*
* To download ScalFmm go on http://scalfmm-public.gforge.inria.fr/download.html.
*
* You can stay in touch of the updates and new version by registering
* to the users mailing list
* (scalfmm-public-users@lists.gforge.inria.fr) which has a very low
* traffic (one email per month) at :
* http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/scalfmm-public-users.
*
* \section secNecessary Require
*
* <ul>
20
  * <li> CMake for compiling, ccmake for configuring the build. Version 2.8.12.1 or later </li>
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
21
22
23
24
25
26
27
28
29
30
31
  * <li> Open MP </li>
  * <li> MPI, if you want to use distributed version of the algorithm </li>
  * <li> A compiler supporting C++ 2011 </li>
  * </ul>
*
* \section build Build
* How to build ScalFMM
* <ul>
  * <li> Go to scalfmm/Build directory </li>
  * <li> type <b> $> cmake .. </b> 
    * <ul>
32
      * <li> If you want to enable MPI, use <b> $> cmake .. -DScaLFMM_USE_MPI=ON </b> </li>
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
33
34
35
36
37
38
      * </ul>
    * </li>
  * <li> then configure your build with <b> $> ccmake .. </b> if needed </li>
  * <li> then type <b> $> make name_of_exec </b> </li>
  * </ul>
*
39
40
41
42
* an example : <br>
*        <b> cmake -DScalFMM_USE_BLAS=ON -DScalFMM_USE_MKL_AS_BLAS=ON \  <br>
*                           -DScalFMM_USE_SSE=OFF -DScalFMM_USE_AVX=ON ../ </b>
*
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
43
44
45
46
47
48
* \subsection conf Configuration of the build
* 
* This is all the build options you can modify.
*
* <ul>
  * <li> CMAKE_INSTALL_PREFIX : to choose where to install ScalFmm </li>
49
50
51
52
  * <li> ScalFMM_USE_MPI : to use and enable MPI. Warning, you need to use this parameter at the first cmake command you write. </li>
  * <li> ScalFMM_ATTACHE_SOURCE : to build with -g </li>
  * <li> SScalFMM_BUILD_TESTS : to build the text and the examples </li>
  * <li> ScalFMM_BUILD_UTESTS : to build the unit tests </li>
COULAUD Olivier's avatar
COULAUD Olivier committed
53
  * <li> ScalFMM_USE_ADDONS : to activate add ons </li>
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
54
55
56
  * <ul>
    * <li> SCALFMM_ADDON_FMMAPI : to build Fmm Api </li>
    * </ul>
57
58
59
  * <li> ScalFMM_USE_DOUBLE_PRECISION : to build in double precision </li>
  * <li> ScalFMMUSE_MEM_STATS : to use memory stats (which count any new/delete done during a simulation) </li>
  * <li> ScalFMM_USE_BLAS : to enable BLAS (needed by Chebyshev interpolation kernel) </li>
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
60
61
62
  * <ul>
    * <li> SCALFMM_USE_MKL_AS_BLAS : to use MKL as blas </li>
    * </ul>
63
64
65
66
67
    * <li> ScalFMM_USE_FFT : Use FFTW needed for  uniform point for interpolation kernel</li> 
      * <ul>
    * <li> ( ScalFMM_USE_MKL_AS_FFTW : to use MKL as FFTW </li>
    * </ul>
  * <li> ScalFMM_USE_TRACE : to create trace </li>
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
68
  * <ul>
69
    * <li> ScalFMM_USE_ITAC : to use Intel ITAC tool as trace generator </li>
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
70
    * </ul>
71
72
73
74
75
76
    * <li> ScalFMM_USE_LOG        to print output debug information
    * <li> ScalFMM_USE_ASSERT   enable safe tests during execution
    * <li> ScalFMM_USE_MEM_STATS to profile memory
     * <li> ScalFMM_USE_SSE  compile with SEE support
     * <li> ScalFMM_USE_AVX      compile with AVX support
                    * <li> 
PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
77
78
79
80
81
82
83
84
85
86
87
88
  * </ul>
*
* Once the library is built, you may want to install it : <b> $> make
* install </b>. Note that it is not an obligation to install ScalFmm
* to use it. You can build it and use it from the Build directory.

* The whole project is documented using Doxygen. You can build the doc
* by typing <b> $> make doc </b> in the Build directory.

*
*
*/