Commit ce283ebb authored by Dennis Gläser's avatar Dennis Gläser
Browse files

Merge branch 'feature/support-distro-install' into 'master'

Feature/support distro install

See merge request tools/frackit!61
parents d7c80cfc 41e2e001
......@@ -19,7 +19,7 @@ set(CMAKE_BUILD_TYPE Release)
# Find OpenCascade
find_path(OCC_INC "Standard_Version.hxx"
PATH_SUFFIXES opencascade include/opencascade)
PATH_SUFFIXES opencascade include/opencascade occt/)
if (OCC_INC)
include_directories( ${OCC_INC} )
......
......@@ -8,11 +8,11 @@ What is Frackit?
Frackit is an open-source framework for the stochastic generation of fracture networks.
The implementation is written in C++ language and extensively uses
[OpenCascade][2], an open-source Computer Aided Design (CAD) library.
[OpenCASCADE][2], an open-source Computer Aided Design (CAD) library.
The geometric data generated by Frackit can be exported into a number of standard CAD
file formats supported by [OpenCascade][2]. This allows for visualization with a
variety of tools, as for example the [CAD Assistant][3] developed by [OpenCascade][2],
file formats supported by [OpenCASCADE][2]. This allows for visualization with a
variety of tools, as for example the [CAD Assistant][3] developed by [OpenCASCADE][2],
or [Gmsh][1], a three-dimensional finite element mesh generator.
Coupling to [DuMuX][0]
......@@ -98,25 +98,42 @@ Installation
Please note that the following requirements need to be installed:
* OpenCascade (>= 7.3.0) (Note: Testing occurs with 7.3.0, no guarantee to work with higher versions)
* OpenCASCADE (>= 7.3.0) (Note: Testing occurs with 7.3.0, no guarantee to work with higher versions)
* CMake (>3.0)
* C, C++ compiler (C++17 required)
* Optional: Doxygen (>= 1.8)
### Installation of OpenCascade
Frackit requires the [OpenCascade][2] library to be installed on your system.
You can download the source code [HERE][2],
and details on the installation can be found [HERE][10].
Please note that [OpenCascade][2] requires further 3rd party products, which are
listed [HERE][11]. On Debian-based distributions, all of these can be installed
### Installation of OpenCASCADE
Frackit requires parts of the [OpenCASCADE][2] library to be installed on your system.
Thanks to the ["FreeCAD maintainers" team][15], there are Debian packages of
[OpenCASCADE][2] available (see [this link][14]). To install the required packages,
you have to add the repository by typing
```sh
sudo add-apt-repository ppa:freecad-maintainers/occt-releases
sudo apt-get update
```
into the terminal. Then, you can install the packages with
```sh
sudo apt-get install libocct-modeling-algorithms-7.3 libocct-modeling-algorithms-dev libocct-foundation-7.3 libocct-foundation-dev libocct-modeling-data-7.3 libocct-modeling-data-dev
```
If you prefer building [OpenCASCADE][2] from the sources, you can download the
source code [HERE][2], and details on the installation can be found [HERE][10].
Please note that [OpenCASCADE][2] requires further 3rd party products, which are
listed [HERE][11].
<!-- On Debian-based distributions, all of these can be installed
from the command line via:
```cpp
```sh
sudo apt-get install tcllib tklib tcl-dev tk-dev libfreetype-dev libxt-dev libxmu-dev libxi-dev libgl1-mesa-dev libglu1-mesa-dev libfreeimage-dev libtbb-dev libgl2ps-dev
```
``` -->
### Building Frackit under Linux
After [OpenCascade][2] and the other requirements listed above have been installed,
After [OpenCASCADE][2] and the other requirements listed above have been installed,
clone this repository within your folder of choice by typing:
```sh
......@@ -132,7 +149,7 @@ cd build
cmake ../
```
If cmake cannot find your installation of [OpenCascade][2], you probably installed it
If cmake cannot find your installation of [OpenCASCADE][2], you probably installed it
into a non-standard location. In this case, you can define __HINTS__ for cmake to search
for it. In particular, you would have to change the line
......@@ -147,16 +164,16 @@ find_path(OCC_INC "Standard_Version.hxx" HINTS MY_OCC_INCLUDE_FOLDER)
```
in the _CMakeLists.txt_ file of the top folder of Frackit, substituting
MY_OCC_INCLUDE_FOLDER with the path to the source files of [OpenCascade][2]
MY_OCC_INCLUDE_FOLDER with the path to the source files of [OpenCASCADE][2]
on your system. The same has to be done for the required packages of
[OpenCascade][2], i.e. in the line
[OpenCASCADE][2], i.e. in the line
```cmake
find_library(OCC_LIB ${OCC}
PATH_SUFFIXES lib ${OCC_SYS_NAME}/lib ${OCC_SYS_NAME}/vc8/lib)
```
you can define HINTS for cmake to find your installation folder of [OpenCascade][2].
you can define HINTS for cmake to find your installation folder of [OpenCASCADE][2].
Once cmake finished successfully, you could now compile the class documentation:
```sh
......@@ -259,3 +276,5 @@ Advances in Water Resources, 110. doi:10.1016/j.advwatres.2017.10.031
[11]: https://www.opencascade.com/doc/occt-6.9.1/overview/html/occt_dev_guides__building_3rdparty_linux.html
[12]: https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/doc/styleguide.md
[13]: https://git.iws.uni-stuttgart.de/dumux-pub/glaeser2020a
[14]: https://launchpad.net/~freecad-maintainers/+archive/ubuntu/occt-releases
[15]: https://www.freecadweb.org/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment