# meow
> **M**odeling of **E**igenmodes and **O**verlaps in **W**aveguides
A simple electromagnetic [EigenMode Expansion (EME)](https://en.wikipedia.org/wiki/Eigenmode_expansion) tool for Python.
## Installation
### Minimal installation
```sh
pip install meow-sim[min]
```
### Full installation
```sh
pip install meow-sim[full]
```
### Selecting features
You can select which features to enable during installation as follows:
```sh
pip install meow-sim[feature1,feature2,...]
```
#### Available features
* `min`: minimal installation (equivalent to not specifying any features)
* `vis`: explicitly installs matplotlib and trimesh.
* `jax`: use JAX in stead of numpy to calculate the S-matrices
* `klu`: use `klujax` to speed up S-matric calculations (implies `jax`). Note: you need
the SuiteSparse headers on your computer for this to work.
* `gds`: enable GDS creation with GDSFactory (see GDS Taper example).
* `ipy`: install useful jupyter/ipython packages.
* `dev`: install dev dependencies
* `full`: enable all the above features.
## Documentation
- [Examples](https://flaport.github.io/meow/examples.html)
- [API Docs](https://flaport.github.io/meow/meow.html)
## Contributors
- [@flaport](https://gitub.com/flaport): creator of MEOW
- [@jan-david-black](https://github.com/jan-david-black): fixing mode overlaps and more
## Credits
- [DALL-E](https://labs.openai.com): _“a drawing of a kitten with laser eyes walking towards me”_ (logo)
- [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.
Raw data
{
"_id": null,
"home_page": "",
"name": "meow-sim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "eigenmodes,eme,fde,modeling,overlaps,photonics,waveguides",
"author": "Rockley Photonics",
"author_email": "Floris Laporte <floris.laporte@rockleyphotonics.com>",
"download_url": "https://files.pythonhosted.org/packages/92/7d/5f8fea88d36c5650e99db165a3474e3d7a606906187d26f6e20f1d25f03b/meow-sim-0.9.0.tar.gz",
"platform": null,
"description": "# meow\n\n> **M**odeling of **E**igenmodes and **O**verlaps in **W**aveguides\n\n\n\nA simple electromagnetic [EigenMode Expansion (EME)](https://en.wikipedia.org/wiki/Eigenmode_expansion) tool for Python.\n\n## Installation\n\n### Minimal installation\n```sh\npip install meow-sim[min]\n```\n\n### Full installation\n```sh\npip install meow-sim[full]\n```\n\n### Selecting features\nYou can select which features to enable during installation as follows:\n```sh\npip install meow-sim[feature1,feature2,...]\n```\n\n#### Available features\n* `min`: minimal installation (equivalent to not specifying any features)\n* `vis`: explicitly installs matplotlib and trimesh.\n* `jax`: use JAX in stead of numpy to calculate the S-matrices\n* `klu`: use `klujax` to speed up S-matric calculations (implies `jax`). Note: you need\nthe SuiteSparse headers on your computer for this to work.\n* `gds`: enable GDS creation with GDSFactory (see GDS Taper example).\n* `ipy`: install useful jupyter/ipython packages.\n* `dev`: install dev dependencies\n* `full`: enable all the above features.\n\n\n## Documentation\n\n- [Examples](https://flaport.github.io/meow/examples.html)\n- [API Docs](https://flaport.github.io/meow/meow.html)\n\n## Contributors\n\n- [@flaport](https://gitub.com/flaport): creator of MEOW\n- [@jan-david-black](https://github.com/jan-david-black): fixing mode overlaps and more\n\n## Credits\n\n- [DALL-E](https://labs.openai.com): _\u201ca drawing of a kitten with laser eyes walking towards me\u201d_ (logo)\n- [Tidy3D](https://github.com/flexcompute/tidy3d): meow uses the free FDE mode solver from Tidy3D.\n- [SAX](https://github.com/flaport/sax): meow uses SAX as its circuit simulator when cascading the overlap S-matrices.\n- [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.\n- [EMEPy](https://github.com/BYUCamachoLab/emepy): an excellent alternative python-based EME solver with optional neural network mode solver.\n- [Rigorous and efficient modeling of wavelength scale photonic components](http://photonics.intec.ugent.be/download/phd_104.pdf): PhD thesis of Peter Bienstman.\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Modeling of Eigenmodes and Overlaps in Waveguide Structures",
"version": "0.9.0",
"project_urls": null,
"split_keywords": [
"eigenmodes",
"eme",
"fde",
"modeling",
"overlaps",
"photonics",
"waveguides"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9f5b9c48b0e9ae6637e03d287463a363f9cfcd3cf9912d5b3a0dc04a7125e7f",
"md5": "d2713760df1a9b025739ff64a7ff61ed",
"sha256": "805509e9ed3256db47c5c0df973d441593935a5561465c608e221e17485be89b"
},
"downloads": -1,
"filename": "meow_sim-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2713760df1a9b025739ff64a7ff61ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 52612,
"upload_time": "2024-01-19T16:18:56",
"upload_time_iso_8601": "2024-01-19T16:18:56.970868Z",
"url": "https://files.pythonhosted.org/packages/d9/f5/b9c48b0e9ae6637e03d287463a363f9cfcd3cf9912d5b3a0dc04a7125e7f/meow_sim-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "927d5f8fea88d36c5650e99db165a3474e3d7a606906187d26f6e20f1d25f03b",
"md5": "cab7901e273716155405ac0e10836402",
"sha256": "65975b0669641df2a4e16c0547f63077a3ce9af7e6bfba804e6664c8d5a7b0df"
},
"downloads": -1,
"filename": "meow-sim-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "cab7901e273716155405ac0e10836402",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 48762,
"upload_time": "2024-01-19T16:18:59",
"upload_time_iso_8601": "2024-01-19T16:18:59.065390Z",
"url": "https://files.pythonhosted.org/packages/92/7d/5f8fea88d36c5650e99db165a3474e3d7a606906187d26f6e20f1d25f03b/meow-sim-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 16:18:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "meow-sim"
}
JSON