Metadata-Version: 2.4
Name: beamz
Version: 0.1.16
Summary: EM package to create inverse / generative designs for your photonic devices with ease and efficiency.
Home-page: https://github.com/QuentinWach/beamz
Author: Quentin Wach
Author-email: Quentin Wach <quentin.wach+beamz@gmail.com>
Project-URL: Homepage, https://github.com/QuentinWach/beamz
Project-URL: Repository, https://github.com/QuentinWach/beamz
Keywords: electromagnetics,photonics,inverse design,generative design,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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.bak
Requires-Dist: numpy>=1.24.4
Requires-Dist: matplotlib>=3.7.5
Requires-Dist: gdspy>=1.6.0
Requires-Dist: scipy>=1.10.1
Requires-Dist: rich>=13.9.4
Requires-Dist: shapely>=2.0.6
Requires-Dist: jax>=0.4.0
Requires-Dist: jaxlib>=0.4.0
Requires-Dist: optax>=0.1.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: isort>=5.0.0; extra == "dev"
Requires-Dist: flake8>=4.0.0; extra == "dev"
Requires-Dist: myst-parser>=2.0.0; extra == "dev"
Requires-Dist: mkdocs>=1.5.0; extra == "dev"
Requires-Dist: mkdocs-material>=9.0.0; extra == "dev"
Provides-Extra: gpu
Requires-Dist: torch>=2.6.0; extra == "gpu"
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

<div align="left">
<img src="docs/assets/head_icon.png" alt="HEADER" 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)
![Stargazers](https://img.shields.io/github/stars/QuentinWach/beamz)
![Last Update](https://img.shields.io/github/last-commit/QuentinWach/beamz)
