From 05fffb22e4c72c71f48bd0b5c49886d1dcbfcdc9 Mon Sep 17 00:00:00 2001
From: Timo Koch <timokoch@math.uio.no>
Date: Wed, 8 May 2024 15:17:55 +0000
Subject: [PATCH] [doc][gettingstarted] Add shortcut installation
at the beginning of getting started for convenience
---
doc/doxygen/pages/getting-started.md | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/doc/doxygen/pages/getting-started.md b/doc/doxygen/pages/getting-started.md
index 80508ab8d8..b790c56436 100644
--- a/doc/doxygen/pages/getting-started.md
+++ b/doc/doxygen/pages/getting-started.md
@@ -2,9 +2,22 @@
[TOC]
+## Installation
+
+With all basic requirements installed, DuMux can be setup with via a Python script:
+
+```bash
+wget https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/raw/master/bin/installdumux.py
+python3 installdumux.py
+```
+
+This script creates a local folder in which it operates and does not install or modify anything system-wide.
+In case you are unsure about your setup and need more information,
+first read and follow the [installation instructions](installation.md).
+
## Running an example
-For this example it is assumed that you followed the [installation instructions](installation.md) and have a folder with a similar structure:
+For this example it is assumed that you have a folder with a similar structure:
installation folder
|- dune-common
@@ -27,6 +40,8 @@ For this example it is assumed that you followed the [installation instructions]
|- dumux
|...
+You will automatically have such a folder structure if you followed the [installation instructions](installation.md) or used the Python installation script.
+
We want to run an example, in which we first compute a single phase fluid flow field with heterogeneous permeability field, and then run a tracer transport simulation with the computed velocity field. A detailed example description can be found [here](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples).
First, we change to the example's directory:
--
GitLab