Skip to content
Snippets Groups Projects
Commit 178f03cf authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

Merge branch 'feature/remove-INSTALL' into 'master'

Remove outdated INSTALL, point to online resources.

There is no point in keeping one more outdated installation guide.

See merge request !20
parents ce597ff6 1ae95011
No related branches found
No related tags found
1 merge request!31Feature/colebrookwhiteboundarylayer
Why CMake
=========
You can use CMake 2.8.6 or higher as alternative to the build system
provided by DUNE. CMake is included in most GNU/Linux distributions
or can be downloaded at www.cmake.org. Using CMake has several
advantages compared to autotools:
- Out-of-tree builds are the default way to build software: The
directory where the source code resides won't get modified during
compilation.
- Much faster checking of the configuration
- Much simpler to write your own modules
- Better dependency handling
- Less noisy output during compilation
But alas, it comes with a cost:
- Parameters to the compiler are usually not exactly the same as
those picked by DUNE's build system. This might sometimes lead to
problems.
- Dependencies between DUNE modules are not yet handled, i.e. all
DUNE modules on which DuMuX depends (-> common, grid, istl,
geometry, localfunctions) need to be installed already.
Preparing the installation
--------------------------
After installing cmake on your system, make sure that the 'cmake'
executable is in your PATH. To configure the project, create a
new empty directory which will be used to store the files from
the build process and run
cd path/to/empty/build/directory
cmake path/to/DUMUX/source/directory
You might want to set a few parameters if you didn't install the
required libraries system wide. CMake cache variables can be set using
the "-D" command line switch to 'cmake'. The most important paramerters
are probably:
DUNE_DIR Path where all DUNE modules have been compiled and can be
found in subdirectories with the module name
DUNE_common_DIR Path where the DUNE-common module can be found. If there
is a 'dune-common' subdirectory in $DUNE_DIR, this is not
required.
(All other DUNE modules are analogous)
BOOST_ROOT Path where the BOOST libraries from www.boost.org reside.
Usually this is detected automagically.
UG_DIR Location of the UG grid manager
ALUGrid_DIR Location of the ALUGrid grid manager
METIS_DIR Location of the METIS graph partioning library (required
for the parallel version of ALUGrid)
CMAKE_BUILD_TYPE Type of build. Either 'debug' or 'release', default is
'release'.
If this was successfull, the project can be build by
make
Finally, install everything:
make install
Examples
========
cd path/to/empty/build/directory
cmake -DCMAKE_BUILD_TYPE=debug \
-DDUNE_DIR=/usr/local/dune/ \
-DUG_DIR=/usr/local/ug \
-DALUGrid_DIR=/usr/local/alugrid \
-DMETIS_DIR=/usr/local/metis \
path/to/DUMUX/source/directory
You might want to specify the compiler explicitly
by using the cmake options -DCMAKE_CXX_COMPILER and -DCMAKE_C_COMPILER.
What is DUMUX? What is DUMUX?
============== ==============
DuMuX [0] is a simulation toolbox mainly aimed at flow and transport DuMuX [0] is a simulation toolbox mainly aimed at flow and transport
processes in porous media. DuMuX is build on top of the DUNE [1] processes in porous media. DuMuX is build on top of the DUNE [1]
framework and aims to provide a multitude of numerical models as well framework and aims to provide a multitude of numerical models as well
as flexible discretization methods for complex non-linear phenomena, as flexible discretization methods for complex non-linear phenomena,
such as CO2 sequestration, soil remediation, drug delivery in cancer such as CO2 sequestration, soil remediation, drug delivery in cancer
therapy and more. Multi-scale and multi-physics methods are currently therapy and more. Multi-scale and multi-physics methods are currently
actively worked on. See [2] for a more detailed description of the actively worked on. See [2] for a more detailed description of the
goals and motivations behind DuMuX. goals and motivations behind DuMuX.
INSTALLATION INSTALLATION
============ ============
There are two ways to install DuMuX: The first is to use the DUNE's Have a look at the installation guide [3] or use the DuMuXhandbook
build system, the other is to use CMake. If you just want to evaluate [4], chapter 2.
DuMuX, we recommend to compile DuMuX the DUNE way as outlined in the
INSTALL file. On the other hand, if you would like to develop with
DuMuX, using the CMake based build system has advantages like much
faster configure runs and out-of-tree builds. In this case, follow the
instructions from INSTALL.cmake.
LICENSE LICENSE
...@@ -28,14 +23,14 @@ LICENSE ...@@ -28,14 +23,14 @@ LICENSE
DuMuX is licensed under the terms and conditions of the GNU General DuMuX is licensed under the terms and conditions of the GNU General
Public License (GPL) version 2 or - at your option - any later Public License (GPL) version 2 or - at your option - any later
version. The GPL can be read online [3], or in the COPYING file version. The GPL can be read online [5], or in the COPYING file
provided in the topmost directory of the DuMuX source code tree. provided in the topmost directory of the DuMuX source code tree.
Please note that DuMuX's license, unlike DUNE, does NOT feature a Please note that DuMuX's license, unlike DUNE, does NOT feature a
template exception to the GNU General Public License. This means that template exception to the GNU General Public License. This means that
you must publish any source code which uses any of the DuMuX header you must publish any source code which uses any of the DuMuX header
files if you want to redistribute your program to third parties. If files if you want to redistribute your program to third parties. If
this is unacceptable to you, please contact us [4, 5] for a commercial this is unacceptable to you, please contact us [6, 7] for a commercial
license. license.
See the file COPYING for full copying permissions. See the file COPYING for full copying permissions.
...@@ -47,6 +42,8 @@ Links ...@@ -47,6 +42,8 @@ Links
[0] http://dumux.org [0] http://dumux.org
[1] http://dune-project.org [1] http://dune-project.org
[2] http://dumux.org/documents/dumux_awrpaper.pdf [2] http://dumux.org/documents/dumux_awrpaper.pdf
[3] http://www.gnu.org/licenses/old-licenses/gpl-2.0.html [3] http://www.dumux.org/installation.php
[4] Bernd Flemisch <bernd@iws.uni-stuttgart.de> [4] http://www.dumux.org/documents/dumux-handbook-2.8.pdf
[5] http://www.hydrosys.uni-stuttgart.de/index.en.php [5] http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
[6] Bernd Flemisch <bernd@iws.uni-stuttgart.de>
[7] http://www.hydrosys.uni-stuttgart.de/index.en.php
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment