update tested hash for Ubuntu and MKL instructions
[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 quick overview of Spack's features, we recommend this short presentation https://tgamblin.github.io/files/Gamblin-Spack-SC15-Talk.pdf
6
7 Note: Spack is in active development and is in alpha state, thereby below we recommend checking out specific hashes, that were tested with deal.II.
8
9 ## Quick installation on the desktop
10
11 Add the following to `~/.bashrc` (or equivalent)
12 ```
13 export SPACK_ROOT=/path/to/spack
14 PATH="$SPACK_ROOT/bin:$PATH"
15 ```
16 `SPACK_ROOT` is the destination where you want Spack to be installed (i.e. `$HOME/spack`).
17
18 Now clone Spack
19 ```
20 cd $SPACK_ROOT
21 git clone https://github.com/llnl/spack.git .
22 git checkout develop
23 # the following commit was tested on:
24 # - Ubuntu16.04+gcc5.4.0 PC
25 #   [x] spack install dealii%gcc@5.4.0+mpi ^openmpi ^openblas
26 #   [ ] spack install dealii%gcc@5.4.0+mpi ^openmpi ^intel-mkl@11.3.3.210
27 #   [ ] spack install dealii%gcc@5.4.0+mpi ^openmpi ^atlas
28 #   [ ] spack install dealii%gcc@5.4.0+mpi+int64 ^openmpi ^openblas
29 git reset --hard 715ac8b7e67b094c094ec290729c5257cd565a0c
30 ```
31
32 **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
33 ```
34 spack install dealii
35 ```
36 **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.
37
38 Before configuring your project you need to set `DEAL_II_DIR` by 
39 ```
40 export DEAL_II_DIR=$(spack location -i dealii)
41 ```
42 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).
43
44
45 ## Installation example on a Centos7 cluster (Emmy cluster of RRZE, Erlangen, Germany)
46 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.
47
48 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:
49
50 (1) Download spack
51 ```
52 module load git
53 mkdir $WOODYHOME/spack
54 cd $WOODYHOME/spack
55 git clone https://github.com/llnl/spack.git $WOODYHOME/spack
56 git reset --hard 715ac8b7e67b094c094ec290729c5257cd565a0c
57 export PATH=$WOODYHOME/spack/bin:$PATH
58 ```
59 (2) Load `openmpi` and let Spack find GCC compiler which is also loaded as a dependency:
60 ```
61 module load openmpi/2.0.2-gcc
62 spack compiler find
63 ```
64 (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`
65 ```
66 packages:
67   all:
68     compiler: [gcc]
69     providers:
70       mpi: [openmpi]
71       blas: [openblas]
72       lapack: [openblas]
73   python:
74     version: [2.7.12]
75     paths:
76       python@2.7.12: /usr/
77     buildable: False
78   openmpi:
79     version: [2.0.2]
80     paths:
81       openmpi@2.0.2%gcc@4.8.5: /apps/OpenMPI/2.0.2-gcc/
82     buildable: False
83   dealii:
84     version: [develop]
85     variants: +optflags~python
86 ```
87 Those paths are the location where external packages can be found (i.e. `<prefix>` instead of `<prefix>/bin` or `<prefix>/lib`). `providers` section essentially tells Spack which packages to use to satisfy virtual dependencies such as `MPI`, `BLAS`, `LAPACK`, `ScaLAPACK`, etc.
88
89 (4) Now install deal.II:  `spack install dealii`.
90
91 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.
92
93
94 ## Environment Modules
95 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
96
97 To add the support for Environment Modules run
98 ```
99 spack install environment-modules
100 ```
101 Get the path to the prefix of `environment-modules` by:
102 ```
103 spack location --install-dir environment-modules
104 ```
105 and then add to `~/.bashrc` (or equivalent)
106 ```
107 MODULES_HOME=/path/to/environment-modules
108 source ${MODULES_HOME}/Modules/init/bash
109 . $SPACK_ROOT/share/spack/setup-env.sh
110 ```
111
112 If you install `deal.II` before setting up environment modules,
113 the module files have to be regenerated
114 ```
115 spack module refresh
116 ```
117
118 Then run
119 ```
120 spack load dealii
121 spack load cmake
122 ```
123 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)`.
124
125 ## System provided packages
126 Spack is flexible to use both self-compiled and system provided packages. 
127 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
128 ```
129 packages:
130   openmpi:
131     version: [1.8.8]
132     paths:
133       openmpi@1.8.8%gcc@6.2.0: /opt/openmpi-1.8.8
134     buildable: False
135 ```
136 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]`.
137
138 One can also specify which packages should be used to provide `mpi`, `blas/lapack` , preferred compilers and preferred variants:
139 ```
140 packages:
141   all:
142     compiler: [gcc,clang]
143     providers:
144       mpi: [openmpi]
145       blas: [openblas]
146       lapack: [openblas]
147     boost:
148       variants: +python
149 ```
150
151 For more elaborated discussion, see [Configuration Files in Spack](http://spack.readthedocs.io/en/latest/configuration.html).
152
153 ## Installing GCC
154 If your system does not provide any Fortran compiler or you want to have the most recent `gcc`,
155 you can install it by
156 ```
157 spack install gcc
158 ```
159
160 Assuming that you configured [Environment Modules](#environment-modules), load `gcc` and let Spack find the newly installed compilers:
161 ```
162 spack load gcc
163 spack compiler find
164 ```
165 Now you can install deal.II with `gcc`
166 ```
167 spack install dealii%gcc
168 ```
169
170 If you are on the mac, read the following instructions on [Mixed Toolchains](http://spack.readthedocs.io/en/latest/getting_started.html#mixed-toolchains).
171
172 On following these instructions, you will be able to install deal.II with clang+gfortran
173 ```
174 spack install dealii%clang
175 ```
176
177 ## Best practices using Spack:
178
179 Spack is complicated and flexible package manager primarily aimed at High-Performance-Computing.
180 Below are some examples of using Spack to build and develop deal.II:
181
182 ### Info:
183 If you are not sure which options a given package has, simply run
184 ```
185 spack info <package>
186 ```
187 The output will contain available versions, variants, dependencies and description:
188 ```
189 $ spack info dealii
190 CMakePackage:    dealii
191 Homepage:        https://www.dealii.org
192
193 Safe versions:
194     develop    [git] https://github.com/dealii/dealii.git
195     8.4.2      https://github.com/dealii/dealii/releases/download/v8.4.2/dealii-8.4.2.tar.gz
196     8.4.1      https://github.com/dealii/dealii/releases/download/v8.4.1/dealii-8.4.1.tar.gz
197     8.4.0      https://github.com/dealii/dealii/releases/download/v8.4.0/dealii-8.4.0.tar.gz
198     8.3.0      https://github.com/dealii/dealii/releases/download/v8.3.0/dealii-8.3.0.tar.gz
199     8.2.1      https://github.com/dealii/dealii/releases/download/v8.2.1/dealii-8.2.1.tar.gz
200     8.1.0      https://github.com/dealii/dealii/releases/download/v8.1.0/dealii-8.1.0.tar.gz
201
202 Variants:
203     Name        Default   Description
204
205     arpack      on        Compile with Arpack and PArpack (only with MPI)
206     doc         off       Compile with documentation
207     gsl         on        Compile with GSL
208     hdf5        on        Compile with HDF5 (only with MPI)
209     int64       off       Compile with 64 bit indices support
210     metis       on        Compile with Metis
211     mpi         on        Compile with MPI
212     netcdf      on        Compile with Netcdf (only with MPI)
213     oce         on        Compile with OCE
214     p4est       on        Compile with P4est (only with MPI)
215     petsc       on        Compile with Petsc (only with MPI)
216     python      on        Compile with Python bindings
217     slepc       on        Compile with Slepc (only with Petsc and MPI)
218     trilinos    on        Compile with Trilinos (only with MPI)
219
220 Installation Phases:
221     cmake    build    install
222
223 Build Dependencies:
224     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
225
226 Link Dependencies:
227     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
228
229 Run Dependencies:
230     None
231
232 Virtual Packages:
233     None
234
235 Description:
236     C++ software library providing well-documented tools to build finite
237     element codes for a broad variety of PDEs.
238 ```
239
240 A lot of `spack` commands have help, for example
241 ```
242 $spack install -h
243 usage: spack install [-h] [--only {package,dependencies}] [-j JOBS]
244                      [--keep-prefix] [--keep-stage] [-n] [-v] [--fake]
245                      [--clean | --dirty] [--run-tests] [--log-format {junit}]
246                      [--log-file LOG_FILE]
247                      ...
248
249 positional arguments:
250   package               spec of the package to install
251
252 optional arguments:
253   -h, --help            show this help message and exit
254   --only {package,dependencies}
255                         select the mode of installation. the default is to
256                         install the package along with all its dependencies.
257                         alternatively one can decide to install only the
258                         package or only the dependencies
259   -j JOBS, --jobs JOBS  explicitly set number of make jobs. default is #cpus
260   --keep-prefix         don't remove the install prefix if installation fails
261   --keep-stage          don't remove the build stage if installation succeeds
262   -n, --no-checksum     do not check packages against checksum
263   -v, --verbose         display verbose build output while installing
264   --fake                fake install. just remove prefix and create a fake
265                         file
266   --clean               clean environment before installing package
267   --dirty               do NOT clean environment before installing
268   --run-tests           run package level tests during installation
269   --log-format {junit}  format to be used for log files
270   --log-file LOG_FILE   filename for the log file. if not passed a default
271                         will be used
272 ```
273
274 ### Extra options:
275 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
276 ```
277 spack install dealii@develop+mpi~python ^boost+python
278 ```
279
280 If you want to specify blas/lapack/mpi implementations, this can be done similarly
281 ```
282 spack install dealii@develop+mpi ^mpich
283 ```
284 To check which packages implement `mpi` run
285 ```
286 spack providers mpi
287 ```
288 One can also specify which Blas/Lapack implementation to use. For example to build deal.II suite with `atlas` run
289 ```
290 spack install dealii ^atlas
291 ```
292
293 ### Compiler flags
294 You can specify compiler flags on the command line as
295 ```
296 spack install dealii cppflags="-march=native -O3"
297 ```
298 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`:
299 ```
300 compilers:
301 - compiler:
302     modules: []
303     operating_system: centos6
304     paths:
305       cc: /usr/bin/gcc
306       cxx: /usr/bin/g++
307       f77: /usr/bin/gfortran
308       fc: /usr/bin/gfortran
309     flags:
310       cflags: -O3 -fPIC
311       cxxflags: -O3 -fPIC
312       cppflags: -O3 -fPIC
313     spec: gcc@4.7.2
314 ```
315
316 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:
317 ```
318 spack install --only dependencies dealii
319 spack install dealii cppflags="-march=native -O3"
320 ```
321
322 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.
323
324 ### Different versions coexisting:
325 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
326 ```
327 spack install dealii@develop+mpi+petsc~int64%gcc ^petsc+complex~hypre
328 ```
329 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.
330
331 One can use `environment-modules` (see above) to automatically set `DEAL_II_DIR` to the complex version: 
332 ```
333 spack load dealii@develop+mpi+petsc~int64%gcc ^petsc+complex~hypre
334 ```
335
336 ### Filesystem Views:
337 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):
338 ```
339 spack view -v symlink dealii_suite dealii@develop
340 ```
341 You can also add to this view other packages, i.e.
342 ```
343 spack view -v symlink dealii_suite the-silver-searcher
344 ```
345
346
347 ### Check before build:
348 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. 
349 ```
350 spack spec dealii@develop+mpi+petsc~int64%gcc ^petsc+complex~hypre
351 ```
352
353 ### Develop using Spack
354 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`:
355 ```
356 export DEAL_II_VIEW=/Users/davydden/spack/_dealii_suite
357 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 ../
358 ```
359 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.
360
361 ### Keep the stage to run unit tests
362 By default, the build folder (aka `stage`) for each package is created in a temporary system dependent location.
363 This gets purge by system on next restart.
364 If you want to keep the stage after the installation, you need to do two things:
365 First, make spack use a custom location for stage by adding the following to your `~/.spack/config.yaml`:
366 ```
367 config:
368   build_stage:
369     - $spack/var/spack/stage
370 ```
371 Second, prescribe an extra argument to `install` command to keep the stage after successful installation:
372 ```
373 spack install --keep-stage dealii@develop
374 ```
375
376 ### MKL and Licensed software
377 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:
378
379 1. add `Intel` license file as `license.lic` file to `${SPACK_ROOT}/etc/spack/licenses/intel/`.
380 2. run `spack install dealii ^intel-mkl@11.3.2.210`
381
382
383 ### Freeze package versions
384 Currently Spack does not try to re-use already installed packages. On another hand, by default
385 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.
386
387 To circumvent the problem, the user can specify preferred versions of packages in `~/.spack/packages.yaml`:
388 ```
389 packages:
390   cmake:
391     version: [3.6.1]
392   curl:
393     version: [7.50.3]
394   openssl:
395     version: [1.0.2j]
396   python:
397     version: [2.7.12]
398 ```
399 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.