Skip to main content

Python frontend for Gmsh

Project description


CircleCI codecov Code style: black Documentation Status PyPi Version DOI GitHub stars PyPi downloads

Gmsh is a powerful mesh generation tool with a scripting language that is notoriously hard to write.

The goal of pygmsh is to combine the power of Gmsh with the versatility of Python and to provide useful abstractions from the Gmsh scripting language so you can create complex geometries more easily.

See here for the full documentation.


To create the above mesh, simply do

import pygmsh
import numpy as np

geom = pygmsh.built_in.Geometry()

# Draw a cross.
poly = geom.add_polygon([
    [ 0.0,  0.5, 0.0],
    [-0.1,  0.1, 0.0],
    [-0.5,  0.0, 0.0],
    [-0.1, -0.1, 0.0],
    [ 0.0, -0.5, 0.0],
    [ 0.1, -0.1, 0.0],
    [ 0.5,  0.0, 0.0],
    [ 0.1,  0.1, 0.0]

axis = [0, 0, 1]

    point_on_axis=[0, 0, 0],
    angle=2.0 / 6.0 * np.pi

mesh = pygmsh.generate_mesh(geom)
# mesh.points, mesh.cells, ...

to retrieve all points and cells of the mesh for the specified geometry. To store the mesh, you can use meshio; for example

import meshio
meshio.write('test.vtk', mesh)

The output file can be visualized with various tools, e.g., ParaView.

You will find the above mesh in the directory test/ along with other small examples.


As of version 3.0, Gmsh supports OpenCASCADE, allowing for a CAD-style geometry specification.


import pygmsh

geom = pygmsh.opencascade.Geometry(

rectangle = geom.add_rectangle([-1.0, -1.0, 0.0], 2.0, 2.0)
disk1 = geom.add_disk([-1.2, 0.0, 0.0], 0.5)
disk2 = geom.add_disk([+1.2, 0.0, 0.0], 0.5)
union = geom.boolean_union([rectangle, disk1, disk2])

disk3 = geom.add_disk([0.0, -0.9, 0.0], 0.5)
disk4 = geom.add_disk([0.0, +0.9, 0.0], 0.5)
flat = geom.boolean_difference([union], [disk3, disk4])

geom.extrude(flat, [0, 0, 0.3])

mesh = pygmsh.generate_mesh(geom)


pygmsh is available from the Python Package Index, so simply type

pip3 install pygmsh --user

to install.



import pygmsh as pg

and make use of all the goodies the module provides. The documentation and the examples under test/ might inspire you.


To run the pygmsh unit tests, check out this repository and type


Building Documentation

Docs are built using Sphinx.

To build run

sphinx-build -b html doc doc/_build


To create a new release

  1. bump the __version__ number,

  2. publish to PyPi and GitHub:

    $ make publish


pygmsh is published under the MIT license.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pygmsh-5.0.2-py2.py3-none-any.whl (35.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3
pygmsh-5.0.2.tar.gz (33.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page