| 1 |
<!-- |
| 2 |
SPDX-FileCopyrightInfo: Copyright © DUNE Project contributors, see file LICENSE.md in module root |
| 3 |
SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception |
| 4 |
--> |
| 5 |
|
| 6 |
Installation Instructions |
| 7 |
========================= |
| 8 |
|
| 9 |
For a full explanation of the DUNE installation process please read |
| 10 |
the installation notes [0]. The following introduction is meant for |
| 11 |
the impatient. |
| 12 |
|
| 13 |
Getting started |
| 14 |
--------------- |
| 15 |
|
| 16 |
Suppose you have downloaded all DUNE modules of interest to your |
| 17 |
computer and extracted then in one common directory. See [1] for a |
| 18 |
list of available modules. |
| 19 |
|
| 20 |
To compile the modules Dune has to check several components of |
| 21 |
your system and whether prerequisites within the modules are met. For |
| 22 |
the ease of users we have designed a custom build system on top of CMake. |
| 23 |
Run |
| 24 |
|
| 25 |
./dune-common/bin/dunecontrol all |
| 26 |
|
| 27 |
to commence those tests and build all modules you have |
| 28 |
downloaded. Don't worry about messages telling you that libraries are |
| 29 |
missing: they are only needed for grid-self-checks we need for |
| 30 |
developing. |
| 31 |
|
| 32 |
You can customize the build to your specific needs by using an options file |
| 33 |
(see below) |
| 34 |
|
| 35 |
./dune-common/bin/dunecontrol --opts=/path_to/file.opts |
| 36 |
|
| 37 |
If you did not tell dunecontrol to install with an options file you |
| 38 |
need to run |
| 39 |
|
| 40 |
./dune-common/bin/dunecontrol make install |
| 41 |
|
| 42 |
to install Dune (you may need root-permissions for the install |
| 43 |
part depending on the prefix set) |
| 44 |
|
| 45 |
A more comprehensive introduction to the build system can be found in [0]. |
| 46 |
|
| 47 |
Passing options to the build process |
| 48 |
------------------------------------ |
| 49 |
|
| 50 |
Using the dunecontrol script the following atomic commands can be |
| 51 |
executed: |
| 52 |
|
| 53 |
- configure (runs the CMake configuration tests for each module) |
| 54 |
- exec (executes a command in each module source directory) |
| 55 |
- bexec (executes a command in each module build directory) |
| 56 |
- make (builds each module) |
| 57 |
- update (updates the Git or Subversion version) |
| 58 |
|
| 59 |
The composite command all simply runs configure and make for |
| 60 |
each module. |
| 61 |
|
| 62 |
As it is often not convenient to specify the desired options after |
| 63 |
the duncontroll call, one can pass the options via a file specified |
| 64 |
by the --opts=<file> option. Specify the options via the variable |
| 65 |
|
| 66 |
CMAKE_FLAGS=<flags> |
| 67 |
|
| 68 |
An example of an options file is |
| 69 |
|
| 70 |
# use a special compiler (g++ version 5.0), |
| 71 |
# install to a custom directory, default is /usr/local/bin, |
| 72 |
# disable the external library SuperLU, |
| 73 |
# and use Ninja-build instead of make as the build-tool |
| 74 |
CMAKE_FLAGS="-DCMAKE_CXX_COMPILER=g++-5 -DCMAKE_INSTALL_PREFIX='/tmp/HuHu' -DCMAKE_DISABLE_FIND_PACKAGE_SuperLU=true -GNinja" |
| 75 |
|
| 76 |
Links |
| 77 |
----- |
| 78 |
|
| 79 |
0. https://www.dune-project.org/doc/installation |
| 80 |
1. https://www.dune-project.org/releases |