Skip to content
README.rst 1.74 KiB
Newer Older
MeshPy: Simplicial Mesh Generation from Python
==============================================

.. image:: https://gitlab.tiker.net/inducer/meshpy/badges/main/pipeline.svg
Andreas Klöckner's avatar
Andreas Klöckner committed
    :alt: Gitlab Build Status
    :target: https://gitlab.tiker.net/inducer/meshpy/commits/main
.. image:: https://github.com/inducer/meshpy/workflows/CI/badge.svg?branch=main
    :alt: Github Build Status
    :target: https://github.com/inducer/meshpy/actions?query=branch%3Amain+workflow%3ACI
Alexandru Fikl's avatar
Alexandru Fikl committed
.. image:: https://badge.fury.io/py/MeshPy.svg
Andreas Klöckner's avatar
Andreas Klöckner committed
    :alt: Python Package Index Release Page
    :target: https://pypi.org/project/meshpy/
.. image:: https://zenodo.org/badge/2757253.svg
    :alt: Zenodo DOI for latest release
    :target: https://zenodo.org/badge/latestdoi/2757253
Andreas Klöckner's avatar
Andreas Klöckner committed

Andreas Klöckner's avatar
Andreas Klöckner committed
MeshPy offers quality triangular and tetrahedral mesh generation for Python.
Alexandru Fikl's avatar
Alexandru Fikl committed
Meshes of this type are mainly used in finite-element simulation codes, but
Andreas Klöckner's avatar
Andreas Klöckner committed
also have many other applications ranging from computer graphics to robotics.

In order to generate 2D and 3D meshes, MeshPy provides Python interfaces to
Alexandru Fikl's avatar
Alexandru Fikl committed
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.
Andreas Klöckner's avatar
Andreas Klöckner committed

Alexandru Fikl's avatar
Alexandru Fikl committed
For an interface to `gmsh <http://www.geuz.org/gmsh/>`__, by Christophe Geuzaine
Alexandru Fikl's avatar
Alexandru Fikl committed
and Jean-Francois Remacle, see `gmsh_interop <https://github.com/inducer/gmsh_interop>`__.
Andreas Klöckner's avatar
Andreas Klöckner committed
Online resources
================

Alexandru Fikl's avatar
Alexandru Fikl committed
* `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>`__