Updated deal.II in Spack (markdown)
[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 ## Quick installation
6
7 Add the following to `~/.bash_profile` (or equivalent)
8 ```
9 SPACK_ROOT=/path/to/spack
10 export PATH=$SPACK_ROOT/bin:$PATH
11 ```
12 `SPACK_ROOT` is the destination where you want Spack to be installed (i.e. `/Users/john/spack`).
13
14 Now clone Spack
15 ```
16 git clone https://github.com/llnl/spack.git $SPACK_ROOT
17 ```
18 **Make sure C/C++/Fortran compilers are in path** (if that's not the case or you use macOS, see [below](#install-gcc)),
19 and install the complete deal.II suite
20 ```
21 spack install dealii
22 ```
23 **DONE**! No extra (preliminary) configuration steps are needed on most Linux distributions. Before configuring your project you need to set `DEAL_II_DIR` by 
24 ```
25 export DEAL_II_DIR=$(spack location -i dealii)
26 ```
27 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).
28
29
30 ## Installation example on a cluster (Emmy cluster of RRZE, Erlangen, Germany)
31 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:
32
33 (1) Download spack
34 ```
35 module load git
36 mkdir $WOODYHOME/spack
37 git clone https://github.com/llnl/spack.git $WOODYHOME/spack
38 export PATH=$WOODYHOME/spack/bin:$PATH
39 ```
40 (2) Load `openmpi` and let Spack find GCC compiler which is also loaded as a dependency:
41 ```
42 module load openmpi/2.0.1-gcc
43 spack compiler find
44 ```
45 (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`
46 ```
47 packages:
48   all:
49     compiler: [gcc]
50     providers:
51       mpi: [openmpi]
52       blas: [openblas]
53       lapack: [openblas]
54   python:
55     version: [2.7.12]
56     paths:
57       python@2.7.12: /usr/
58     buildable: False
59   openmpi:
60     version: [2.0.1]
61     paths:
62       openmpi@2.0.1%gcc@4.8.5: /apps/OpenMPI/2.0.1-gcc/
63     buildable: False
64   dealii:
65     version: [develop]
66     variants: ~oce~python
67 ```
68 (4) Now install deal.II:  `spack install dealii`.
69
70
71 ## Environment Modules
72 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
73
74 To add the support for Environment Modules run
75 ```
76 spack install environment-modules
77 ```
78 and then add to `~/.bash_profile` (or equivalent)
79 ```
80 MODULES_HOME=`spack location -i environment-modules`
81 source ${MODULES_HOME}/Modules/init/bash
82 . $SPACK_ROOT/share/spack/setup-env.sh
83 ```
84
85 If you install `deal.II` before setting up environment modules,
86 the module files have to be regenerated
87 ```
88 spack module refresh
89 ```
90
91 Then run
92 ```
93 spack load dealii
94 spack load cmake
95 ```
96 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)`.
97
98 ## System provided packages
99 Spack is flexible to use both self-compiled and system provided packages. 
100 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
101 ```
102 packages:
103   openmpi:
104     version: [1.8.8]
105     paths:
106       openmpi@1.8.8%gcc@6.2.0: /opt/openmpi-1.8.8
107     buildable: False
108 ```
109 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]`.
110
111 One can also specify which packages should be used to provide `mpi`, `blas/lapack` , preferred compilers and preferred variants:
112 ```
113 packages:
114   all:
115     compiler: [gcc,clang]
116     providers:
117       mpi: [openmpi]
118       blas: [openblas]
119       lapack: [openblas]
120     boost:
121       variants: +python
122 ```
123
124 For more elaborated discussion, see [Configuration Files in Spack](http://spack.readthedocs.io/en/latest/configuration.html).
125
126 ## Installing GCC
127 If your system does not provide any Fortran compiler or you want to have the most recent `gcc`,
128 you can install it by
129 ```
130 spack install gcc
131 ```
132
133 Assuming that you configured [Environment Modules](#environment-modules), load `gcc` and let Spack find the newly installed compilers:
134 ```
135 spack load gcc
136 spack compiler find
137 ```
138 Now you can install deal.II with `gcc`
139 ```
140 spack install dealii%gcc
141 ```
142
143 If you are on the mac, read the following instructions on [Mixed Toolchains](http://spack.readthedocs.io/en/latest/getting_started.html#mixed-toolchains).
144
145 On following these instructions, you will be able to install deal.II with clang+gfortran
146 ```
147 spack install dealii%clang
148 ```
149
150 ## Best practices using Spack:
151
152 Spack is complicated and flexible package manager primarily aimed at High-Performance-Computing.
153 Below are some examples of using Spack to build and develop deal.II:
154
155 ### Info:
156 If you are not sure which options a given package has, simply run
157 ```
158 spack info <package>
159 ```
160 The output will contain available versions, variants, dependencies and description:
161 ```
162 $ spack info dealii
163 Package:    dealii
164 Homepage:   https://www.dealii.org
165
166 Safe versions:
167     develop    [git] https://github.com/dealii/dealii.git
168     8.4.1      https://github.com/dealii/dealii/releases/download/v8.4.1/dealii-8.4.1.tar.gz
169     8.4.0      https://github.com/dealii/dealii/releases/download/v8.4.0/dealii-8.4.0.tar.gz
170     8.3.0      https://github.com/dealii/dealii/releases/download/v8.3.0/dealii-8.3.0.tar.gz
171     8.2.1      https://github.com/dealii/dealii/releases/download/v8.2.1/dealii-8.2.1.tar.gz
172     8.1.0      https://github.com/dealii/dealii/releases/download/v8.1.0/dealii-8.1.0.tar.gz
173
174 Variants:
175     Name        Default   Description
176
177     arpack      on        Compile with Arpack and PArpack (only with MPI)
178     doc         off       Compile with documentation
179     gsl         on        Compile with GSL
180     hdf5        on        Compile with HDF5 (only with MPI)
181     metis       on        Compile with Metis
182     mpi         on        Compile with MPI
183     netcdf      on        Compile with Netcdf (only with MPI)
184     oce         on        Compile with OCE
185     p4est       on        Compile with P4est (only with MPI)
186     petsc       on        Compile with Petsc (only with MPI)
187     slepc       on        Compile with Slepc (only with Petsc and MPI)
188     trilinos    on        Compile with Trilinos (only with MPI)
189
190 Build Dependencies:
191     zlib  blas  graphviz  netcdf  arpack-ng  bzip2  cmake  lapack  oce  astyle  boost  trilinos  muparser  p4est  mpi  suite-sparse  tbb  doxygen  hdf5  slepc  numdiff  metis  petsc  netcdf-cxx  gsl
192
193 Link Dependencies:
194     zlib  blas  graphviz  netcdf  arpack-ng  bzip2  lapack  oce  astyle  boost  trilinos  muparser  p4est  mpi  suite-sparse  tbb  doxygen  hdf5  slepc  numdiff  metis  petsc  netcdf-cxx  gsl
195
196 Run Dependencies:
197     None
198
199 Virtual packages:
200     None
201
202 Description:
203     C++ software library providing well-documented tools to build finite
204     element codes for a broad variety of PDEs.
205 ```
206
207 ### Extra options:
208 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
209 ```
210 spack install dealii@develop+mpi ^boost+python
211 ```
212
213 If you want to specify blas/lapack/mpi implementations, this can be done similarly
214 ```
215 spack install dealii@develop+mpi ^mpich
216 ```
217 To check which packages implement `mpi` run
218 ```
219 spack providers mpi
220 ```
221 One can also specify which Blas/Lapack implementation to use. For example to build deal.II suite with `atlas` run
222 ```
223 spack install dealii ^atlas
224 ```
225
226 ### Different versions coexisting:
227 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
228 ```
229 spack install dealii@develop+mpi+petsc%gcc ^petsc+complex~hypre
230 ```
231 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.
232
233 One can use `environment-modules` (see above) to automatically set `DEAL_II_DIR` to the complex version: 
234 ```
235 spack load dealii%gcc^petsc+complex
236 ```
237
238 ### Filesystem Views:
239 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):
240 ```
241 spack view -v symlink dealii_suite dealii@develop
242 ```
243 You can also add to this view other packages, i.e.
244 ```
245 spack view -v symlink dealii_suite the_silver_searcher
246 ```
247
248
249 ### Check before build:
250 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. 
251 ```
252 spack spec dealii@develop+mpi+petsc%gcc ^petsc+complex~hypre
253 ```
254
255 ### Develop using Spack
256 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`:
257 ```
258 export DEAL_II_VIEW=/Users/davydden/spack/_dealii_suite
259 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 ../
260 ```
261 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.
262
263 ### MKL and Licensed software
264 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:
265
266 1. add the `license.lic` file to `${SPACK_ROOT}/etc/spack/licenses/intel/`.
267 2. manually download Intel MKL archive `l_mkl_11.3.2.181.tgz`
268 3. `cd` to the folder with archive and run `spack install mkl@11.3.2.181`.
269
270 One can then run `spack install dealii ^mkl@11.3.2.181`.
271
272
273 ### Freeze package versions
274 Currently Spack does not try to re-use already installed packages. On another hand, by default
275 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.
276
277 To circumvent the problem, the user can specify preferred versions of packages in `~/.spack/packages.yaml`:
278 ```
279 packages:
280   cmake:
281     version: [3.6.1]
282   curl:
283     version: [7.50.3]
284   openssl:
285     version: [1.0.2j]
286   python:
287     version: [2.7.12]
288 ```
289 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.