Skip to content

Commit

Permalink
Add to readme.md, add dev status
Browse files Browse the repository at this point in the history
  • Loading branch information
m-clare committed Jun 3, 2024
1 parent 6094e76 commit a1c6877
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# CyTriangle - A Python Wrapped Triangle Library via Cython
# CyTriangle
## A Python Wrapped Triangle Library via Cython

![ci-tests](https://github.com/m-clare/cytriangle/actions/workflows/ci.yaml/badge.svg)

*CyTriangle* is an object-oriented python wrapper around Jonathan Richard Shewchuk's [Triangle](https://www.cs.cmu.edu/~quake/triangle.html) library. From its documentation:

"Triangle generates exact Delaunay triangulations, constrained Delaunay triangulations, conforming Delaunay triangulations, Voronoi diagrams, and high-quality triangular meshes. The latter can be generated with no small or large angles, and are thus suitable for finite element analysis."

*CyTriangle* utilizes Cython to provide an object-oriented interface to Triangle to enable easier inspection and modification of triangle objects.
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ keywords = [
"FEA"
]
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Topic :: Scientific/Engineering",
"Natural Language :: English",
Expand Down

0 comments on commit a1c6877

Please sign in to comment.