Metadata-Version: 2.4
Name: meow-sim
Version: 0.14.1
Summary: Modeling of Eigenmodes and Overlaps in Waveguides
Author-email: Floris Laporte <floris.laporte@gmail.com>
License: Apache Software License
Keywords: eigenmodes,eme,fde,modeling,overlaps,photonics,waveguides
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jax>=0.6.0
Requires-Dist: klujax>=0.4.1
Requires-Dist: matplotlib>=3.0.0
Requires-Dist: numpy>=2.2.0
Requires-Dist: orjson>=3.0.0
Requires-Dist: pydantic>=2.10.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: sax>=0.15.4
Requires-Dist: shapely>=2.1.0
Requires-Dist: tidy3d<2.9.0,>=2.8.0
Requires-Dist: tqdm>=4.67.0
Requires-Dist: trimesh[easy]>=4.6.0
Provides-Extra: dev
Requires-Dist: build>=1.2.0; extra == "dev"
Requires-Dist: gdsfactory>=9.7.0; extra == "dev"
Requires-Dist: griffe>=1.5.6; extra == "dev"
Requires-Dist: ipykernel>=6.29.5; extra == "dev"
Requires-Dist: ipympl>=0.9.0; extra == "dev"
Requires-Dist: ipywidgets>=8.0.0; extra == "dev"
Requires-Dist: mkautodoc>=0.2.0; extra == "dev"
Requires-Dist: mkdocs-autorefs>=1.3.0; extra == "dev"
Requires-Dist: mkdocs-material>=9.6.0; extra == "dev"
Requires-Dist: mkdocs>=1.6.1; extra == "dev"
Requires-Dist: mkdocstrings[python]>=0.27.0; extra == "dev"
Requires-Dist: mkinit>=1.1.0; extra == "dev"
Requires-Dist: nbconvert>=7.16.6; extra == "dev"
Requires-Dist: nbstripout>=0.8.0; extra == "dev"
Requires-Dist: papermill>=2.6.0; extra == "dev"
Requires-Dist: pre-commit>=4.1.0; extra == "dev"
Requires-Dist: pyright>=1.1.0; extra == "dev"
Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
Requires-Dist: pytest-randomly>=3.16.0; extra == "dev"
Requires-Dist: pytest-xdist>=3.6.0; extra == "dev"
Requires-Dist: pytest>=8.3.0; extra == "dev"
Requires-Dist: ruff>=0.9.0; extra == "dev"
Requires-Dist: tbump>=6.0.0; extra == "dev"
Requires-Dist: tmm>=0.2.0; extra == "dev"
Requires-Dist: towncrier>=24.0.0; extra == "dev"
Requires-Dist: nb-clean>=4.0.1; extra == "dev"
Provides-Extra: full
Requires-Dist: gdsfactory>=9.0; extra == "full"
Requires-Dist: gdspy>=1.6.13; extra == "full"
Provides-Extra: gf
Requires-Dist: gdsfactory>=9.0; extra == "gf"
Requires-Dist: gdspy>=1.6.13; extra == "gf"
Dynamic: license-file

# MEOW (0.14.1)

> **M**odeling of **E**igenmodes and **O**verlaps in **W**aveguides

[![PyPI version](https://badge.fury.io/py/meow-sim.svg)](https://badge.fury.io/py/meow-sim)

![MEOW LOGO](docs/assets/logo-small.png)



A simple electromagnetic [EigenMode Expansion (EME)](https://en.wikipedia.org/wiki/Eigenmode_expansion) tool for Python.

## Installation

### Minimal installation
```sh
pip install meow-sim
```

### Full installation
```sh
pip install meow-sim[full]
```

This will include [gdsfactory](https://github.com/gdsfactory/gdsfactory) dependencies.


## Documentation

The documentation is available at
[flaport.github.io/meow](https://flaport.github.io/meow/).


## Contributors

- [@flaport](https://gitub.com/flaport): creator of MEOW
- [@jan-david-black](https://github.com/jan-david-black): fixing mode overlaps and more

## Credits

- [Tidy3D](https://github.com/flexcompute/tidy3d): meow uses the free FDE mode solver from Tidy3D.
- [SAX](https://github.com/flaport/sax): meow uses SAX as its circuit simulator when cascading the overlap S-matrices.
- [klujax](https://github.com/flaport/sax): Although technically an optional backend for SAX, klujax will significantly speed up the final S-matrix calculation of your structures.
- [EMEPy](https://github.com/BYUCamachoLab/emepy): an excellent alternative python-based EME solver with optional neural network mode solver.
- [Rigorous and efficient modeling of wavelength scale photonic components](http://photonics.intec.ugent.be/download/phd_104.pdf): PhD thesis of Peter Bienstman.
