Merge pull request #2855 from bilke/versions

More (lib) version requirements

scripts/cmake/ConanSetup.cmake

@@ -25,9 +25,9 @@ endif()
 include(${PROJECT_SOURCE_DIR}/scripts/cmake/conan/conan.cmake)
 
 set(CONAN_REQUIRES
-    boost/1.66.0@conan/stable
-    eigen/3.3.4@conan/stable
-    vtk/8.2.0@bilke/stable
+    boost/${ogs.minimum_version.boost}@conan/stable
+    eigen/${ogs.minimum_version.eigen}@conan/stable
+    vtk/${ogs.tested_version.vtk}@bilke/stable
     CACHE INTERNAL ""
 )
 
@@ -74,9 +74,9 @@ if(OGS_BUILD_GUI)
         zlib/1.2.11
     )
     if(UNIX)
-        set(CONAN_REQUIRES ${CONAN_REQUIRES} qt/5.14.1@bincrafters/stable)
+        set(CONAN_REQUIRES ${CONAN_REQUIRES} qt/${ogs.tested_version.qt.linux}@bincrafters/stable)
     else()
-        set(CONAN_REQUIRES ${CONAN_REQUIRES} qt/5.13.2@bincrafters/stable)
+        set(CONAN_REQUIRES ${CONAN_REQUIRES} qt/${ogs.tested_version.qt.win}@bincrafters/stable)
     endif()
     set(CONAN_OPTIONS ${CONAN_OPTIONS}
         vtk:minimal=False

scripts/cmake/Find.cmake

@@ -59,7 +59,7 @@ find_program(MODULE_CMD modulecmd
 ######################
 ### Find libraries ###
 ######################
-find_package(Boost 1.62.0 REQUIRED)
+find_package(Boost ${ogs.minimum_version.boost} REQUIRED)
 
 set(VTK_COMPONENTS vtkIOXML)
 if(OGS_BUILD_GUI)
@@ -73,10 +73,10 @@ endif()
 if(OGS_USE_MPI)
     set(VTK_COMPONENTS ${VTK_COMPONENTS} vtkIOParallelXML vtkParallelMPI)
 endif()
-find_package(VTK 8.1.2 REQUIRED COMPONENTS ${VTK_COMPONENTS})
+find_package(VTK ${ogs.minimum_version.vtk} REQUIRED COMPONENTS ${VTK_COMPONENTS})
 include(${VTK_USE_FILE})
 
-find_package(Eigen3 3.3.4 REQUIRED)
+find_package(Eigen3 ${ogs.minimum_version.eigen} REQUIRED)
 include_directories(SYSTEM ${EIGEN3_INCLUDE_DIR})
 
 ## pthread, is a requirement of logog ##
@@ -108,7 +108,7 @@ if(OGS_BUILD_GUI)
     if(OGS_USE_CONAN AND UNIX AND NOT APPLE)
         set(QT_MODULES ${QT_MODULES} X11Extras)
     endif()
-    find_package(Qt5 5.2 REQUIRED ${QT_MODULES})
+    find_package(Qt5 ${ogs.minimum_version.qt} REQUIRED ${QT_MODULES})
     cmake_policy(SET CMP0020 NEW)
 endif()
 
@@ -155,7 +155,7 @@ if(OGS_USE_PETSC)
         set(PETSC_EXECUTABLE_RUNS YES)
     endif()
 
-    find_package(PETSc REQUIRED)
+    find_package(PETSc ${ogs.minimum_version.petsc} REQUIRED)
 
     include_directories(SYSTEM ${PETSC_INCLUDES})
 

web/config.toml

@@ -45,20 +45,25 @@ disableKinds = ["taxonomyTerm"]
   identifier = "testing"
   weight = 3
 
+[[menu.devguide]]
+  name = "Documentation"
+  identifier = "documentation"
+  weight = 4
+
 [[menu.devguide]]
   name = "Advanced"
   identifier = "advanced"
-  weight = 4
+  weight = 5
 
 [[menu.devguide]]
   name = "Troubleshooting"
   identifier = "troubleshooting"
-  weight = 5
+  weight = 6
 
 [[menu.devguide]]
   name = "Procedures"
   identifier = "procedures"
-  weight = 6
+  weight = 7
 
 # Benchmarks sidebar top-level categories
 [[menu.benchmarks]]

web/content/docs/devguide/advanced/third-party-libraries.pandoc

@@ -19,13 +19,13 @@ We strongly recommend to simply use [Conan]({{< ref "conan.pandoc" >}}) for hand
 
 The following libraries are required:
 
-- [Boost](http://www.boost.org/) >= 1.56.0
-- [Eigen](http://eigen.tuxfamily.org/) >= 3.2.9
-- [VTK](https://www.vtk.org/) >= 7.1.0
+- [Boost](http://www.boost.org/) >= {{< dataFile "versions.minimum_version.boost" >}}
+- [Eigen](http://eigen.tuxfamily.org/) >= {{< dataFile "versions.minimum_version.eigen" >}}
+- [VTK](https://www.vtk.org/) >= {{< dataFile "versions.minimum_version.vtk" >}}
 
 If you want to build the Data Explorer you need these too:
 
-- [Qt](https://www.qt.io/) >= 5.9.2
+- [Qt](https://www.qt.io/) >= {{< dataFile "versions.minimum_version.qt" >}}
 - [Shapelib](http://shapelib.maptools.org) >= 1.3.0
 - [libgeotiff](https://trac.osgeo.org/geotiff/) >= 1.4.2
 

web/README.md → web/content/docs/devguide/documentation/introduction.pandoc

++++
+date = "2018-02-23T15:28:13+01:00"
+title = "Introduction"
+author = "Lars Bilke"
+weight = 1024
+
+[menu]
+  [menu.devguide]
+    parent = "documentation"
++++
+
 ## The big picture
 
-- Development related content such as developer guide, benchmark documentation, tools description, ... will be simple Markdown files in e.g. [/web/content/docs](https://www.opengeosys.org/docs/benchmarks/elliptic/elliptic-neumann)
-- You can preview documentation locally with [Hugo](https://gohugo.io) – a static site generator
-- You can [mark](https://github.com/bilke/ogs/blob/web-hugo/ProcessLib/GroundwaterFlow/CMakeLists.txt#L80) benchmarks to be automatically and interactively visualized [in the documentation](https://github.com/bilke/ogs/commit/d4fc7d94a3821a6b4483a1d7aeaabd6ee391c449#diff-2f5b1ac2a759aa09b2d3f5cc1ece45ceR108) inside your [browser](https://www.opengeosys.org/docs/benchmarks/elliptic/elliptic-neumann/#results-and-evaluation) via [vtk.js](https://kitware.github.io/vtk-js/)! 🍻 CURRENTLY DISABLED!
+- Development related content such as developer guide, benchmark documentation, tools description, ... are simple Markdown files in e.g. [/web/content/docs](https://www.opengeosys.org/docs/benchmarks/elliptic/elliptic-neumann)
+- You can preview documentation locally with [Hugo](https://gohugo.io) – a static site generator (minimum version: {{< dataFile "versions.minimum_version.hugo" >}})
 
 ## Requirements
 
-- Download [Hugo](https://github.com/gohugoio/hugo/releases/latest) and put it in your `PATH`. **Attention:** Use the *extended* version: e.g. `hugo_extended_0.60.1_Windows-64bit.zip`
+- Download [Hugo](https://github.com/gohugoio/hugo/releases/latest) and put it in your `PATH`. **Attention:** Use the *extended* version: e.g. `hugo_extended_{{< dataFile "versions.minimum_version.hugo" >}}_Windows-64bit.zip`
 - [Install Pandoc](https://pandoc.org/installing.html)
 - Install [Yarn](https://yarnpkg.com/en/docs/install); for downloading required JavaScript & CSS development packages
 
@@ -15,7 +25,7 @@
 - Inside the source-directory `ogs/web`:
   - Run `yarn` once (this will install required css and js packages)
   - Run `hugo server`
-  - Open http://localhost:1313
+  - Open [http://localhost:1313](http://localhost:1313)
 
 As you make modifications to the site it will be rebuild and the page in the browser gets reloaded.
 
@@ -74,32 +84,6 @@ The path to the image can be absolute (by preceding with `/`) or relative. The r
 
 See the [Pandoc Help](https://pandoc.org/MANUAL.html#images) for more options on e.g. image size and captions.
 
-#### Visualizations
-
-CURRENTLY DISABLED!
-
-Use shortcode `vis`:
-
-```go
-{{< vis path="Elliptic/square_1x1_GroundWaterFlow/square_1e2_pcs_0_ts_1_t_1.000000.vtu" [height="300"] >}}
-```
-
-`path` is relative to `ogs/web/static/vis/` and points to a converted data set, see below.
-
-Optional parameters:
-
-- `height` - In px
-
-----
-
-You can convert VTK output files to vtk.js format with:
-
-```bash
-npm run convert -- -e -i vtk-file.vtu -o output/path
-```
-
-Run `npm run convert` to get a list of possible arguments.
-
 #### Equations
 
 Equations can be set with typical LaTeX syntax by using [MathJax](https://www.mathjax.org/). Blocks are defined by `$$` at the beginning and `$$` at the end of the block. Inline math uses one `$` as the delimiter. For more usage instructions see the [MathJax LaTeX help](http://docs.mathjax.org/en/latest/tex.html).
@@ -110,11 +94,8 @@ Files belonging directly to a page (e.g. images shown on that same page) should
 
 #### Bibliography references
 
-Bibliography items from *Documentation/bibliography.bib* can be referenced by their id with the `bib`-shortcode:
+Bibliography items from *Documentation/bibliography.bib* can be referenced by their id with the [`bib`-shortcode](https://github.com/ufz/ogs/blob/f0ebe2e5c9507039a6776c7cb2989a35790bce2f/web/content/docs/benchmarks/bgr_verification_examples/thermomechanics.pandoc#L42-L46).
 
-```go
-{{< bib id="Kolditz2012" >}}
-```
 
 The bib-file has to be converted into a json-file with the [pandoc-citeproc](https://github.com/jgm/pandoc-citeproc)-tool:
 
@@ -129,10 +110,6 @@ This json-file is then used by the shortcode.
 
 ## Advanced topics
 
-### Optional requirements
-
-- Install [ParaView](http://www.paraview.org/download/); for converting VTK output files to vtk.js-format for interactive web visualization, check if `pvpython` is either in the `PATH` or ParaView is installed in `/Applications/` on macOS or `/usr/local/opt/paraview` on Linux. CURRENTLY DISABLED!
-
 ### Update search index
 
 ```bash
@@ -143,7 +120,6 @@ ALGOLIA_WRITE_KEY=XXX node_modules/.bin/hugo-algolia --toml -s
 
 - [Hugo](https://gothugo.com) - Web site generator
 - [Tailwind](https://tailwindcss.com/docs/what-is-tailwind) - CSS framework
-- [vtk.js](https://kitware.github.io/vtk-js/) - 3D Visualizations, CURRENTLY DISABLED!
 - [FontAwesome](https://fontawesome.com) - Icons, see [icon search](https://fontawesome.com/icons?d=gallery)
 - [Slick Carousel](http://kenwheeler.github.io/slick/) & [FancyBox](https://fancyapps.com/fancybox/3/) for image galleries
 - [Algolia](https://github.com/algolia/algoliasearch-client-javascript) for site search

web/content/docs/devguide/getting-started/prerequisites.pandoc

@@ -15,7 +15,7 @@ The minimum prerequisites to build OGS are:
 
 - An 64-bit operating system (Linux, Windows 7 and up, macOS)
 - Git (version control tool, at least version {{< dataFile "versions.minimum_version.git" >}})
-- CMake (build configuration tool, at least version 3.12)
+- CMake (build configuration tool, at least version {{< dataFile "versions.minimum_version.cmake" >}})
 - A compiler with [C++17](http://en.wikipedia.org/wiki/C%2B%2B17)-support
 - [Conan package manager](https://www.conan.io/) (at least version {{< dataFile "versions.minimum_version.conan" >}}) **OR** install [required libraries]({{< ref "third-party-libraries.pandoc" >}}) manually (for advanced users only!)
 
@@ -88,7 +88,7 @@ Please check if Git is already installed:
 
 ```bash
 $ git --version
-git version 1.7.4.1
+git version {{< dataFile "versions.minimum_version.git" >}}
 ```
 
 Otherwise please install Git with your favorite package manager:

web/data/versions.json

@@ -8,6 +8,20 @@
       "toolset": "141"
     },
     "conan": "1.21.0",
-    "git": "2.14"
+    "git": "2.14",
+    "cmake": "3.12",
+    "hugo": "0.64.1",
+    "boost": "1.66.0",
+    "eigen": "3.3.4",
+    "vtk": "8.1.2",
+    "petsc": "3.8.3",
+    "qt": "5.12.4"
+  },
+  "tested_version": {
+    "vtk": "8.2.0",
+    "qt": {
+      "linux": "5.14.1",
+      "win": "5.13.2"
+    }
   }
 }