Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
tools
frackit
Commits
41e2e001
Commit
41e2e001
authored
Feb 06, 2020
by
Dennis Gläser
Browse files
[README] use correct typo of OpenCASCADE
parent
7c9e88e9
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
41e2e001
...
...
@@ -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
[
OpenC
ascade
][
2
]
, an open-source Computer Aided Design (CAD) library.
[
OpenC
ASCADE
][
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
[
OpenC
ascade
][
2
]
. This allows for visualization with a
variety of tools, as for example the
[
CAD Assistant
][
3
]
developed by
[
OpenC
ascade
][
2
]
,
file formats supported by
[
OpenC
ASCADE
][
2
]
. This allows for visualization with a
variety of tools, as for example the
[
CAD Assistant
][
3
]
developed by
[
OpenC
ASCADE
][
2
]
,
or
[
Gmsh
][
1
]
, a three-dimensional finite element mesh generator.
Coupling to [DuMuX][0]
...
...
@@ -98,15 +98,15 @@ Installation
Please note that the following requirements need to be installed:
*
OpenC
ascade
(>= 7.3.0) (Note: Testing occurs with 7.3.0, no guarantee to work with higher versions)
*
OpenC
ASCADE
(>= 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 OpenC
ascade
Frackit requires parts of the
[
OpenC
ascade
][
2
]
library to be installed on your system.
### Installation of OpenC
ASCADE
Frackit requires parts of the
[
OpenC
ASCADE
][
2
]
library to be installed on your system.
Thanks to the
[
"FreeCAD maintainers" team
][
15
]
, there are Debian packages of
[
OpenC
ascade
][
2
]
available (see
[
this link
][
14
]
). To install the required packages,
[
OpenC
ASCADE
][
2
]
available (see
[
this link
][
14
]
). To install the required packages,
you have to add the repository by typing
```
sh
...
...
@@ -120,9 +120,9 @@ into the terminal. Then, you can install the packages with
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
[
OpenC
ascade
][
2
]
from the sources, you can download the
If you prefer building
[
OpenC
ASCADE
][
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
[
OpenC
ascade
][
2
]
requires further 3rd party products, which are
Please note that
[
OpenC
ASCADE
][
2
]
requires further 3rd party products, which are
listed
[
HERE
][
11
]
.
<!-- On Debian-based distributions, all of these can be installed
...
...
@@ -133,7 +133,7 @@ sudo apt-get install tcllib tklib tcl-dev tk-dev libfreetype-dev libxt-dev libxm
```
-->
### Building Frackit under Linux
After
[
OpenC
ascade
][
2
]
and the other requirements listed above have been installed,
After
[
OpenC
ASCADE
][
2
]
and the other requirements listed above have been installed,
clone this repository within your folder of choice by typing:
```
sh
...
...
@@ -149,7 +149,7 @@ cd build
cmake ../
```
If cmake cannot find your installation of
[
OpenC
ascade
][
2
]
, you probably installed it
If cmake cannot find your installation of
[
OpenC
ASCADE
][
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
...
...
@@ -164,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
[
OpenC
ascade
][
2
]
MY_OCC_INCLUDE_FOLDER with the path to the source files of
[
OpenC
ASCADE
][
2
]
on your system. The same has to be done for the required packages of
[
OpenC
ascade
][
2
]
, i.e. in the line
[
OpenC
ASCADE
][
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
[
OpenC
ascade
][
2
]
.
you can define HINTS for cmake to find your installation folder of
[
OpenC
ASCADE
][
2
]
.
Once cmake finished successfully, you could now compile the class documentation:
```
sh
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment