diff --git a/web/content/docs/userguide/basics/5-mins-ogs/index.md b/web/content/docs/userguide/basics/5-mins-ogs/index.md index b6dcca6a03849048f1b8b1e416babd76a460919c..ae079789e02e6d50d982abf2e3254cfcc894ae68 100644 --- a/web/content/docs/userguide/basics/5-mins-ogs/index.md +++ b/web/content/docs/userguide/basics/5-mins-ogs/index.md @@ -3,6 +3,7 @@ date = "2024-12-13T14:30:38" title = "Your first OGS run in 5 minutes" author = "Christoph Lehmann" weight = 11 +toc = true aliases = [ "/docs/userguide/", "/docs/quickstart/", @@ -17,11 +18,8 @@ post = "Download, install and run an OGS benchmark in 5 minutes! No development category = "User" +++ -Being a large software tool, mastering OGS in its entirety is a complex task. -But running your first OGS simulation actually isn't that hard if you start with -one of the many existing test cases. -From there on you can start to learn OGS and adapt the simulation model using -our user guide and [tutorials](/docs/tutorials). +You can run your first OGS simulation in 5 minutes if you start with one of the many existing test cases. +But OGS is a large tool and has much more to offer! It may take some time to master it, but we promise it is worth it. As a simple example we take the [disc with a hole benchmark test case](/docs/benchmarks/small-deformations/linear_disc_with_hole) from our benchmark gallery. @@ -33,41 +31,26 @@ figure...  -## Option 1: OGS binaries - -**That only works on Windows**, because we only offer prebuilt binaries of OGS for -Windows. Users of Linux or Mac can use OGS with Python [(see below)](#python), -or some [container technology](/docs/userguide/basics/container/). - -1. Download the OGS binaries from our [release page](/releases#current). -  -2. [Download](https://gitlab.opengeosys.org/ogs/ogs/-/archive/master/ogs-master.zip?path=Tests/Data/Mechanics/Linear/DiscWithHole) - the disc with hole example zip file from our GitLab server and unzip it. - The zip file contains (in the subdirectory - `Tests/Data/Mechanics/Linear/DiscWithHole`) - the [project file](/docs/userguide/basics/project_file_intro/), - the simulation mesh, - and a file defining the geometries on which boundary conditions are applied. - Its contents can be viewed online [here](https://gitlab.opengeosys.org/ogs/ogs/-/tree/master/Tests/Data/Mechanics/Linear/DiscWithHole). -3. Run OGS: -  -4. View the written output files (`*.pvd`, `*.vtu`), e.g., with [ParaView](https://www.paraview.org/). - -## Option 2: Python {#python} +## Option 1: Python {#python} If you are familiar with Python and have a working Python installation at hand, -you can have an **even simpler TODO** start: +the recommended way to use a pre-built OGS is via Python. +Otherwise, maybe [Option 2](#binaries) might work for you. 1. Create a Python virtual environment and activate it (for more details see [here](/docs/userguide/basics/introduction/)). -2. Install the requirements: `pip install ogstools`. - This will install [OGSTools](https://ogstools.opengeosys.org), our collection - of Python pre- and postprocessing tools, which in turn will pull in as - dependencies [the OGS Python package](https://pypi.org/project/ogs/), +2. Install the python package [OGSTools](https://ogstools.opengeosys.org): + `pip install ogstools`. + It installs the [OpenGeoSys package](https://pypi.org/project/ogs/) + for you and comes with our collection of Python pre- and post-processing + tools and some selected packages that are commonly used together with OGS: [PyVista](https://pyvista.org/) for 3D visualization, [Matplotlib](https://matplotlib.org/), [Pandas](https://pandas.pydata.org/), and [NumPy](https://numpy.org/), among others. + After installing OGSTools, you will have a Python environment ready for the + whole simulation workflow, from setting up simulation and mesh files to data + analysis and creating publication-ready plots. 3. [Download](https://gitlab.opengeosys.org/ogs/ogs/-/archive/master/ogs-master.zip?path=Tests/Data/Mechanics/Linear/DiscWithHole) the disc with hole example zip file from our GitLab server and unzip it. The zip file contains (in the subdirectory @@ -79,7 +62,7 @@ you can have an **even simpler TODO** start: 4. [Download](/docs/benchmarks/small-deformations/linear_disc_with_hole/Linear_Disc_with_hole.ipynb) the Jupyter notebook underlying the [benchmark gallery page](/docs/benchmarks/small-deformations/linear_disc_with_hole) - of the test case. + of this benchmark case. Put the notebook in the same directory as the unzipped project file and mesh from step 3. This directory should contain the following files, now: * `disc_with_hole.gml` @@ -99,3 +82,30 @@ you can have an **even simpler TODO** start: This will run OGS – your first OGS run!  + +## Option 2: OGS binaries {#binaries} + +**That only works on Windows**, because we offer prebuilt binaries of OGS for +Windows only. Users of Linux or Mac can use +[Singularity/Apptainer/Docker images](/docs/userguide/basics/container/) of +OGS. + +1. Download the OGS binaries from our [release page](/releases#current). +  +2. [Download](https://gitlab.opengeosys.org/ogs/ogs/-/archive/master/ogs-master.zip?path=Tests/Data/Mechanics/Linear/DiscWithHole) + the disc with hole example zip file from our GitLab server and unzip it. + The zip file contains (in the subdirectory + `Tests/Data/Mechanics/Linear/DiscWithHole`) + the [project file](/docs/userguide/basics/project_file_intro/), + the simulation mesh, + and a file defining the geometries on which boundary conditions are applied. + Its contents can be viewed online [here](https://gitlab.opengeosys.org/ogs/ogs/-/tree/master/Tests/Data/Mechanics/Linear/DiscWithHole). +3. Run OGS: +  +4. View the written output files (`*.pvd`, `*.vtu`), e.g., with [ParaView](https://www.paraview.org/). + +## Next steps + +Now that you've succeeded with your first OGS run you +can dive deeper into OGS and, e.g., adapt the simulation model using +our user guide and [tutorials](/docs/tutorials).