Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexfikl committed Jul 6, 2024
1 parent 0420142 commit 6c6fdcb
Showing 1 changed file with 11 additions and 20 deletions.
31 changes: 11 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,24 @@ MeshPy: Simplicial Mesh Generation from Python
:target: https://zenodo.org/badge/latestdoi/2757253

MeshPy offers quality triangular and tetrahedral mesh generation for Python.
Meshes of this type are chiefly used in finite-element simulation codes, but
Meshes of this type are mainly used in finite-element simulation codes, but
also have many other applications ranging from computer graphics to robotics.

In order to generate 2D and 3D meshes, MeshPy provides Python interfaces to
three well-regarded mesh generators, `Triangle
<http://www.cs.cmu.edu/~quake/triangle.html>`_ by J. Shewchuk, `TetGen
<http://tetgen.berlios.de/>`_ by Hang Si
The former two are included in the package in slightly modified versions. A
generic mesh reader for the latter is included, as is an easy way to run `gmsh`
from a Python script.
two well-regarded mesh generators: `Triangle
<http://www.cs.cmu.edu/~quake/triangle.html>`__ by J. Shewchuk and `TetGen
<http://tetgen.berlios.de/>`__ by Hang Si. The two are included in the
package in slightly modified versions.

For an interface to `gmsh <http://www.geuz.org/gmsh/>`_ by Christophe Geuzaine
For an interface to `gmsh <http://www.geuz.org/gmsh/>`__, by Christophe Geuzaine
and Jean-Francois Remacle, see `gmsh_interop <https://github.com/inducer/gmsh_interop>`__.

MeshPy has no dependencies other than a C++ compiler,
`pybind11 <https://pybind11.readthedocs.io/en/stable/>`_,
and a working Python installation. Before installing meshpy,
you may install pybind11 using the command::

pip install pybind11

Online resources
================

* `Home page <https://mathema.tician.de/software/meshpy>`_
* `Documentation <http://documen.tician.de/meshpy>`_
* `Source <https://github.com/inducer/meshpy>`_
* `Package index <https://pypi.org/project/MeshPy>`_
* `Discussions <https://github.com/inducer/meshpy/discussions>`_
* `Home page <https://mathema.tician.de/software/meshpy>`__
* `Documentation <http://documen.tician.de/meshpy>`__
* `Source <https://github.com/inducer/meshpy>`__
* `Package index <https://pypi.org/project/MeshPy>`__
* `Discussions <https://github.com/inducer/meshpy/discussions>`__

0 comments on commit 6c6fdcb

Please sign in to comment.