Commit 05e5cc3b authored by Lars Bilke's avatar Lars Bilke Committed by Dmitry Yu. Naumov

[web] Fixed markdownlint issues.

Mainly:

- syntax hint for fenced code blocks
- Alt text for images
- Header mismatches
parent ace3d020
......@@ -2,3 +2,4 @@ comment: OpenGeoSys rules
default: true
line-length: false
no-inline-html: false
no-duplicate-heading: false
releases/
docs/tools/workflows/Example-of-a-DGM-to-model-workflow/index.pandoc
docs/userguide/process-dependent-configuration/Heat_Transport_BHE.pandoc
docs/benchmarks/python-bc/laplace-equation/python-laplace-eq.pandoc
......@@ -13,32 +13,27 @@ author = "Wenqing Wang"
{{< data-link >}}
-------------------------------------------------------------------------
Following up the benchmark about the BGRa creep model described on the
[this page](https://www.opengeosys.org/docs/benchmarks/creepbgra/creepbrga/),
this example represents the creep in the near field of
drift in the deep rock salt after excavation. The domain and the
geometry are shown in the following figure:
<figure>
<img src="../mesh.png" alt="Mesh and Geometry" id="fig_6"
style="height:400px;width:490px;">
<figcaption>Mesh and Geometry.</figcaption>
</figure>
![Mesh and Geometry.](../mesh.png){ width=66% .m-auto }
The domain has two material groups, which are highlighted by different
colors. The material group that is in the
top part of the domain represents a cap rock type, while the other
material group is for rock salt. The material properties of the rocks are given in the following table:
---------------------- ---------- ----------- ------------
| |Cap rock | Rock salt| Unit|
| --- |:---------:| -----:|----:|
|Density | 2000 | 2170 | kg/m$^{3}$|
|Young’s Modulus | 7.0 | 7.65 | GPa |
|Poisson ratio | 0.3 | 2.7 | - |
|Thermal conductivity | 5 | 5 | W/(mK) |
---------------------- ---------- ----------- ------------
---
The parameters of the BGRa creep model are $A=0.18\, \mbox{d}^{-1}$,
$m=5$, $Q=54 \mbox{ kJ/mol}$ for the rock salt. For the cap rock, $A$ is set to zero.
......@@ -122,6 +117,6 @@ For the automatic benchmarking, the time duration of creep is reduced to 50 days
If one wants to test this benchmark for 1000 days' creep, please change the end time in the tag of `<t_end>`
in the project file as
```
```xml
<t_end>86400.0e+3</t_end>
```
......@@ -22,8 +22,7 @@ by experiments, $Q$ is called activation energy,
$R_u=8.314472 \mbox{J/(Kmol)}$ is the universal gas constant, and
${ \sigma}_f$ is a stress scaling factor.
Creep potential and creep strain
================================
## Creep potential and creep strain
Assume there is a creep potential $g^c$ and the creep induced strain
rate is given by the flow rule
......@@ -58,8 +57,7 @@ derived as $$\begin{gathered}
\dot { \mathbf \epsilon}^c ({ \sigma})={\color{red} {\sqrt{\frac{3}{2}}}}Ae^{-Q/R_uT}\left(\dfrac{{\bar \sigma}}{{ \sigma}_f}\right)^m\dfrac{{\mathbf s}}{{\left\Vert{\mathbf s}\right\Vert}}
\end{gathered}$$
Stress integration
==================
## Stress integration
The above creep strain rate expression can be simplified as $$\begin{gathered}
\dot { \mathbf \epsilon}^c ({ \sigma}) = b {\left\Vert{\mathbf s}\right\Vert}^{m-1} {\mathbf s}
......@@ -115,8 +113,7 @@ of is derived as
\left(\mathcal{I} - \frac{1}{3} \mathbf{I} \otimes \mathbf{I} + (m-1){\left\Vert{\mathbf s}^{n+1}\right\Vert}^{-2} {\mathbf s}^{n+1}\otimes {\mathbf s}^{n+1}\right)
\end{gathered}$$
Consistent tangent
==================
## Consistent tangent
Once the converged stress integration is obtained, the tangential of
stress with respect to strain can be obtained straightforwardly by
......@@ -132,17 +129,16 @@ We see that $$\begin{aligned}
If the model is used for the thermo-mechanical problems and the problems
are solved by the monolithic scheme, the displacement-temperature block
of the global Jacobian can be derived as
$$\begin{aligned}
$$\begin{aligned}
- 2G\dfrac{Q}{R} {{\int}_{\Omega} \dfrac{b}{T^2} {\left\Vert{\mathbf s}^{n+1}\right\Vert}^{m-1} \mathbf{B}^T {\mathbf s}^{n+1} \mathrm{d} \Omega}
\end{aligned}$$
-2G\dfrac{Q}{R} {{\int}_{\Omega} \dfrac{b}{T^2} {\left\Vert{\mathbf s}^{n+1}\right\Vert}^{m-1} \mathbf{B}^T {\mathbf s}^{n+1} \mathrm{d} \Omega}
\end{aligned}
*Note*: The above rate form of stress integration is implemented in ogs6.
Alternatively, one can use a absolute stress integration form, which can be found in the attached
[PDF](../doku_BGRa.pdf).
Example
=======
## Example
We verify the scheme by a one dimensional extension with constant
pressure of ${ \sigma}_0=5 ~\mbox{MPa}$. The values of the parameters are
......@@ -186,8 +182,7 @@ obtained by the present multidimensional scheme with the analytical
solution is shown in the following figure:
{{< img src="../bgra0.png" >}}
Python code
-----------
### Python code
A short python snippet, to compute the values.
<details>
......
......@@ -68,7 +68,7 @@ directly visualized and analysed in paraview for example.
The output on the console will be similar to:
```
```bash
info: ConstantParameter: K
info: ConstantParameter: p0
info: ConstantParameter: p_Dirichlet_left
......
......@@ -72,7 +72,7 @@ computed in the first time step.
The output on the console will be similar to the following one (ignore the spurious error messages "Could not find POINT..."):
```
```bash
error: GEOObjects::getGeoObject(): Could not find POINT "left" in geometry.
error: GEOObjects::getGeoObject(): Could not find POINT "right" in geometry.
info: Initialize processes.
......@@ -104,6 +104,4 @@ A major part of the output was produced by the linear equation solver (LIS in th
<!-- {{< vis path="Elliptic/square_1x1_SteadyStateDiffusion/square_1e2_pcs_0_ts_1_t_1.000000.vtu" >}} -->
The result can be visualized with Paraview.
![](../square_1e2_pcs_0_ts_1_t_1.000000.png)
![The result can be visualized with Paraview.](../square_1e2_pcs_0_ts_1_t_1.000000.png)
......@@ -72,7 +72,7 @@ It will produce some output and write the computed result into the `square_1e2_n
The output on the console will be similar to the following one (ignore the spurious error messages "Could not find POINT..."):
```
```bash
info: This is OpenGeoSys-6 version 6.0.7-619-ge761162.
info: OGS started on 2016-12-05 11:16:47+0100.
info: ConstantParameter: K
......
......@@ -91,13 +91,13 @@ script](https://gitlab.opengeosys.org/ogs/ogs/-/tree/master/Tests/Data/Elliptic/
The script for setting the source terms is referenced in the project file as
follows:
```
```xml
<python_script>sin_x_sin_y_source_term.py</python_script>
```
In the source term descripition
```
```xml
<source_term>
<mesh>square_1x1_quad_1e3_entire_domain</mesh>
<type>Python</type>
......@@ -149,7 +149,7 @@ directly visualized and analysed in paraview for example.
The output on the console will be similar to the following on:
```
```bash
info: This is OpenGeoSys-6 version 6.1.0-1132-g00a6062a2.
info: OGS started on 2018-10-10 09:22:17+0200.
......
......@@ -19,8 +19,7 @@ For large-scale Ground Source Heat Pump (GSHP) systems, it is often coupled with
## Model Setup
OGS {#OGS .unnumbered .unnumbered}
===
### OGS
The BHE used in this Model contains a single U-shape pipe (1U type). The details about its finite element realisation could be found by Diersch et al. (2011). For the subsurface domain, a 50 $\times$ 50 $\times$ 72 $m$ mesh was constructed with prism and line elements. 3 BHEs are situated from -2 $m$ to a depth of -52 $m$ in the subsurface, with an adjacent distance of 6 $m$ from each other. The BHE \#1 and BHE \#3 are located at the left and right side, while the BHE \#2 is installed in the centre. The initial soil temperature of the domain is set with 12 $^\circ$C. The top surface is assumed as Dirichlet boundary condition with a fixed temperature of 12 $^\circ$C over the entire simulation. The detailed input parameters can be found in the 3bhes\_1U.prj file, they are also listed in the following table.
......@@ -43,8 +42,7 @@ The BHE used in this Model contains a single U-shape pipe (1U type). The details
| Length of the BHE U-pipe in network | $l$ | $100$ | $\mathrm{m}$ |
| Roughness coefficient of the pipe | $k_s$ | $0.00001$ | $\mathrm{m}$ |
TESPy {#TESPy .unnumbered .unnumbered}
=====
### TESPy
A closed-loop pipeline network system was constructed in TESPy to be coupled with the OGS model. The TESPy software developed by Francesco Witte is capable of simulating coupled thermal-hydraulic status of the network, which is composed of pre-defined components including pipes, heat exchangers and different types of turbo machinery. Interested readers may refer to the online documentation of TESPy for the details introduction of the software. Figure 1 illustrates the basic configuration of the entire network. After lifted by the pump, the circulating refrigerant inflow will be divided into 3 branches by the splitter and then flow into each BHEs. Because of the pipe network configuration, the inflow temperature on each BHE will be the same. The refrigerant flowing out of the BHEs array will firstly be mixed at the merging point and then being extracted for heat extraction through the heat pump. After that, the refrigerant will be circulated back into the pipe network. For the boundary condition, a constant thermal load of 3750 $W$ is imposed on the heat pump for the entire simulation period, which means an average specific heat extraction rate on each BHE with 25 $W/m$. The total simulation time is 6 months.
......
......@@ -66,7 +66,7 @@ $$
Since the analytical solution has a singularity at $(x, y) = (0, 0)$ the
analytical solution in paraview is generated as follow:
```
```none
if (coordsX^2<0.0001 & coordsY^2<0.0001, temperature, -1/(4*asin(1))*ln(sqrt(coordsX^2+coordsY^2))
```
......
......@@ -13,8 +13,6 @@ title = "Conservative tracer transport with time varying source (1D/2D)"
{{< data-link >}}
# "Conservative tracer transport with time varying source(1D/2D)"
## Overview
This benchmark describes the transport of a conservative tracer through a saturated porous media. Simulations have been performed with OGS-6 and OGS-5 in both, 1D and 2D domains.
......
......@@ -70,6 +70,6 @@ Left side boundary conditions for this setup are pressure $p=1$ and concentratio
{{< img src="../gif/DiffusionAndStorageAndAdvectionAndDecay.gif" title="*Diffusion, Storage, Advection, and Decay*">}}
#### Changes With Inclusion of Non Boussinesq-Effects ####
#### Changes With Inclusion of Non Boussinesq-Effects
The changes to the original setup are described in [this PDF](../HC-NonBoussinesq.pdf).
......@@ -15,7 +15,7 @@ author = "Wenqing Wang"
---
# Consolidation example based on fluid injection and production application
## Consolidation example based on fluid injection and production application
{{< img src="../InjectionProduction.png" >}}
......
......@@ -24,7 +24,7 @@ TimeDependentHeterogeneousParameter for boundary conditions or source terms.
In the parameter specification section of the project file it is possible to add
a parameter type with the type `TimedependentHeterogeneousParameter`.
```
```xml
<parameter>
<name>ParameterForSourceTerm</name>
<type>TimeDependentHeterogeneousParameter</type>
......
......@@ -77,22 +77,22 @@ The basic scenario for the two-dimensional unconfined aquifer:
### Scenario A
* Steady-state model.
* In the north there is a fixed head boundary condition with 15 m.
* The southern boundary has a fixed head boundary condition with 25 m.
* the Specific Yield is set to $S_y = 0.0$
- Steady-state model.
- In the north there is a fixed head boundary condition with 15 m.
- The southern boundary has a fixed head boundary condition with 25 m.
- the Specific Yield is set to $S_y = 0.0$
{{< img src="../Dupuit_Scenario_A.jpg" >}}
### Scenario B
* Like scenario A and additionally
* with an average groundwater recharge rate = 3.54745E-09 m/s
- Like scenario A and additionally
- with an average groundwater recharge rate = 3.54745E-09 m/s
{{< img src="../Dupuit_Scenario_B.jpg" >}}
### Scenario C
* like scenario A but
* with an inflow rate of 4.62963E-05 m3/s per meter at the southern boundary
- like scenario A but
- with an inflow rate of 4.62963E-05 m3/s per meter at the southern boundary
{{< img src="../Dupuit_Scenario_C.jpg" >}}
### Scenario D
......
......@@ -21,8 +21,6 @@ See [this PDF](../Circular_hole.pdf) for detailed problem description.
## Results and evaluation
Result showing the displacement field:
![](../disc_with_hole_pcs_0_ts_4_t_1.000000.png)
![Result showing the displacement field.](../disc_with_hole_pcs_0_ts_4_t_1.000000.png)
<!-- {{< vis path="Mechanics/Linear/disc_with_hole_pcs_0_ts_4_t_1.000000.vtu" >}} -->
......@@ -42,12 +42,10 @@ The input data set of the element deactivation approach is specified inside the
## Mesh
2D and 3D meshes:
![](../element_deactivation_2D_3D_mesh.png)
![2D and 3D meshes](../element_deactivation_2D_3D_mesh.png){.m-auto}
## Results and evaluation
2D results:
![](../element_deactivation_2D.png)
3D results:
![](../element_deactivation_3D.png)
![2D results](../element_deactivation_2D.png){.m-auto}
![3D results:](../element_deactivation_3D.png){.m-auto}
......@@ -24,4 +24,4 @@ in the external driving forces and suppress the initial equilibration.
Three test cases are showing a full simulation from equilibrium initial state,
a restart with equilibrium, and calculation from non-equilibrium initial state.
![](../non-equilibrium_initial_states.png)
![Non-equilibrium initial states](../non-equilibrium_initial_states.png)
......@@ -13,7 +13,7 @@ weight = 1033
Some of these options are enabled by default ("*Defaults* to *ON*") otherwise they must be expicitly set to *ON*.
#### General
### General
CMake switches to enable / disable parts of OGS.
......@@ -26,21 +26,21 @@ CMake switches to enable / disable parts of OGS.
Run the CMake-Gui to see a list of processes.
- `OGS_BUILD_PROCESSES` - A `;`-separated list specifying processes to build. *Defaults* to an *empty string*. This will alter the `OGS_BUILD_PROCESS_X`-options. For e.g. building just the two processes `HT` and `LIE`: `-DOGS_BUILD_PROCESSES="HT;LIE"`. Setting this variable back to an empty string **does not reset** the `OGS_BUILD_PROCESS_X`-options. You can also set it to *OFF* to disable all processes.
#### Debugging
### Debugging
- `CMAKE_BUILD_TYPE` - Defaults to `Debug` which builds with debugging infos, set to `Release` for an optimized build.
- `OGS_PROFILE` - Builds with profiling flags (`-pg`).
- `OGS_CMAKE_DEBUG` - Prints out the values of all defined CMake variables at CMake configuration time.
#### Optimization
### Optimization
- `CMAKE_BUILD_TYPE` - Set to `Release` to build with optimization flags, set to `Debug` for debugging.
#### Testing
### Testing
- `OGS_COVERAGE` - Enables code coverage measurements with gcov/lcov. TODO
#### Advanced options
### Advanced options
- `OGS_CXX_FLAGS` - Appends user-given compiler flags. Note that existing (CMake-given) flags are not replaced.
- `OGS_ADDITIONAL_SUBMODULES_TO_CHECKOUT` - Specifies optional submodules which are checked out at CMake-time.
......
......@@ -23,7 +23,7 @@ Docker images can be created by [Dockerfiles](https://docs.docker.com/reference/
To build an image by yourself create a Dockerfile:
```
```bash
FROM ubuntu:17.10
RUN ...
......
......@@ -51,7 +51,7 @@ git remote set-url upstream https://gitlab.opengeosys.org/ogs/ogs.git
Assuming your personal forks remote is called `origin`:
```
```bash
git remote set-url origin git@gitlab.opengeosys.org:YOUR-USERNAME/ogs.git
```
......
......@@ -24,7 +24,7 @@ Tested on GCC and Clang.
Add the following line to your [ccache config file](https://ccache.samba.org/manual.html#_configuration) which is required for pre-compiled headers:
```
```bash
sloppiness = pch_defines,time_macros
```
......@@ -38,6 +38,6 @@ Set the option `run_second_cpp = true` or `export CCACHE_CPP2=true` to suppress
Just load the module:
```
```bash
module load /global/apps/modulefiles/ccache/3.3.3
```
......@@ -25,8 +25,7 @@ The following explanation is taken from an [in-depth article](https://www.atlass
>
The workflow is summarized in the following image from the [GitHub blog](https://github.com/blog/2042-git-2-5-including-multiple-worktrees-and-triangular-workflows):
![](https://cloud.githubusercontent.com/assets/1319791/8943755/5dcdcae4-354a-11e5-9f82-915914fad4f7.png)
![Git workflow](https://cloud.githubusercontent.com/assets/1319791/8943755/5dcdcae4-354a-11e5-9f82-915914fad4f7.png)
You always **fetch** changes from official repository (called **upstream**), develop on your **local** repository and **push** changes to your server-side repository (called **origin**).
......
......@@ -24,8 +24,7 @@ After the system is done with all these tasks the developer can view build repor
## CI on OGS
All of this automatically kicks in when you open a [Merge Request](../code-reviews) on GitLab. You will notice a pipeline block at the merge request page:
![](../GL_CI_screenshot.png)
![GitLab CI screenshot](../GL_CI_screenshot.png)
Click on the pipeline link or the individual pipeline stage icons (circles) to find out the reason for a failed check. If you add more commits to this merge request all checks are run again.
......
......@@ -41,24 +41,22 @@ __________
<https://www.sourceware.org/gdb/download>
### Screenshot
![](../gdb.png)
![GDB screenshot](../gdb.png)
### Create project files
1. CD to the build directory
2. Generate project files with CMake:
```bash
cmake ../sources/
```
```bash
cmake ../sources/
```
3. Start gdb in graphical mode, without license info (quiet) and with arguments:
```bash
gdb -tui -q --args ./bin/ogs ./path/to/BenchmarkName.prj
```
```bash
gdb -tui -q --args ./bin/ogs ./path/to/BenchmarkName.prj
```
4. Have fun...
......@@ -72,27 +70,25 @@ __________
Choose "Eclipse IDE for C/C++ Developers"
### Screenshot
![](../eclipse.png)
![Eclipse screenshot](../eclipse.png)
### Import Code
1. CD to the build directory
2. Generate project files with CMake:
```bash
cmake -G "Eclipse CDT4 - Unix Makefiles" ../sources/
```
```bash
cmake -G "Eclipse CDT4 - Unix Makefiles" ../sources/
```
3. Open Eclipse and choose *File - Import - Existing Project into Workspace*
4. Select the **build directory** and click Finish (***Attention:*** Make sure to **not** check the option *Copy projects into workspace*!)
5. To provide arguments, you will have to run the project once: *Run - Debug* (running will start building first, if not already done).
6. Then, give arguments via *Run - Debug Configuration - C/C++ Application - ogs*. Choose *Arguments* tab on right side and add your arguments to the line *C/C++ Application*, e.g.
```bash
./path/to/BenchmarkName.prj
```
```bash
./path/to/BenchmarkName.prj
```
7. Start debugging...
......@@ -108,26 +104,24 @@ or
The latter includes already plugins for Fortran, in case you want to cross-compile.
### Screenshot
![](../codeblocks.png)
![Code::Blocks screenshot](../codeblocks.png)
### Import Code
1. CD to the build directory
2. Generate project files with CMake:
```bash
cmake -G "CodeBlocks - Unix Makefiles" ../sources/
```
```bash
cmake -G "CodeBlocks - Unix Makefiles" ../sources/
```
3. *Open an existing project* and choose before created .cbp file
4. Choose your compilation target
5. Give arguments: *Project - Set Programs' Arguments*, select correct target and add *Program arguments* in the bottom
```bash
./path/to/BenchmarkName.prj
```
```bash
./path/to/BenchmarkName.prj
```
6. Rock the show...
......@@ -142,9 +136,7 @@ __________
<https://netbeans.org/downloads>
### Screenshot
![](../netbeans.png)
![NetBeans screenshot](../netbeans.png)
### Import project files
......@@ -156,12 +148,12 @@ __________
6. Give arguments via *Run - Set Project Configuration - Customize*
7. Under *Run*, give *Run Command* on right side:
```bash
"${OUTPUT_PATH}" ./path/to/BenchmarkName.prj
```
```bash
"${OUTPUT_PATH}" ./path/to/BenchmarkName.prj
```
7. When starting debugging, choose correct target
8. Have a great time...
8. When starting debugging, choose correct target
9. Have a great time...
Documentation: <https://netbeans.org/kb/index.html>
......@@ -171,9 +163,7 @@ __________
Download: <https://www.jetbrains.com/clion/>
### Screenshot
![](../clion.png)
![Clion screenshot](../clion.png)
### Import project
......
......@@ -96,7 +96,7 @@ Files belonging directly to a page (e.g. images shown on that same page) should
Bibliography items from *Documentation/bibliography/*.bib can be referenced by their id (always use lowercase ids) with the `bib`-shortcode:
```
```bash
{{< bib "kolditz2012" >}}
```
......@@ -129,7 +129,7 @@ ALGOLIA_WRITE_KEY=XXX node_modules/.bin/hugo-algolia --toml -s
### Link checker
```
```bash
npm install -g @hashicorp/broken-links-checker
hugo
broken-links-checker --path ./public --baseUrl https://www.opengeosys.org
......
......@@ -86,7 +86,7 @@ cmake ../ogs
::: {.note}
#### <i class="far fa-check"></i> Pro Tip: Use the Visual Studio command line
### <i class="far fa-check"></i> Pro Tip: Use the Visual Studio command line
In the Start menu under *Visual Studio 2017* you find a application link to *x64 Native Tools Command Prompt for VS 2017*. This starts a command line setup for Visual Studio 64-bit. When you run CMake commands in this command line the correct generator will be picked up automatically:
......@@ -96,7 +96,7 @@ cmake ../ogs
This even allows for using [Ninja]({{< ref "build-with-ninja.pandoc" >}}) as the build tool which can effectively utilize all CPU cores
#### <i class="far fa-check"></i> Pro Tip 2: Use a better terminal application
### <i class="far fa-check"></i> Pro Tip 2: Use a better terminal application
Use [ConEmu](https://conemu.github.io) for a better terminal experience. It automatically detects all installed terminal applications (e.g. regular Windows cmd.exe, Git shell, VS command lines, ...) and feautures multiple terminals inside tabs.
:::
......
......@@ -103,5 +103,4 @@ git push
If your work is done submit a [merge request](https://gitlab.opengeosys.org/ogs/ogs/-/merge_requests/new).
This workflow is summarized with this picture:
![](https://cloud.githubusercontent.com/assets/1319791/8943755/5dcdcae4-354a-11e5-9f82-915914fad4f7.png)
![Workflow visualization](https://cloud.githubusercontent.com/assets/1319791/8943755/5dcdcae4-354a-11e5-9f82-915914fad4f7.png)
......@@ -16,7 +16,7 @@ weight = 1002
## Setup an account
- Creating a GitLab account can be done by simply using your existing GitHub account: click the GitHub logo (octocat) on the [Gitlab sign-in page](https://gitlab.opengeosys.org/users/sign_in)
![](../gitlab-login.png)
![GitLab login page](../gitlab-login.png)
- You will be redirected to GitHub (please login there) and asked for authorization.
- Your new user account will be blocked at first, please let us know we will unblock it
......
......@@ -16,7 +16,7 @@ weight = 1051
- Create a [new release on GitLab](https://gitlab.opengeosys.org/ogs/ogs/-/tags/new)
- Fill in the message, e.g. "OpenGeoSys Release 6.0.8"
- Fill in the release notes from the Wiki
- Copy release binaries and container images from CI job to Azure OGS storage at https://ogsstorage.blob.core.windows.net/binaries/ogs6/\[tag\]
- Copy release binaries and container images from CI job to Azure OGS storage at <https://ogsstorage.blob.core.windows.net/binaries/ogs6/\[tag\]>
- Create new web release page with generated artifacts
- [Create a release on GitHub](https://github.com/ufz/ogs/releases/new) which in turn creates a [Zenodo release](https://zenodo.org/account/settings/github/repository/ufz/ogs#)
- Create a discourse announcement post
......@@ -20,8 +20,7 @@ The tasks of the CI system are configured in [scripts inside the OGS source code
A CI run consists of a [pipeline](https://docs.gitlab.com/ee/ci/pipelines/) which contains [stages](https://docs.gitlab.com/ee/ci/yaml/#stages) which in turn contain jobs. A job runs a set of instructions (e.g. checking out the source code, building the code, testing the code) on a [runner](https://docs.gitlab.com/runner/).
Each pipeline run is visualized as follows:
![](../GitLab-Pipeline.png)
![GitLab pipeline visualization](../GitLab-Pipeline.png)
Jobs are belong to a stage and each job will get a status (success, warnings, failure). Some jobs are optional (see the gear icon) and can be manually triggered by pressing the play button.
......@@ -33,13 +32,13 @@ The master-branch of the the main repository as well as all merge requests on th
If you want to skip a pipeline run for a push add the `-o ci.skip` git push option. Example:
```
```bash
git push -o ci.skip
```
Or add add `[ci skip]` to the commit message to skip the pipeline for this commit. Example:
```
```bash
git commit -m "Added feature X [ci skip]"
```
......
......@@ -18,19 +18,19 @@ weight = 1043
The compilation especially of the processes in Release-config can be very memory hungry. Using dynamic Eigen shape matrices can reduce memory usage:
```
```bash
cmake . -DOGS_EIGEN_DYNAMIC_SHAPE_MATRICES=ON
```
You should also have at least 8 GB of RAM and even this can be not enough when compiling on multiple cores (which is the default). To build on only one core run the following in your build-directory:
```
```bash
cmake --build . --config Release -j 1
```
If this still fails you can disable building of the failing processes, e.g.:
```
```bash
cmake . -DOGS_BUILD_PROCESS_HT=OFF
cmake --build . --config Release -j 1
```
......@@ -46,7 +46,7 @@ See also: <http://docs.conan.io/en/latest/faq/troubleshooting.html#error-invalid
When your `cmake`-run output looks similar to this:
```
```bash
$ cmake ..
...