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

[examples] mention python examples in readmes

parent c9081f82
...@@ -92,7 +92,8 @@ A class documentation can be generated from the source code using ...@@ -92,7 +92,8 @@ A class documentation can be generated from the source code using
[Doxygen][8] (see Installation notes). [Doxygen][8] (see Installation notes).
Moreover, the [examples][7] contained in this repository provide a good overview over Moreover, the [examples][7] contained in this repository provide a good overview over
the capabilities of Frackit and can serve as a starting point to develop your own the capabilities of Frackit and can serve as a starting point to develop your own
application. application. While the example descriptions focus on the implementation in c++, python
implementations for all examples are also available in the respective example folders.
Installation Installation
......
...@@ -8,7 +8,9 @@ Example 1 ...@@ -8,7 +8,9 @@ Example 1
In this exemplary application, a network of quadrilateral fractures is generated In this exemplary application, a network of quadrilateral fractures is generated
within the unit cube (see image above). The main file containing the source code within the unit cube (see image above). The main file containing the source code
to this example is the file `example1.cc` which is located in this folder. to this example is the file `example1.cc` which is located in this folder. Note
that this description focuses on the c++ implementation, but in `example1.py`
it is illustrated how to realize this example using the Frackit python bindings.
Two main orientations are considered for the quadrilaterals, for both of which Two main orientations are considered for the quadrilaterals, for both of which
a corresponding instance of the `QuadrilateralSampler` class is created. a corresponding instance of the `QuadrilateralSampler` class is created.
......
...@@ -6,6 +6,10 @@ ...@@ -6,6 +6,10 @@
Example 2 Example 2
========= =========
__Note that this description focuses on the c++ implementation given in the main
file `example2.cc`, but in `example2.py` it is illustrated how to realize this
example using the Frackit python bindings.__
In this exemplary application, a network of quadrilaterals, following the same In this exemplary application, a network of quadrilaterals, following the same
distributions as the network of [example 1][0], is created. However, in this distributions as the network of [example 1][0], is created. However, in this
example we want to confine the network to a cylindrical domain (see image above). example we want to confine the network to a cylindrical domain (see image above).
......
...@@ -6,6 +6,10 @@ ...@@ -6,6 +6,10 @@
Example 3 Example 3
========= =========
__As in the previous examples, this description focuses on the c++ implementation
given in the main file `example3.cc`, but in `example3.py` you can find how to
realize this example using the Frackit python bindings.__
In contrast to the [previous example][0], we now want to create a network within In contrast to the [previous example][0], we now want to create a network within
a complex domain that cannot be represented by the internal geometry classes. a complex domain that cannot be represented by the internal geometry classes.
The domain has been created with [Gmsh][1] and has been saved in .brep file format. The domain has been created with [Gmsh][1] and has been saved in .brep file format.
......
Markdown is supported
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