minor rewording
[dealii.wiki.git] / deal.II-in-Spack.md
1 # Using deal.II on Mac OS X and Linux via Spack
2
3 The deal.II suite is also available on Spack (https://github.com/LLNL/spack) -- a flexible package manager developed with High-Performance-Computing in mind. It is intended to let you build for many combinations of compiler, architectures, dependency libraries, and build configurations, all with a friendly, intuitive user interface.
4
5 For a short overview of features and motivation, we recommend this short presentation https://tgamblin.github.io/files/Gamblin-Spack-SC15-Talk.pdf
6
7 ## Quick installation on the desktop
8
9 Add the following to `~/.bashrc` (or equivalent)
10 ```
11 export SPACK_ROOT=/path/to/spack
12 PATH="$SPACK_ROOT/bin:$PATH"
13 ```
14 `SPACK_ROOT` is the destination where you want Spack to be installed (i.e. `$HOME/spack`).
15
16 Now clone Spack
17 ```
18 cd $SPACK_ROOT
19 git clone https://github.com/llnl/spack.git .
20 git checkout develop
21 # the following commit was tested on:
22 # - Ubuntu16.04+gcc5.4.0 PC
23 # - centos7+gcc4.8.5 cluster
24 git reset --hard 1124bdc99ee84c26201c40536d9b04dac74d7f6a
25 ```
26
27 **Make sure C/C++/Fortran compilers are in path** (on Ubuntu you need to `sudo apt-get install gfortran`, on macOS you can compile `gcc` with spack, see [below](#install-gcc)), and you have **curl** (`sudo apt-get install curl`) to download packages. Then install the complete deal.II suite
28 ```
29 spack install dealii
30 ```
31 **DONE**! No extra (preliminary) configuration steps are needed on most Linux distributions. **IMPORTANT:** If you compile deal.II on a cluster, see the next section on how to use externally provided MPI implementation instead.
32
33 Before configuring your project you need to set `DEAL_II_DIR` by 
34 ```
35 export DEAL_II_DIR=$(spack location -i dealii)
36 ```
37 You may jump ahead and read [best practices using spack](#best-practices-using-spack). Also a good starting point is [Getting Started Guide](http://spack.readthedocs.io/en/latest/getting_started.html).
38
39
40 ## Installation example on a Centos7 cluster (Emmy cluster of RRZE, Erlangen, Germany)
41 In order to use Spack on a cluster, there are two options: (1) you are a sysadmin and you know hardware details and can use Spack to properly configure and build MPI providers (e.g. `openmpi`); (2) you are a user and you need to make Spack work with MPI provided on your cluster. Below we consider the latter case.
42
43 Here is a brief step-by-step instruction to install deal.II on [Emmy cluster](https://www.rrze.fau.de/dienste/arbeiten-rechnen/hpc/systeme/emmy-cluster.shtml#access) of RRZE, Erlangen, Germany:
44
45 (1) Download spack
46 ```
47 module load git
48 mkdir $WOODYHOME/spack
49 cd $WOODYHOME/spack
50 git clone https://github.com/llnl/spack.git $WOODYHOME/spack
51 git reset --hard 1124bdc99ee84c26201c40536d9b04dac74d7f6a
52 export PATH=$WOODYHOME/spack/bin:$PATH
53 ```
54 (2) Load `openmpi` and let Spack find GCC compiler which is also loaded as a dependency:
55 ```
56 module load openmpi/2.0.1-gcc
57 spack compiler find
58 ```
59 (3) Add `openmpi` as an external package, along with `python` and a few other self explanatory setting for `deal.ii`. That is done by adding the following to `~/.spack/linux/packages.yaml`
60 ```
61 packages:
62   all:
63     compiler: [gcc]
64     providers:
65       mpi: [openmpi]
66       blas: [openblas]
67       lapack: [openblas]
68   python:
69     version: [2.7.12]
70     paths:
71       python@2.7.12: /usr/
72     buildable: False
73   openmpi:
74     version: [2.0.1]
75     paths:
76       openmpi@2.0.1%gcc@4.8.5: /apps/OpenMPI/2.0.1-gcc/
77     buildable: False
78   dealii:
79     version: [develop]
80     variants: +optflags~python
81 ```
82 Those paths are the location where external packages can be found (i.e. `<prefix>` instead of `<prefix>/bin` or `<prefix>/lib`).
83 (4) Now install deal.II:  `spack install dealii`.
84
85 Note that we specifically build deal.II without `python` wrappers. Otherwise deal.II would be linked against system provided `python` which itself may be linked against system provided `zlib`. As a result we may have a mixture of Spack's build `zlib` and system provided `zlib`, which is certainly not what we want.
86
87
88 ## Environment Modules
89 Spack provides some integration with Environment Modules and Dotkit to make it easier to use the packages it installs. For a full description, read http://spack.readthedocs.io/en/latest/getting_started.html#environment-modules
90
91 To add the support for Environment Modules run
92 ```
93 spack install environment-modules
94 ```
95 Get the path to the prefix of `environment-modules` by:
96 ```
97 spack location --install-dir environment-modules
98 ```
99 and then add to `~/.bashrc` (or equivalent)
100 ```
101 MODULES_HOME=/path/to/environment-modules
102 source ${MODULES_HOME}/Modules/init/bash
103 . $SPACK_ROOT/share/spack/setup-env.sh
104 ```
105
106 If you install `deal.II` before setting up environment modules,
107 the module files have to be regenerated
108 ```
109 spack module refresh
110 ```
111
112 Then run
113 ```
114 spack load dealii
115 spack load cmake
116 ```
117 Now `DEAL_II_DIR` environment variable should be set appropriately and `cmake` executable will be available in path. Keep in mind that `spack load dealii` will also set `LD_LIBRARY_PATH` accordingly, this may or may not be what you need. An alternative is to use `export DEAL_II_DIR=$(spack location -i dealii)`.
118
119 ## System provided packages
120 Spack is flexible to use both self-compiled and system provided packages. 
121 In most cases this is desirable for `MPI`, which is already installed on computational clusters. To configure external packages you need to edit `~/.spack/linux/packages.yaml`. For `openmpi` this could be
122 ```
123 packages:
124   openmpi:
125     version: [1.8.8]
126     paths:
127       openmpi@1.8.8%gcc@6.2.0: /opt/openmpi-1.8.8
128     buildable: False
129 ```
130 In order to make sure that we use to build packages `1.8.8` version of `openmpi` and not the most recent one (i.e. `2.0.2`), we specified conretization preferences with `version: [1.8.8]`.
131
132 One can also specify which packages should be used to provide `mpi`, `blas/lapack` , preferred compilers and preferred variants:
133 ```
134 packages:
135   all:
136     compiler: [gcc,clang]
137     providers:
138       mpi: [openmpi]
139       blas: [openblas]
140       lapack: [openblas]
141     boost:
142       variants: +python
143 ```
144
145 For more elaborated discussion, see [Configuration Files in Spack](http://spack.readthedocs.io/en/latest/configuration.html).
146
147 ## Installing GCC
148 If your system does not provide any Fortran compiler or you want to have the most recent `gcc`,
149 you can install it by
150 ```
151 spack install gcc
152 ```
153
154 Assuming that you configured [Environment Modules](#environment-modules), load `gcc` and let Spack find the newly installed compilers:
155 ```
156 spack load gcc
157 spack compiler find
158 ```
159 Now you can install deal.II with `gcc`
160 ```
161 spack install dealii%gcc
162 ```
163
164 If you are on the mac, read the following instructions on [Mixed Toolchains](http://spack.readthedocs.io/en/latest/getting_started.html#mixed-toolchains).
165
166 On following these instructions, you will be able to install deal.II with clang+gfortran
167 ```
168 spack install dealii%clang
169 ```
170
171 ## Best practices using Spack:
172
173 Spack is complicated and flexible package manager primarily aimed at High-Performance-Computing.
174 Below are some examples of using Spack to build and develop deal.II:
175
176 ### Info:
177 If you are not sure which options a given package has, simply run
178 ```
179 spack info <package>
180 ```
181 The output will contain available versions, variants, dependencies and description:
182 ```
183 $ spack info dealii
184 CMakePackage:    dealii
185 Homepage:        https://www.dealii.org
186
187 Safe versions:
188     develop    [git] https://github.com/dealii/dealii.git
189     8.4.2      https://github.com/dealii/dealii/releases/download/v8.4.2/dealii-8.4.2.tar.gz
190     8.4.1      https://github.com/dealii/dealii/releases/download/v8.4.1/dealii-8.4.1.tar.gz
191     8.4.0      https://github.com/dealii/dealii/releases/download/v8.4.0/dealii-8.4.0.tar.gz
192     8.3.0      https://github.com/dealii/dealii/releases/download/v8.3.0/dealii-8.3.0.tar.gz
193     8.2.1      https://github.com/dealii/dealii/releases/download/v8.2.1/dealii-8.2.1.tar.gz
194     8.1.0      https://github.com/dealii/dealii/releases/download/v8.1.0/dealii-8.1.0.tar.gz
195
196 Variants:
197     Name        Default   Description
198
199     arpack      on        Compile with Arpack and PArpack (only with MPI)
200     doc         off       Compile with documentation
201     gsl         on        Compile with GSL
202     hdf5        on        Compile with HDF5 (only with MPI)
203     int64       off       Compile with 64 bit indices support
204     metis       on        Compile with Metis
205     mpi         on        Compile with MPI
206     netcdf      on        Compile with Netcdf (only with MPI)
207     oce         on        Compile with OCE
208     p4est       on        Compile with P4est (only with MPI)
209     petsc       on        Compile with Petsc (only with MPI)
210     python      on        Compile with Python bindings
211     slepc       on        Compile with Slepc (only with Petsc and MPI)
212     trilinos    on        Compile with Trilinos (only with MPI)
213
214 Installation Phases:
215     cmake    build    install
216
217 Build Dependencies:
218     arpack-ng  blas  boost  bzip2  cmake  doxygen  graphviz  gsl  hdf5  lapack  metis  mpi  muparser  netcdf  netcdf-cxx  oce  p4est  petsc  python  slepc  suite-sparse  tbb  trilinos  zlib
219
220 Link Dependencies:
221     arpack-ng  blas  boost  bzip2  doxygen  graphviz  gsl  hdf5  lapack  metis  mpi  muparser  netcdf  netcdf-cxx  oce  p4est  petsc  python  slepc  suite-sparse  tbb  trilinos  zlib
222
223 Run Dependencies:
224     None
225
226 Virtual Packages:
227     None
228
229 Description:
230     C++ software library providing well-documented tools to build finite
231     element codes for a broad variety of PDEs.
232 ```
233
234 A lot of `spack` commands have help, for example
235 ```
236 $spack install -h
237 usage: spack install [-h] [--only {package,dependencies}] [-j JOBS]
238                      [--keep-prefix] [--keep-stage] [-n] [-v] [--fake]
239                      [--clean | --dirty] [--run-tests] [--log-format {junit}]
240                      [--log-file LOG_FILE]
241                      ...
242
243 positional arguments:
244   package               spec of the package to install
245
246 optional arguments:
247   -h, --help            show this help message and exit
248   --only {package,dependencies}
249                         select the mode of installation. the default is to
250                         install the package along with all its dependencies.
251                         alternatively one can decide to install only the
252                         package or only the dependencies
253   -j JOBS, --jobs JOBS  explicitly set number of make jobs. default is #cpus
254   --keep-prefix         don't remove the install prefix if installation fails
255   --keep-stage          don't remove the build stage if installation succeeds
256   -n, --no-checksum     do not check packages against checksum
257   -v, --verbose         display verbose build output while installing
258   --fake                fake install. just remove prefix and create a fake
259                         file
260   --clean               clean environment before installing package
261   --dirty               do NOT clean environment before installing
262   --run-tests           run package level tests during installation
263   --log-format {junit}  format to be used for log files
264   --log-file LOG_FILE   filename for the log file. if not passed a default
265                         will be used
266 ```
267
268 ### Extra options:
269 One can specify extra options for packages in the deal.II suite. For example if you want to have boost with `python` module, this can be done by
270 ```
271 spack install dealii@develop+mpi~python ^boost+python
272 ```
273
274 If you want to specify blas/lapack/mpi implementations, this can be done similarly
275 ```
276 spack install dealii@develop+mpi ^mpich
277 ```
278 To check which packages implement `mpi` run
279 ```
280 spack providers mpi
281 ```
282 One can also specify which Blas/Lapack implementation to use. For example to build deal.II suite with `atlas` run
283 ```
284 spack install dealii ^atlas
285 ```
286
287 ### Compiler flags
288 You can specify compiler flags on the command line as
289 ```
290 spack install dealii cppflags="-march=native -O3"
291 ```
292 Note that these flags will be inherited by dependencies such as `petsc`, `trilinos`, etc. Same can be done by declaring these flags in `~/.spack/compilers.yaml`:
293 ```
294 compilers:
295 - compiler:
296     modules: []
297     operating_system: centos6
298     paths:
299       cc: /usr/bin/gcc
300       cxx: /usr/bin/g++
301       f77: /usr/bin/gfortran
302       fc: /usr/bin/gfortran
303     flags:
304       cflags: -O3 -fPIC
305       cxxflags: -O3 -fPIC
306       cppflags: -O3 -fPIC
307     spec: gcc@4.7.2
308 ```
309
310 If you want to use flags for `dealii` only, you can first build all the dependencies without flags and then build `dealii` with custom flags:
311 ```
312 spack install --only dependencies dealii
313 spack install dealii cppflags="-march=native -O3"
314 ```
315
316 See this [google forum topic](https://groups.google.com/forum/?fromgroups#!topic/dealii/3Yjy8CBIrgU) for discussion on which flags to use. You can also use `spack install dealii+optflags` to enable extra optimization flags in release build.
317
318 ### Different versions coexisting:
319 One can easily have slightly different versions of deal.II side-by-side, e.g. to compile development version of deal.II with complex-valued PETSc and `gcc` compiler run
320 ```
321 spack install dealii@develop+mpi+petsc~int64%gcc ^petsc+complex~hypre
322 ```
323 The good thing is that if you already have deal.ii built with real-valued petsc, then only `petsc`, `slepc` and `deal.ii` itself will be rebuild. Everything else (`trilinos`, `mumps`, `metis`, etc) will be reused.
324
325 One can use `environment-modules` (see above) to automatically set `DEAL_II_DIR` to the complex version: 
326 ```
327 spack load dealii@develop+mpi+petsc~int64%gcc ^petsc+complex~hypre
328 ```
329
330 ### Filesystem Views:
331 If you prefer to have the whole dealii suite (and possible something else) symlinked into a single path (like `/usr/local`), one can use [Filesystem Views](http://spack.readthedocs.io/en/latest/workflows.html#filesystem-views):
332 ```
333 spack view -v symlink dealii_suite dealii@develop
334 ```
335 You can also add to this view other packages, i.e.
336 ```
337 spack view -v symlink dealii_suite the-silver-searcher
338 ```
339
340
341 ### Check before build:
342 It is often convenient to check which version of packages, compilers, variants etc will be used before actually starting installation. That can be done by examining the concretized spec via `spack spec` command, e.g. 
343 ```
344 spack spec dealii@develop+mpi+petsc~int64%gcc ^petsc+complex~hypre
345 ```
346
347 ### Develop using Spack
348 There are several ways to use Spack while contributing patches to the deal.II. The simplest is to create a [Filesystem view](#filesystem-views) for an already installed library and then compile patched version of deal.II manually by providing path to the view for each dependency. For example on macOS with `openblas`:
349 ```
350 export DEAL_II_VIEW=/Users/davydden/spack/_dealii_suite
351 cmake -DCMAKE_FIND_FRAMEWORK=LAST -DCMAKE_INSTALL_RPATH_USE_LINK_PATH=FALSE -DCMAKE_INSTALL_RPATH=${DEAL_II_VIEW} -DCMAKE_BUILD_TYPE=DebugRelease -DDEAL_II_COMPONENT_EXAMPLES=ON -DDEAL_II_WITH_THREADS:BOOL=ON -DBOOST_DIR=${DEAL_II_VIEW} -DBZIP2_DIR=${DEAL_II_VIEW} -DLAPACK_FOUND=true -DLAPACK_INCLUDE_DIRS=${DEAL_II_VIEW}/include -DLAPACK_LIBRARIES=${DEAL_II_VIEW}/lib/libopenblas.dylib -DMUPARSER_DIR=${DEAL_II_VIEW} -DUMFPACK_DIR=${DEAL_II_VIEW} -DTBB_DIR=${DEAL_II_VIEW} -DZLIB_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_MPI:BOOL=ON -DCMAKE_C_COMPILER=${DEAL_II_VIEW}/bin/mpicc -DCMAKE_CXX_COMPILER=${DEAL_II_VIEW}/bin/mpic++ -DCMAKE_Fortran_COMPILER=${DEAL_II_VIEW}/bin/mpif90 -DGSL_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_GSL:BOOL=ON -DHDF5_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_HDF5:BOOL=ON -DP4EST_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_P4EST:BOOL=ON -DPETSC_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_PETSC:BOOL=ON -DSLEPC_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_SLEPC:BOOL=ON -DTRILINOS_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_TRILINOS:BOOL=ON -DMETIS_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_METIS:BOOL=ON -DDEAL_II_COMPONENT_DOCUMENTATION=OFF -DARPACK_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_ARPACK=ON -DDEAL_II_ARPACK_WITH_PARPACK=ON -DNETCDF_DIR=${DEAL_II_VIEW} -DOPENCASCADE_DIR=${DEAL_II_VIEW} -DDEAL_II_WITH_OPENCASCADE=ON ../
352 ```
353 Here we specify locations of libraries in `${DEAL_II_VIEW}` and also point to `mpi` compilers by `${DEAL_II_VIEW}/bin/mpicc` and alike. Keep in mind that the autodetection of `LAPACK` is turned off and therefore we specified full path to libs as `${DEAL_II_VIEW}/lib/libopenblas.dylib`. You would need to adjust the suffix if you are on Linux.
354
355 ### Keep the stage to run unit tests
356 By default, the build folder (aka `stage`) for each package is created in a temporary system dependent location.
357 This gets purge by system on next restart.
358 If you want to keep the stage after the installation, you need to do two things:
359 First, make spack use a custom location for stage by adding the following to your `~/.spack/config.yaml`:
360 ```
361 config:
362   build_stage:
363     - $spack/var/spack/stage
364 ```
365 Second, prescribe an extra argument to `install` command to keep the stage after successful installation:
366 ```
367 spack install --keep-stage dealii@develop
368 ```
369
370 ### MKL and Licensed software
371 Spack supports installation of [licensed software](http://spack.readthedocs.io/en/latest/packaging_guide.html#license). For example in order to install MKL on Linux:
372
373 1. add the `license.lic` file to `${SPACK_ROOT}/etc/spack/licenses/intel/`.
374 2. manually download Intel MKL archive `l_mkl_11.3.2.181.tgz` (Spack can not do it for you due to the license of `intel-mkl`).
375 3. `cd` to the folder with archive and run `spack install intel-mkl@11.3.2.181`.
376
377 One can then run `spack install dealii ^intel-mkl@11.3.2.181`.
378
379
380 ### Freeze package versions
381 Currently Spack does not try to re-use already installed packages. On another hand, by default
382 the most recent version of a package will be installed. When updating deal.II build (for example to use the new version of `trilinos`), the combination of the two factors may lead to recompilation of many other packages used in the deal.II suite when one of the main build dependency like `cmake` has a new version.
383
384 To circumvent the problem, the user can specify preferred versions of packages in `~/.spack/packages.yaml`:
385 ```
386 packages:
387   cmake:
388     version: [3.6.1]
389   curl:
390     version: [7.50.3]
391   openssl:
392     version: [1.0.2j]
393   python:
394     version: [2.7.12]
395 ```
396 This settings will be taken into account during conretization process and thus will help to avoid rebuilding most of the deal.II suite when, for example, `openssl` is updated to the new version.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.