Commit 680f07eb authored by Dennis Gläser's avatar Dennis Gläser
Browse files

Merge branch 'fix/handbook-getting-started' into 'master'

[handbook] Fix path of example and add hint to website guide

See merge request !2666
parents 19cc865a 1a629bb5
Pipeline #4916 canceled with stages
...@@ -102,6 +102,10 @@ to avoid confusing it with the option files which came out of the distribution. ...@@ -102,6 +102,10 @@ to avoid confusing it with the option files which came out of the distribution.
\section{The First Run of a Test Application} \section{The First Run of a Test Application}
\label{quick-start-guide} \label{quick-start-guide}
We recommend the "Getting Started" guide on the \Dumux website: \url{https://dumux.org/gettingstarted/}.
Nevertheless, here is a brief description of how to run a first application.
The previous section showed how to install and compile \Dumux. This section The previous section showed how to install and compile \Dumux. This section
shall give a very brief introduction on how to run a first test application and how shall give a very brief introduction on how to run a first test application and how
to visualize the first output files.\par to visualize the first output files.\par
...@@ -109,7 +113,7 @@ All executable files are compiled in the \texttt{build} sub-directories of \Dumu ...@@ -109,7 +113,7 @@ All executable files are compiled in the \texttt{build} sub-directories of \Dumu
If not specified differently in the options file, this is \texttt{build-cmake} as default. If not specified differently in the options file, this is \texttt{build-cmake} as default.
\begin{enumerate} \begin{enumerate}
\item Enter the folder \texttt{test/porousmediumflow/2p/implicit/incompressible} within your build directory.\\ Type \texttt{make test{\_}2p{\_}incompressible{\_}tpfa} \item Enter the folder \texttt{test/porousmediumflow/2p/incompressible} within your build directory.\\ Type \texttt{make test{\_}2p{\_}incompressible{\_}tpfa}
in order to compile the application\\\texttt{test{\_}2p{\_}incompressible{\_}tpfa}. To run the simulation, in order to compile the application\\\texttt{test{\_}2p{\_}incompressible{\_}tpfa}. To run the simulation,
type \texttt{./test{\_}2p{\_}incompressible{\_}tpfa params.input} type \texttt{./test{\_}2p{\_}incompressible{\_}tpfa params.input}
into the console. into the console.
...@@ -119,7 +123,7 @@ If not specified differently in the options file, this is \texttt{build-cmake} a ...@@ -119,7 +123,7 @@ If not specified differently in the options file, this is \texttt{build-cmake} a
name \texttt{params.input}. name \texttt{params.input}.
\item The simulation starts and produces some VTU output files and also a PVD \item The simulation starts and produces some VTU output files and also a PVD
file. The PVD file can be used to examine time series and summarizes the VTU file. The PVD file can be used to examine time series and summarizes the VTU
files. It is possible to stop a running application by pressing $<$Ctrl$><$c$>$. files. (It is possible to abort a running application by pressing $<$Ctrl$><$c$>$.)
\item You can display the results using the visualization tool ParaView (or \item You can display the results using the visualization tool ParaView (or
alternatively VisIt). Just type \texttt{paraview} in the console and open the alternatively VisIt). Just type \texttt{paraview} in the console and open the
PVD file. On the upper left-hand side, you can choose the desired parameter to be displayed. PVD file. On the upper left-hand side, you can choose the desired parameter to be displayed.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment