Skip to content
Snippets Groups Projects
Commit 87248c41 authored by Kilian Weishaupt's avatar Kilian Weishaupt
Browse files

[handbook] Improve detailed installation instructions

parent cab5d361
No related branches found
No related tags found
1 merge request!198Fix/handbook 2.10
...@@ -107,18 +107,17 @@ on the Dune grid interface, act similar. ...@@ -107,18 +107,17 @@ on the Dune grid interface, act similar.
\paragraph{Obtaining \Dune and \Dumux from software repositories} \paragraph{Obtaining \Dune and \Dumux from software repositories}
Direct access to a software revision control system for downloading code can be of advantage later on. Direct access to a software revision control system for downloading code can be of advantage later on.
It is easier to keep up with code changes and to receive important bug fixes.\Dune and \Dumux use It is easier to keep up with code changes and to receive important bug fixes.\Dune and \Dumux use
Git for their software repositories. To access them a certain programs are needed which Git for their software repositories. To access them a Git client is needed.
is referred to here shortly as Git client.
In the technical language of Git \emph{cloning a certain software version} means nothing more then fetching In the technical language of Git, \emph{cloning a certain software version} means nothing more then fetching
a local copy from the software repository and laying it out in the file system. a local copy from the software repository and laying it out in the file system.
In addition to the software some more files for the use of the software revision In addition to the software, some more files for the use of the software revision
control system itself are created. If you have developer access to \Dumux, it is control system itself are created. If you have developer access to \Dumux, it is
also possible to do the opposite, i.\,e. to load up a modified revision of software also possible to do the opposite, i.\,e. to load up a modified revision of software
into the software repository. This is usually termed as \emph{commit} and \emph{push}. into the software repository. This is usually termed as \emph{commit} and \emph{push}.
The installation procedure is done as follows: The installation procedure is done as follows:
Create a {\Dune} root directory, named \texttt{dune} in the lines below. Create a {\Dune} root directory, named e.g. \texttt{DUNE-ROOT} in the lines below.
Then, enter the previously created directory and check out the desired modules. Then, enter the previously created directory and check out the desired modules.
As you see below, the check-out uses two different servers for getting the sources, As you see below, the check-out uses two different servers for getting the sources,
one for \Dune and one for \Dumux. one for \Dune and one for \Dumux.
...@@ -126,8 +125,8 @@ The \Dune modules of the stable 2.4 release branch are checked out as described ...@@ -126,8 +125,8 @@ The \Dune modules of the stable 2.4 release branch are checked out as described
on the \Dune website \cite{DUNE-DOWNLOAD-GIT}: on the \Dune website \cite{DUNE-DOWNLOAD-GIT}:
\begin{lstlisting}[style=Bash] \begin{lstlisting}[style=Bash]
$ mkdir DUMUX $ mkdir DUNE-ROOT
$ cd DUMUX $ cd DUNE-ROOT
$ git clone -b releases/2.4 https://gitlab.dune-project.org/core/dune-common.git $ git clone -b releases/2.4 https://gitlab.dune-project.org/core/dune-common.git
$ git clone -b releases/2.4 https://gitlab.dune-project.org/core/dune-geometry.git $ git clone -b releases/2.4 https://gitlab.dune-project.org/core/dune-geometry.git
$ git clone -b releases/2.4 https://gitlab.dune-project.org/core/dune-grid.git $ git clone -b releases/2.4 https://gitlab.dune-project.org/core/dune-grid.git
...@@ -137,9 +136,9 @@ $ git clone -b releases/2.3 https://gitlab.dune-project.org/PDELab/dune-typetree ...@@ -137,9 +136,9 @@ $ git clone -b releases/2.3 https://gitlab.dune-project.org/PDELab/dune-typetree
$ git clone -b releases/2.0 https://gitlab.dune-project.org/PDELab/dune-pdelab.git $ git clone -b releases/2.0 https://gitlab.dune-project.org/PDELab/dune-pdelab.git
\end{lstlisting} \end{lstlisting}
The newest and maybe unstable developments are also provided in these repositories and is called \emph{master}. The newest and maybe unstable developments are also provided in these repositories and can be found in the \emph{master} branch.
Please check the \Dune website \cite{DUNE-DOWNLOAD-GIT} for further information. However, the current \Dumux release Please check the \Dune website \cite{DUNE-DOWNLOAD-GIT} for further information. We always try to keep up with the latest developments of \Dune.
is based on the stable 2.4 release and it might not compile without further adaptations using the newest versions of \Dune. However, the current \Dumux release is based on the stable 2.4 release and it might not compile without further adaptations using the newest versions of \Dune.
Furthermore, if you wish to install the optional \Dune Grid-Howto which provides a tutorial Furthermore, if you wish to install the optional \Dune Grid-Howto which provides a tutorial
on the Dune grid interface, act similar. on the Dune grid interface, act similar.
......
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