Skip to main content

GMSH wrapper, with integrated photonics focus

Project description

Meshwell


Docs Tests PiPy

Project is under active development, stay tuned for improved features, documentation, and releases!

Meshwell is a Python wrapper around GMSH that provides:

(1) a Prism class that simplifies, to the point of automating, the definition of solids from arbitrary (multi)polygons with "buffered" extrusions;

(2) a simple API where such Prisms and regular GMSH OCC objects are specified in an ordered dictionary of mesh priority, and whose keys are then used to label the mesh entities and their interfaces unambiguously;

For instance:

See the documentation for more information and examples. If you encounter a big, you can make an issue so we can improve the software over time. Contributions are also welcome, see open issues for current bugs and requested features.

Background

This code was originally developed to define meshes out of the GDSII descriptions of integrated photonic circuits. A particularity of such devices is rich 2.5D topology, featuring multiple layers of smooth curves in the plane and etching profiles vertically. Maxwell's equations (hence the name) are solved on these geometries to study how light propagates. It is also of critical interest to simulate how this is affected under other physical effects that can be resolved through finite-element or finite-volume analysis.

Related projects

  • gdsfactory: open-source plugin-rich layout software; meshwell is the backend to gplugins' gmsh module
  • femwell: open-source scikit-fem based finite-element simulations, with emphasis on photonics
  • DEVSIM: open-source finite-volume simulator, with emphasis on semiconductor TCAD

Other notable GMSH Python interfaces:

  • gmsh: the gmsh Python API itself has significantly improved over the years
  • pygmsh: manipulate Python objects instead of gmsh entity tags
  • objectgmsh: class wrappers around entities
  • gyptis: uses basic gmsh for photonic geometries

Acknowledgements

  • Simon Bilodeau (Princeton): maintainer
  • Helge Gehring (Google X): beta testing, use cases, bug fixes, improvements
  • Joaquin Matres Abril (Google X): code improvements
  • Niko Savola (Google): beta testing, use cases, bug fixes, improvements

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

meshwell-1.3.6.tar.gz (33.3 kB view details)

Uploaded Source

Built Distribution

meshwell-1.3.6-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file meshwell-1.3.6.tar.gz.

File metadata

  • Download URL: meshwell-1.3.6.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for meshwell-1.3.6.tar.gz
Algorithm Hash digest
SHA256 e78e5913531f97a1fc6ac66981faf27b9c07a9eb1bafd44aafdc5fdc64a69ac8
MD5 a6671e2e63f70a07666b214a3db8306a
BLAKE2b-256 73862cdc65a802bc02949e4293be31dfa243e3f8fdc01f8dda0eff6f55309089

See more details on using hashes here.

File details

Details for the file meshwell-1.3.6-py3-none-any.whl.

File metadata

  • Download URL: meshwell-1.3.6-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for meshwell-1.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1e1922be5287e36c086dcd9d459b61609257308878dc0a20f7e5be8c1dc030fe
MD5 132712cdaf1f170d97fc186657e29636
BLAKE2b-256 7a77a868f5b3ee651de1bbe55830f40cfe983024d192c82cb947fe8a3fa47e76

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page