Skip to content

Commit

Permalink
Merge branch 'web-fixes' into 'master'
Browse files Browse the repository at this point in the history
[web] Merge beginner and advanced into user-category

See merge request ogs/ogs!5160
  • Loading branch information
bilke committed Dec 9, 2024
2 parents 725cd56 + f2ae30e commit 9a3b8f1
Show file tree
Hide file tree
Showing 26 changed files with 74 additions and 35 deletions.
Binary file added web/ENVINF-Retreat-2025.pdf
Binary file not shown.
5 changes: 3 additions & 2 deletions web/config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ name = "Data Explorer Manual"
url = "https://gitlab.opengeosys.org/ogs/documentation/data_explorer_manual/-/jobs/artifacts/master/raw/ogsde-man.pdf?job=build"
post = "Manual for the graphical user interface for OpenGeoSys, the Data Explorer."
[menu.docs.params]
category = "Advanced"
category = "User"

[[menu.docs]]
name = "Source code documentation"
Expand All @@ -153,8 +153,9 @@ category = "Developer"
name = "Python tools"
url = "https://ogstools.opengeosys.org/stable/"
post = "<em>ogstools</em> is a collection of Python tools aimed at evolving into a modeling toolchain around OpenGeoSys."
weight = 4
[menu.docs.params]
category = "Advanced"
category = "User"

[security.funcs]
getenv = ['^HUGO_', '^CI_']
2 changes: 1 addition & 1 deletion web/content/docs/benchmarks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ weight = 3
url = "./benchmarks"
post = "Basic benchmarks are explained and input files are provided to get you started in using OGS."
[menu.docs.params]
category = "Beginner"
category = "User"
+++
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
author = "Reza Taherdangkoo, Thomas Nagel, Christoph Butscher"
date = "2020.11.01T14:39:39+01:00"
date = "2020-11-01T14:39:39+01:00"
title = "Drainage Excavation"
project = ["Elliptic/cube_1x1x1_SteadyStateDiffusion/drainage_excavation.prj"]
image = "drainage_excavation.png"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
author = "Reza Taherdangkoo, Thomas Nagel, Markus Barsch, Christoph Butscher"
date = "2020.11.23T14:39:39+01:00"
date = "2020-11-23T14:39:39+01:00"
title = "Hydro-mechanical-drainage_excavation"
project = ["HydroMechanics/Linear/DrainageEexcavation/HMdrainage.prj"]
image = ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
author = "Reza Taherdangkoo, Thomas Nagel, Christoph Butscher"
date = "2020.11.01T14:39:39+01:00"
date = "2020-11-01T14:39:39+01:00"
title = "Drainage Liquid Flow"
project = ["/Parabolic/LiquidFlow/DrainageExcavation/drainage_LiquidFlow.prj"]
image = "drainage_excavation.png"
Expand Down
2 changes: 1 addition & 1 deletion web/content/docs/benchmarks/python-bc/elder/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ The aim of this test is:

## Details

This test is a copy of [this test case]({{< ref "docs/benchmarks/hydro-component/elder_jupyter" >}}).
This test is a copy of [this test case](/docs/benchmarks/hydro-component/elder_jupyter).
Please check the original test case for any details.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
author = "Tymofiy Gerasimov, Dmitri Naumov"
date = "2023-16-6"
date = "2023-06-16"
title = "Fully saturated column deformation and freezing"
project = ["ThermoHydroMechanics/ColumnDeformationFreezing/TM.prj"]
image = "Column_setup.png"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
author = "Tymofiy Gerasimov, Dmitri Naumov"
date = "2023-29-8"
date = "2023-08-29"
title = "Checking the volumetric expansion due to water-to-ice phase change"
project = ["ThermoHydroMechanics/9percentWaterFreezingExpansion/UnitSquare.prj"]
image = "Ice_strain_setup.png"
Expand Down
2 changes: 1 addition & 1 deletion web/content/docs/devguide/advanced/wsl/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2020-05-15T10:46"
date = "2020-05-15"
title = "Windows Subsystem for Linux"
author = "Lars Bilke"
weight = 1063
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2021-03-11T11:37"
date = "2021-03-11T11:37:00"
title = "Introduction to Development Workflows"
author = "Lars Bilke"
weight = 1011
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2021-03-11T11:48"
date = "2021-03-11T11:48:00"
title = "Set Up your fork"
author = "Lars Bilke"
weight = 1013
Expand Down
2 changes: 1 addition & 1 deletion web/content/docs/devguide/packages/cpm/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2021-02-11T10:46"
date = "2021-02-11T10:46:00"
title = "CMake dependency management"
author = "Lars Bilke"
weight = 1041
Expand Down
2 changes: 1 addition & 1 deletion web/content/docs/devguide/packages/mfront/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2021-07-19T11:34"
date = "2021-07-19T11:34:00"
title = "MFront"
author = "Lars Bilke"
weight = 1043
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The following table shows an overview of all input parameters available in the C
| Fluid density | $\rho$ |[kg/m$^{3}$] |[Link](https://doxygen.opengeosys.org/d1/d47/ogs_file_param__material__fluid__density.html) |
| Intrinsic permeability |$\textbf{k}$|[m$^{2}$] | [Link](https://doxygen.opengeosys.org/d5/d06/ogs_file_param__material__porous_medium__permeability.html),[Example](https://gitlab.opengeosys.org/ogs/ogs/-/blob/master/Tests/Data/Parabolic/ComponentTransport/ConTracer/ConTracer_1d.prj) |
| Dynamic viscosity | $\mu$ |[Pa$\cdot$s]|[Link](https://doxygen.opengeosys.org/da/d5d/ogs_file_param__material__fluid__viscosity.html)|
| Gravity vector (specific body force) | $\textbf{g}$|[m/s$^{2}$] | | [Link](https://doxygen.opengeosys.org/db/d19/ogs_file_param__prj__processes__process__componenttransport__specific_body_force)
| Gravity vector (specific body force) | $\textbf{g}$|[m/s$^{2}$] | [Link](https://doxygen.opengeosys.org/db/d19/ogs_file_param__prj__processes__process__componenttransport__specific_body_force) |
| Retardation factor | $R$ |[-] | [Example](https://doxygen.opengeosys.org/d0/d40/ogs_ctest_prj__parabolic__componenttransport__advectiondiffusionsorptiondecay__1d_advectiondiffusionsorptiondecay__prj) |
| First-order decay constant | $\lambda$ |[1/s] | [Example](https://doxygen.opengeosys.org/d0/d40/ogs_ctest_prj__parabolic__componenttransport__advectiondiffusionsorptiondecay__1d_advectiondiffusionsorptiondecay__prj) |

Expand All @@ -87,7 +87,7 @@ In the `ComponentTransport` process, the configuration is as follows.
* `<name>`: name of the chemical component.
* `<type>`: must be `ComponentTransport`.
* `<integration_order>`: This is the order of the integration method for element-wise integration. In common cases set to `2`.
* `<process_variables>`: The primary variables of the `ComponentTransport` process are either `<concentration>` or `<pressure>`. For the variable concentration, the name of the chemical component is given. Like in the following example, there are 3 chemical components, i.e. Si, Al and Cl. The `<pressure>` process' variable is also named 'pressure', see `<process_variables>` section outside of process' definition.
* `<process_variables>`: The primary variables of the `ComponentTransport` process are either `<concentration>` or `<pressure>`. For the variable concentration, the name of the chemical component is given. Like in the following example, there are 3 chemical components, i.e. Si, Al and Cl. The `<pressure>` process' variable is also named 'pressure', see `<process_variables>` section outside of process' definition.

```xml
<processes>
Expand Down Expand Up @@ -140,7 +140,7 @@ Under the keyword `<component>`, the properties of the transported chemical comp

* [Heterogeneous Saturated Mass Transport]({{< relref "hc_ogs6-vs-ogs5" >}})
* [Saturated Mass Transport]({{< relref "saturated-mass-transport" >}})
* [Saturated Variable-Density Flow and Mass Transport (Elder)]({{< relref "docs/benchmarks/hydro-component/elder_jupyter" >}})
* [Saturated Variable-Density Flow and Mass Transport (Elder)](/docs/benchmarks/hydro-component/elder_jupyter)
* [Saturated Variable-Density Flow and Mass Transport (Goswami)]({{< relref "goswami" >}})
* [Theis solution for well pumping]({{< relref "hc_theis" >}})
* [Variable Dependent Boundary Condition]({{< relref "vdbc" >}})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ identifier = "processes"
weight = 5
post = "Get more insight into process-specific configurations."
[menu.docs.params]
category = "Advanced"
category = "User"
+++

## Description
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
author = "Boyan Meng and Haibing Shao"
date = "2021-11-2T18:52:00+01:00"
date = "2021-11-02T18:52:00+01:00"
title = "Overview of Multiphase Flow Processes (without mechanics)"
weight = 3
+++
Expand Down
2 changes: 1 addition & 1 deletion web/content/docs/tools/getting-started/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ identifier = "tools"
weight = 4
post = "Helpful tools for pre- and postprocessing as well as complete model setup workflows."
[menu.docs.params]
category = "Advanced"
category = "User"
+++

Here is an overview of the currently available command line tools, that might help you to construct your OpenGeoSys model. GUI-based tools are available too:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2018-11-14T14:00:13+01`:00"
date = "2018-11-14T14:00:13+01:00"
title = "ParaView on Eve frontends / envinf1"
author = "Lars Bilke"
aliases = ['paraview-on-envinf1']
Expand Down
6 changes: 3 additions & 3 deletions web/content/docs/tools/preprocessing/MeshMapping/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
date = "2023-14-02"
date = "2023-02-14"
title = "MeshMapping"
author = "Julian Heinze"
+++
Expand Down Expand Up @@ -54,7 +54,7 @@ Where:
Mapping the input mesh to a digital elevation model (DEM).
<p align='center'>
<img src = B-z.png width = "30%" height = "30%"> <img src = B-x.png width = "60%" height = "60%" >
<img src = B-z.png width = "30%" height = "30%" alt="B-z"> <img src = B-x.png width = "60%" height = "60%" alt="B-x" >
</p>
<p align = "center">
Fig. 1 Both images show the INPUT mesh from two different point of views. The upper image shows the view along the z-axis. The lower image shows the view along the x-axis.
Expand All @@ -69,7 +69,7 @@ The command above maps the mesh `Berlin.vtu` to the mesh `Berlin_mapped.vtu` acc
Differences can be seen comparing Fig.1 and Fig.2, especially comparing the lower images.
<p align='center'>
<img src = B-map-z.png width = "30%" height = "30%" "test for caption"> <img src = B-map-x-scale10.png width = "60%" height = "60%" >
<img src = B-map-z.png width = "30%" height = "30%" alt="B-map-z"> <img src = B-map-x-scale10.png width = "60%" height = "60%" alt="B-map-x-scale10">
</p>
<p align = "center">
Fig. 2 Both images show the OUTPUT mesh from two different point of views. The upper image shows it viewing along the z-axis. The right image shows it viewing along the x-axis. To increase the visibility of the elevation, z-values are scaled by factor of 10.
Expand Down
2 changes: 1 addition & 1 deletion web/content/docs/tutorials/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ weight = 2
url = "./tutorials"
post = "Learning-by-doing way of gaining experience with OGS and tools commonly used with it."
[menu.docs.params]
category = "Beginner"
category = "User"
+++
2 changes: 1 addition & 1 deletion web/content/docs/userguide/basics/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ identifier = "userguide"
weight = 1
post = "Download, install and run an OGS benchmark in 5 minutes! No development setup required."
[menu.docs.params]
category = "Beginner"
category = "User"
+++

## Installation
Expand Down
33 changes: 33 additions & 0 deletions web/foo.patch
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
diff --git a/scripts/cmake/DependenciesExternalProject.cmake b/scripts/cmake/DependenciesExternalProject.cmake
index 0e1470fe249..87961bcd3b6 100644
--- a/scripts/cmake/DependenciesExternalProject.cmake
+++ b/scripts/cmake/DependenciesExternalProject.cmake
@@ -63,7 +63,9 @@ if(OGS_USE_MFRONT)
set(_py_boost_comp
"python${Python_VERSION_MAJOR}${Python_VERSION_MINOR}"
)
- find_package(Boost ${ogs.minimum_version.boost} COMPONENTS ${_py_boost_comp})
+ find_package(
+ Boost ${ogs.minimum_version.boost} COMPONENTS ${_py_boost_comp}
+ )
if(Boost_${_py_boost_comp}_FOUND)
set(_tfel_cmake_args
"-DPython_ADDITIONAL_VERSIONS=${_py_version_major_minor}"
@@ -270,13 +272,14 @@ if(NOT ZLIB_FOUND)
${build_dir_ZLIB}/${CMAKE_INSTALL_BINDIR}/zlib${_zlib_debug_postfix}${CMAKE_SHARED_LIBRARY_SUFFIX}
)
# requires CMake 3.24 to be effective:
- set(ZLIB_USE_STATIC_LIBS "ON")
- set(ZLIB_ROOT ${build_dir_ZLIB})
+ set(ZLIB_USE_STATIC_LIBS "ON" CACHE BOOL "" FORCE)
+ set(ZLIB_ROOT ${build_dir_ZLIB} CACHE PATH "" FORCE)
# Force local zlib build, found netcdf-installed zlib sometimes
set(ZLIB_LIBRARIES
${build_dir_ZLIB}/${CMAKE_INSTALL_LIBDIR}/zlibstatic${_zlib_debug_postfix}${CMAKE_STATIC_LIBRARY_SUFFIX}
+ CACHE STRING "" FORCE
)
- set(ZLIB_INCLUDE_DIRS ${build_dir_ZLIB})
+ set(ZLIB_INCLUDE_DIRS ${build_dir_ZLIB} CACHE STRING "" FORCE)
endif()
set(_EXT_LIBS ${_EXT_LIBS} ZLIB CACHE INTERNAL "")
endif()
5 changes: 2 additions & 3 deletions web/layouts/docs/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@
{{ .Content }}
</div>

{{ range slice "Beginner" "Advanced" "Developer" }}
{{ range slice "User" "Developer" }}
<div class="mb-12">
<div class="text-xl text-center text-gray-800 font-bold">
<h2>{{ . }}</h2>
</div>
<div class="flex flex-wrap -m-4 p-4">

{{ $num_entries := (where $.Site.Menus.docs "Params.category" .) | len }}
{{ range where $.Site.Menus.docs "Params.category" . }}
<div class="xl:w-1/{{$num_entries}} md:w-1/2 mt-2 px-4 py-2 md:p-4">
<div class="xl:w-1/3 md:w-1/2 mt-2 px-4 py-2 md:p-4">
<a href="{{ .URL }}">
<div class="p-4 bg-gray-100 hover:bg-white rounded-lg shadow h-full">
<h3 class="text-xl mb-2 border-b text-blue-800">
Expand Down
9 changes: 6 additions & 3 deletions web/layouts/partials/releases/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,11 @@ <h2><i class="far fa-download"></i> Downloads</h2>
{{ if eq $type "GitHub" }}
{{ .Content }}
{{ else }}
{{ $urlPre := "https://gitlab.opengeosys.org/api/v4" }}
{{ $release := getJSON $urlPre "/projects/120/releases/" .Params.tag }}
{{ $release.description | markdownify }}
{{ $data := dict }}
{{ $url := print "https://gitlab.opengeosys.org/api/v4/projects/120/releases/" .Params.tag }}
{{ with resources.GetRemote $url }}
{{ $data = . | transform.Unmarshal }}
{{ end }}
{{ $data.description | markdownify }}
{{ end }}
</div>
9 changes: 6 additions & 3 deletions web/layouts/releases/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,12 @@ <h1 id="old"><i class="far fa-archive"></i> Older releases</h1>
<li><a href="{{ .Permalink }}">{{ .Title }}</a>, {{.Params.release_date}}</li>
{{ end }}
{{ end }}
{{ $urlPre := "https://api.github.com" }}
{{ $releases := getJSON $urlPre "/repos/ufz/ogs/releases" }}
{{ range $index, $element := $releases }}
{{ $data := dict }}
{{ $url := "https://api.github.com/repos/ufz/ogs/releases" }}
{{ with resources.GetRemote $url }}
{{ $data = . | transform.Unmarshal }}
{{ end }}
{{ range $index, $element := $data }}
{{ if not (eq $index 0) }}
{{ if and (not .draft) (not .prerelease) }}
<li>
Expand Down

0 comments on commit 9a3b8f1

Please sign in to comment.