Skip to content
Snippets Groups Projects
Commit 9b9b0218 authored by Melanie Lipp's avatar Melanie Lipp Committed by Katharina Heck
Browse files

[doc][handbook] Change '3.0' to '3.1'.

parent aace6f1b
No related branches found
No related tags found
1 merge request!1717Feature/handbook
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
% Dune and Dumux logo % Dune and Dumux logo
\newcommand{\Dune}{{DUNE}\xspace} \newcommand{\Dune}{{DUNE}\xspace}
\newcommand{\Dumux}{\texorpdfstring{Du\-Mu$^\text{x}$\xspace}{DuMuX\xspace}} \newcommand{\Dumux}{\texorpdfstring{Du\-Mu$^\text{x}$\xspace}{DuMuX\xspace}}
\newcommand{\DumuxVersion}{3.0} \newcommand{\DumuxVersion}{3.1}
\definecolor{dumuxYellow}{HTML}{E19417} \definecolor{dumuxYellow}{HTML}{E19417}
\definecolor{dumuxBlue}{HTML}{0C73CF} \definecolor{dumuxBlue}{HTML}{0C73CF}
......
...@@ -74,17 +74,12 @@ spatial and temporal discretization schemes as well as nonlinear solvers, ...@@ -74,17 +74,12 @@ spatial and temporal discretization schemes as well as nonlinear solvers,
to general concepts for model coupling. to general concepts for model coupling.
Moreover, \Dumux includes ready to use numerical models and a few example applications. Moreover, \Dumux includes ready to use numerical models and a few example applications.
This is the handbook to a new major version update of \Dumux: version 3.0. This is the handbook to a new minor version update of \Dumux: version 3.1.
The release contains considerable improvements and many new features compared to the 2.x versions. The release contains improvements and new features compared to the 3.0 version.
Due to the major update, backwards compatibility with the last release 2.12 cannot be assured. The update is backwards compatible with the last release 3.0.
To facilitate the transition for our users, we have created a To facilitate the transition for our users, we have created a changelog
git wiki entry describing how to update programs from version 2.12 to version 3.0. helping to update programs from version 3.0 to version 3.1, and giving an overview over new capabilities.
It is available online: It is available online:
\url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/wikis/Updating-programs-from-version-2.12-to-version-3.0}. \url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CHANGELOG.md}.
The guide leads in detail through the interface changes from 2.12 to 3.0, We highly recommend all our users to transition with us to the most recent version of \Dumux
concerning the \texttt{Problem} class, the \texttt{SpatialParams} class,
the \texttt{Parameters} and \texttt{Properties}, i.e. the main user interface.
Starting with version 3.0.0, all minor
version updates will certainly be backward compatible again with at least the last minor version.
We highly recommend all our users to transition with us to \Dumux-3.0
and wish everyone a brand-new and exciting simulation experience. and wish everyone a brand-new and exciting simulation experience.
...@@ -60,7 +60,7 @@ $ tar xzvf path_to_tarball_of/dune-geometry-2.6.0.tar.gz ...@@ -60,7 +60,7 @@ $ tar xzvf path_to_tarball_of/dune-geometry-2.6.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-grid-2.6.0.tar.gz $ tar xzvf path_to_tarball_of/dune-grid-2.6.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-istl-2.6.0.tar.gz $ tar xzvf path_to_tarball_of/dune-istl-2.6.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-localfunctions-2.6.0.tar.gz $ tar xzvf path_to_tarball_of/dune-localfunctions-2.6.0.tar.gz
$ tar xzvf path_to_tarball_of/dumux-3.0.tar.gz $ tar xzvf path_to_tarball_of/dumux-3.1.tar.gz
\end{lstlisting} \end{lstlisting}
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
...@@ -92,7 +92,7 @@ $ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-geometry.g ...@@ -92,7 +92,7 @@ $ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-geometry.g
$ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-grid.git $ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-grid.git
$ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-istl.git $ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-istl.git
$ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-localfunctions.git $ git clone -b releases/2.6 https://gitlab.dune-project.org/core/dune-localfunctions.git
$ git clone -b releases/3.0 https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git $ git clone -b releases/3.1 https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git
\end{lstlisting} \end{lstlisting}
The newest and maybe unstable developments of \Dune and \Dumux are also provided in these repositories and can be found in the \emph{master} branch. The newest and maybe unstable developments of \Dune and \Dumux are also provided in these repositories and can be found in the \emph{master} branch.
......
...@@ -21,12 +21,12 @@ The \Dumux course material is available online: ...@@ -21,12 +21,12 @@ The \Dumux course material is available online:
In order to download this repository, which acts as an additional module to In order to download this repository, which acts as an additional module to
the \Dumux base, you can download an installation script with the following command: the \Dumux base, you can download an installation script with the following command:
\begin{lstlisting}[style=Bash] \begin{lstlisting}[style=Bash]
$ wget https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/raw/releases/3.0/scripts/install.sh $ wget https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/raw/releases/3.1/scripts/install.sh
\end{lstlisting} \end{lstlisting}
This script will install \texttt{dumux}, it's Dune dependencies, and the \texttt{dumux-course} This script will install \texttt{dumux}, it's Dune dependencies, and the \texttt{dumux-course}
repository. Within the directory \texttt{dumux-course} there are a series of exercises repository. Within the directory \texttt{dumux-course} there are a series of exercises
and slides describing the previously described examples. \par and slides describing the previously described examples. \par
% %
The \Dumux course will be updated with each \Dumux release. The \Dumux course will be updated with each \Dumux release.
The above script will download the correct version (\textbf{releases/3.0}) of both The above script will download the correct version (\textbf{releases/3.1}) of both
the \texttt{dumux} and \texttt{dumux-course} module. the \texttt{dumux} and \texttt{dumux-course} module.
...@@ -61,4 +61,4 @@ solution scheme is illustrated down to the element level. ...@@ -61,4 +61,4 @@ solution scheme is illustrated down to the element level.
\subsection{Structure -- by Implementation} \subsection{Structure -- by Implementation}
A possible starting point to understand how the above mentioned algorithm is implemented within \Dumux, A possible starting point to understand how the above mentioned algorithm is implemented within \Dumux,
is the example main file is the example main file
\url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/releases/3.0/exercises/exercise-mainfile/exercise_1p_a.cc} \url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/releases/3.1/exercises/exercise-mainfile/exercise_1p_a.cc}
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