Skip to content
Snippets Groups Projects
Commit 063b23f2 authored by Mathis Kelm's avatar Mathis Kelm
Browse files

Merge branch 'cleanup/handbook3.6' into 'master'

Update the handbook for release/3.6.

See merge request !3296
parents a3466204 4842738e
No related branches found
No related tags found
1 merge request!3296Update the handbook for release/3.6.
Pipeline #22322 passed
Pipeline: dumux

#22329

    Pipeline: dumux

    #22328

      Pipeline: dumux-lecture

      #22327

        +4
        ...@@ -42,8 +42,8 @@ ...@@ -42,8 +42,8 @@
        % 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.5} \newcommand{\DumuxVersion}{3.6}
        \newcommand{\DumuxOldVersion}{3.4} \newcommand{\DumuxOldVersion}{3.5}
        \definecolor{dumuxYellow}{HTML}{E19417} \definecolor{dumuxYellow}{HTML}{E19417}
        \definecolor{dumuxBlue}{HTML}{0C73CF} \definecolor{dumuxBlue}{HTML}{0C73CF}
        \newcommand{\DuneVersion}{2.8} \newcommand{\DuneVersion}{2.8}
        ......
        ...@@ -239,7 +239,7 @@ depending on which modules of \Dune and which external libraries you use. ...@@ -239,7 +239,7 @@ depending on which modules of \Dune and which external libraries you use.
        \section{Backwards Compatibility} \section{Backwards Compatibility}
        \label{sec:backwardscompatibility} \label{sec:backwardscompatibility}
        Dumux Releases are split into major (e.g. 2.0, 3.0) and minor (e.g. 3.1, 3.2, 3.3, 3.4, 3.5) releases. Dumux Releases are split into major (e.g. 2.0, 3.0) and minor (e.g. 3.1, 3.2, ..., \DumuxVersion) releases.
        Major releases are not required to maintain backwards compatibility Major releases are not required to maintain backwards compatibility
        but would provide a detailed guide on updating dependent modules. but would provide a detailed guide on updating dependent modules.
        For each minor release, maintaining backwards compatibility is strongly encouraged and recommended. For each minor release, maintaining backwards compatibility is strongly encouraged and recommended.
        ......
        ...@@ -18,10 +18,13 @@ such that you can see how a model is developed in \Dumux. As a teaser, we've ...@@ -18,10 +18,13 @@ such that you can see how a model is developed in \Dumux. As a teaser, we've
        what I've downloaded."}, you question. what I've downloaded."}, you question.
        The \Dumux course material is available online: The \Dumux course material is available online:
        \url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course}. \par \url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course}. \par
        In order to download this repository, which acts as an additional module to In order to use 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 excecute the following commands to download and execute the corresponding installation script:
        \begin{lstlisting}[style=Bash,escapechar=\%] \begin{lstlisting}[style=Bash,escapechar=\%]
        $ wget https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/raw/releases/%\DumuxVersion%/scripts/install.sh $ wget https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/raw/releases/%\DumuxVersion%/bin/installdumux.py
        $ python3 installdumux.py --dumux-version %\DumuxVersion% --dune-version %\DuneVersion%
        $ python3 dumux/bin/installexternal.py course
        $ ./dune-common/bin/dunecontrol --opts=./dumux/cmake.opts all
        \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
        ......
        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