I am looking to implement GMSh into a simualtor that I am going to create. I am looking to integrate the geo, mesh, and post processor modules.

However, looking online, it appears the documentation for the GMSH function calls are non existent. I was wondering if anyone on the forum has ran into some sort of documentation for the program. I do know that this exists but it is not extensive enough: http://gmsh.info/doc/texinfo/gmsh.pdf. From the PDF, it says that the API documentation is not complete. Does a rough draft of the documentation exist somewhere?

AS a side question, what is the practicality of integrating GMSH in a simulator given its current state? Would it be better for me to look off of other open source programs on how they created a basic CAD and mesh package or are there better open source alternatives that I can use? I did find this site: http://www.robertschneiders.de/meshgeneration/software.html and it appears that GMSH is the better tool compared to the others. The only downfall is that GMSH does not have adequate documentation.

Another option is that I could create my own from scratch; however, I do not have the experience nor the background to do this. Unless, someone would be able to provide some really good source material, I might be able to pull it off.


So after talking to the creators of the program, there is no documentation of the API.

  • 1
    $\begingroup$ I would suggest that you keep the pre and post-processor separate from your "simulator" as people usually like to use there own tools for pre and post-processing. $\endgroup$
    – stali
    Feb 15, 2016 at 16:40
  • $\begingroup$ Hey stali, could you explain your comment a little bit more? $\endgroup$
    – philm
    Feb 15, 2016 at 16:53
  • $\begingroup$ Have you also check the html version of the manual? $\endgroup$
    – nicoguaro
    Feb 15, 2016 at 19:59
  • 1
    $\begingroup$ You'll have to use @mention to send a notification. See Markdown help:Comment formatting $\endgroup$
    – Steve
    Feb 18, 2016 at 18:06
  • 1
    $\begingroup$ You could take a look at mshr, which is now part of the FEniCS project, but works as a stand-alone tool if you combine it with MeshIO (which is not possible just yet, I think). It's written in CPP but has a Python interface via SWIG. $\endgroup$ Feb 19, 2016 at 14:50

1 Answer 1


Currently there is a GMSH API in the works:


Also, there are rumors that there will be a fully documented API by version 4.0.

In short, there is no documentation on the functions for GMSH (except for what is in the source all ready). But, they are planning on creating a documented version by GMSH 4.0.



Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Not the answer you're looking for? Browse other questions tagged or ask your own question.