Metadata-Version: 2.4
Name: beamz
Version: 0.1.19
Summary: EM package to create inverse / generative designs for your photonic devices with ease and efficiency.
Project-URL: Homepage, https://github.com/QuentinWach/beamz
Project-URL: Repository, https://github.com/QuentinWach/beamz
Author-email: Quentin Wach <quentin.wach+beamz@gmail.com>
License: Copyright © 2025 Quentin Wach
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Keywords: electromagnetics,generative design,inverse design,photonics,simulation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: gdspy>=1.6.0
Requires-Dist: jax>=0.4.0
Requires-Dist: jaxlib>=0.4.0
Requires-Dist: matplotlib>=3.7.5
Requires-Dist: numpy>=1.24.4
Requires-Dist: optax>=0.1.0
Requires-Dist: rich>=13.9.4
Requires-Dist: scipy>=1.10.1
Requires-Dist: shapely>=2.0.6
Provides-Extra: dev
Requires-Dist: black>=22.0.0; extra == 'dev'
Requires-Dist: flake8>=4.0.0; extra == 'dev'
Requires-Dist: isort>=5.0.0; extra == 'dev'
Requires-Dist: mkdocs-material>=9.0.0; extra == 'dev'
Requires-Dist: mkdocs>=1.5.0; extra == 'dev'
Requires-Dist: myst-parser>=2.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Provides-Extra: gpu
Requires-Dist: torch>=2.6.0; extra == 'gpu'
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
Requires-Dist: pytest-randomly>=3.0.0; extra == 'test'
Requires-Dist: pytest>=7.0.0; extra == 'test'
Requires-Dist: tidy3d>=2.0.0; extra == 'test'
Description-Content-Type: text/markdown

<div align="left">
<img src="BEAMZ_logo.png" alt="BEAMZ" width="150" align="left" hspace="15" vspace="0"/>

BEAMZ is an **electromagnetic simulation** package using the FDTD method. It features a **high-level API** for fast prototyping with just a few lines of code as well as an **inverse design module** for topology optimization using the adjoint method with **Jax-based autodiff**. Made for (but not limited to) photonic integrated circuits.
</div>

```bash
pip install beamz
```

![PyPI](https://img.shields.io/pypi/v/beamz?color=black)
![License](https://img.shields.io/github/license/QuentinWach/beamz?color=black)
![Last Update](https://img.shields.io/github/last-commit/QuentinWach/beamz?color=black)
![Stargazers](https://img.shields.io/github/stars/QuentinWach/beamz)