# 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": null,
"name": "meow-sim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "eigenmodes, eme, fde, modeling, overlaps, photonics, waveguides",
"author": null,
"author_email": "Floris Laporte <floris.laporte@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ee/7f/104bfb9594b4e57f156f7515c85afda86d939e9b45da60aaf9bc9ba9b54d/meow_sim-0.11.1.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.11.1",
"project_urls": null,
"split_keywords": [
"eigenmodes",
" eme",
" fde",
" modeling",
" overlaps",
" photonics",
" waveguides"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "befd3b9469c233fd506145829c7db2ddf505e1b4c7f3b9dd4d094105a957ff7c",
"md5": "c593b7f590327324c308abb20193e317",
"sha256": "4919328875c8e4b1838d30d4f05f7e13365aa088dfae23f1b633f0230620ddd4"
},
"downloads": -1,
"filename": "meow_sim-0.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c593b7f590327324c308abb20193e317",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 53051,
"upload_time": "2024-08-04T15:16:57",
"upload_time_iso_8601": "2024-08-04T15:16:57.702472Z",
"url": "https://files.pythonhosted.org/packages/be/fd/3b9469c233fd506145829c7db2ddf505e1b4c7f3b9dd4d094105a957ff7c/meow_sim-0.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee7f104bfb9594b4e57f156f7515c85afda86d939e9b45da60aaf9bc9ba9b54d",
"md5": "fb614137acb434a3e9e3dec5ac51d830",
"sha256": "4e669444c331d73637dbce632ee9d11839a4174483f7d7da5fe1c72d2545d16f"
},
"downloads": -1,
"filename": "meow_sim-0.11.1.tar.gz",
"has_sig": false,
"md5_digest": "fb614137acb434a3e9e3dec5ac51d830",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 49230,
"upload_time": "2024-08-04T15:17:00",
"upload_time_iso_8601": "2024-08-04T15:17:00.518118Z",
"url": "https://files.pythonhosted.org/packages/ee/7f/104bfb9594b4e57f156f7515c85afda86d939e9b45da60aaf9bc9ba9b54d/meow_sim-0.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-04 15:17:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "meow-sim"
}
JSON