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

.. image:: https://gitlab.tiker.net/inducer/meshpy/badges/master/pipeline.svg
Andreas Klöckner's avatar
Andreas Klöckner committed
    :alt: Gitlab Build Status
    :target: https://gitlab.tiker.net/inducer/meshpy/commits/master
.. image:: https://github.com/inducer/meshpy/workflows/CI/badge.svg?branch=master
    :alt: Github Build Status
    :target: https://github.com/inducer/meshpy/actions?query=branch%3Amaster+workflow%3ACI
Andreas Klöckner's avatar
Andreas Klöckner committed
.. image:: https://badge.fury.io/py/meshpy.png
Andreas Klöckner's avatar
Andreas Klöckner committed
    :alt: Python Package Index Release Page
    :target: https://pypi.org/project/meshpy/
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.
Meshes of this type are chiefly 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
Andreas Klöckner's avatar
Andreas Klöckner committed
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.

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
Andreas Klöckner's avatar
Andreas Klöckner committed

As of Version 0.91.2, MeshPy also works with Python 3.

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.python.org/pypi/MeshPy>`_
* `Mailing list <http://lists.tiker.net/listinfo/meshpy>`_