Skip to content

Commit

Permalink
Merge pull request #2 from nschloe/remove-raw-html
Browse files Browse the repository at this point in the history
Remove raw html
  • Loading branch information
nschloe authored Sep 9, 2016
2 parents 59a848f + acd4944 commit b6125db
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 27 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION=$(shell python -c "import frentos; print(frentos.__version__)")
VERSION=$(shell grep '__version__ = ' setup.py | sed 's/[^0-9]*\([0-9\.]*\).*/\1/')

# Make sure we're on the master branch
ifneq "$(shell git rev-parse --abbrev-ref HEAD)" "master"
Expand Down
33 changes: 9 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ frontend to [gmsh](http://gmsh.info/)) and
### Examples

#### A simple ball
<p align="center">
<img src="https://nschloe.github.io/frentos/ball.png"/>
</p>
![Ball](https://nschloe.github.io/frentos/ball.png)
```python
import frentos

Expand Down Expand Up @@ -72,9 +70,7 @@ frentos.generate_mesh(
```

#### Other primitive shapes
<p align="center">
<img src="https://nschloe.github.io/frentos/tetra.png"/>
</p>
![Tetrahedron](https://nschloe.github.io/frentos/tetra.png)

frentos provides out-of-the-box support for balls, cuboids, ellpsoids, tori,
cones, cylinders, and tetrahedra. Try for example
Expand All @@ -93,9 +89,7 @@ frentos.generate_mesh(
```

#### Domain combinations
<p align="center">
<img src="https://nschloe.github.io/frentos/ball-difference.png"/>
</p>
![Balls difference](https://nschloe.github.io/frentos/ball-difference.png)

Supported are unions, intersections, and differences of all domains. As
mentioned above, however, the sharp intersections between two domains are not
Expand Down Expand Up @@ -140,9 +134,7 @@ of the mesh generation. This makes sure that it fits in nicely with the rest of
the mesh.

#### Domain deformations
<p align="center">
<img src="https://nschloe.github.io/frentos/egg.png"/>
</p>
![Egg](https://nschloe.github.io/frentos/egg.png)

You can of coure translate, rotate, scale, and stretch any domain. Try, for
example,
Expand All @@ -162,9 +154,7 @@ frentos.generate_mesh(
```

#### Extrusion of 2D polygons
<p align="center">
<img src="https://nschloe.github.io/frentos/triangle-rotated.png"/>
</p>
![triangle rotated](https://nschloe.github.io/frentos/triangle-rotated.png)

frentos lets you extrude any polygon into a 3D body. It even supports
rotation alongside!
Expand All @@ -191,9 +181,7 @@ Feature edges are automatically preserved here, which is why an edge length
needs to be given to `frentos.Extrude`.

#### Rotation bodies
<p align="center">
<img src="https://nschloe.github.io/frentos/circle-rotate-extr.png"/>
</p>
![triangle ring extruded](https://nschloe.github.io/frentos/circle-rotate-extr.png)

Polygons in the x-z-plane can also be rotated around the z-axis to yield a
rotation body.
Expand All @@ -213,9 +201,8 @@ frentos.generate_mesh(
```

#### Your own custom level set function
<p align="center">
<img src="https://nschloe.github.io/frentos/heart.png"/>
</p>
![triangle ring extruded](https://nschloe.github.io/frentos/heart.png)

If all of the variety is not enough for you, you can define your own custom
level set function. You simply need to subclass `frentos.DomainBase` and
specify a function, e.g.,
Expand Down Expand Up @@ -265,9 +252,7 @@ documention](http://doc.cgal.org/latest/Surface_mesher/index.html) for the
options.

#### Meshes from OFF files
<p align="center">
<img src="https://nschloe.github.io/frentos/elephant.png"/>
</p>
![elephant](https://nschloe.github.io/frentos/elephant.png)

If you have an OFF file at hand (like
[elephant.off](https://raw.githubusercontent.com/CGAL/cgal-swig-bindings/master/examples/data/elephant.off)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import os
import codecs

__version__ = '0.1.1'
__version__ = '0.1.2'
__license__ = 'MIT License'
__author__ = 'Nico Schlömer'
__email__ = '[email protected]'
Expand Down
2 changes: 1 addition & 1 deletion src/frentos.i
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%module(directors="1") frentos

%pythoncode %{
__version__ = '0.1.1'
__version__ = '0.1.2'
__license__ = 'MIT License'
__author__ = 'Nico Schlömer'
__email__ = '[email protected]'
Expand Down

0 comments on commit b6125db

Please sign in to comment.