diff --git a/doc/doxygen/pages/getting-started.md b/doc/doxygen/pages/getting-started.md index 80508ab8d8233b8ccb3c50abd1e250d1005c9ed2..b15552b93b5a40d5215e8740b2feb81acb3c9da7 100644 --- a/doc/doxygen/pages/getting-started.md +++ b/doc/doxygen/pages/getting-started.md @@ -2,9 +2,22 @@ [TOC] +## Getting the code + +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: diff --git a/doc/doxygen/pages/installation.md b/doc/doxygen/pages/installation.md index 57dee4e42d9f8363274871a4a0ddf3deb192e64b..d6715eab79a83eed34a26b2c01dc774881932dd7 100644 --- a/doc/doxygen/pages/installation.md +++ b/doc/doxygen/pages/installation.md @@ -60,6 +60,8 @@ In brief, the script performs the following steps: Note that this process can take several minutes. The next section will guide you through the same process providing the necessary commands for executing each step. +The installation is fully contained in the created folder "dumux". +The script does not modify your system or local environment. ## 2. Manually installing DUNE and Dumux from source