Skip to main content

A mesh modeling interface to the Gmsh-Python-API

Project description

pypi conda pyver GPL pypiStats

Gmsh is a powerful tool for the generation of meshes for numerical simulations but the built-in scripting language makes the meshing procedure and especially an automatization really hard. Luckily, Gmsh provides a Python-API with which all the capabilites of Gmsh can be used within Python.

GmshModel is intended to be an extendable tool that facilitates the mesh generation by interfacing the Gmsh-Python-API: it provides a basic framework for an automated mesh generation for self-defined model types and, with that, allows to automate the generation of complex models as, e.g., representative volume elements. To this end, gmshModel divides the mesh modeling procedure into basic steps:

  1. Setting up a geometry using basic geometric entities and boolean operations.

  2. Adding the geometric objects to Gmsh, performing boolean operations and defining physical groups.

  3. Creating a mesh with user-defined refinement fields.

  4. Saving the mesh to various output formats.

  5. Visualizing the resulting mesh.

So far, gmshModel is especially designed to automate the generation of representative volume elements that contain multiple inclusion objects and well-known unit cells with different types of inclusions. An extension of gmshModel is, however, possible by adding new geometric objects and model types to the framework.

It is not the purpose of gmshModel to replace the Gmsh scripting language or other great tools such as pygmsh for the generation of meshes. GmshModel rather tries to function as an interface to Gmsh to facilitate the automation of recurring, complex meshing tasks that require the full functionality of Gmsh within a nice and easy to use environment such as Python.


GmshModel is available from the Python Package Index and can be installed using the following command:

$ python3 -m pip install gmshModel

The integration of gmshModel into the conda-forge channel allows to use a similar procedure for Conda users:

$ conda install -c conda-forge gmshModel

It is also possible to download the source code from GitHub or PyPi and install gmshModel manually. For more details, check the installation page of the documentation.


GmshModel is an interface tool and makes use of many great contributions of other people. To experience the full functionality of Gmsh model, the following (non-standard) software packages are required:

  1. a dynamically built Gmsh to use the Gmsh-Python-API

  2. meshio for the conversion of meshes to various output formats

  3. pyvista for the visualization of meshes

  4. pythonocc for the visualization of the model geometry

Getting Started

Sample Geometry and Mesh

To generate the above periodic box in a [20x20x20] domain which contains 200 spherical inclusions of radius 1, simply type:

# import required model type
from gmshModel.Model import RandomInclusionRVE as RVE

# initialize new RVE
myRVE=RVE(size=[20,20,20], inclusionType="Sphere", inclusionSets=[1, 200])

# create Gmsh model

# generate mesh

# save resulting mesh to vtk

# visualize result

# finalize Gmsh-Python-API


The gmshModel documentation is available here.


GmshModel is published under the GPLv3 license

Project details

Download files

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

Source Distribution

gmshModel-1.0.15.tar.gz (87.7 kB view hashes)

Uploaded source

Built Distribution

gmshModel-1.0.15-py3-none-any.whl (80.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page