Metadata-Version: 2.4
Name: beamz
Version: 0.3.1
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: anywidget>=0.9.18
Requires-Dist: gdsfactory
Requires-Dist: gdspy>=1.6.0
Requires-Dist: jax>=0.4.0
Requires-Dist: jaxlib>=0.4.0
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: micromode>=0.1.0a5
Requires-Dist: numpy>=1.24.4
Requires-Dist: optax>=0.1.0
Requires-Dist: scikit-image>=0.21.0
Requires-Dist: scipy>=1.10.1
Requires-Dist: shapely>=2.0.6
Requires-Dist: traitlets>=5.14.0
Requires-Dist: xarray>=2024.0.0
Provides-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'
Requires-Dist: ruff>=0.14.0; extra == 'dev'
Requires-Dist: vulture>=2.14; extra == 'dev'
Provides-Extra: gpu
Requires-Dist: torch>=2.6.0; extra == 'gpu'
Provides-Extra: lint
Requires-Dist: ruff>=0.14.0; extra == 'lint'
Requires-Dist: vulture>=2.14; extra == 'lint'
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'
Provides-Extra: ubc
Requires-Dist: ubcpdk==2.7.0; extra == 'ubc'
Description-Content-Type: text/markdown

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

BEAMZ is an **[electromagnetic](https://en.wikipedia.org/wiki/Electromagnetism) simulation** package for photonic chip designers using the **[FDTD](https://en.wikipedia.org/wiki/Finite-difference_time-domain_method) method** written in Jax. It features a **high-level API** for fast prototyping with just a few lines of code, an **inverse design module** for gradient-based optimization using the adjoint method with **[autodiff](https://en.wikipedia.org/wiki/Automatic_differentiation)**.
</div>

```bash
pip install beamz
```

![License](https://img.shields.io/github/license/QuentinWach/beamz)
![Last Update](https://img.shields.io/github/last-commit/QuentinWach/beamz)
[![Tests](https://github.com/QuentinWach/beamz/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/QuentinWach/beamz/actions/workflows/tests.yml)
[![Coverage](https://raw.githubusercontent.com/QuentinWach/beamz/main/.github/badges/coverage.svg)](https://github.com/QuentinWach/beamz/actions/workflows/full-tests.yml)


## Core Features
- **100% Python**, free (MIT license) & open-source.
- Modular architecture with a high-level API.
- **GPU-accelerated** (but CPU-capable).
- Built-in layout flow (GDSII import/export).
- FDTD simulation in 2D and **3D**.
- Absorbing Layers, CPML (WIP), and PEC boundaries.
- **Sub-pixel smoothing** (using super-sampling).
- Gaussian and **mode sources** with TE and TM polarization.
- Custom source time profiles.
- **DFT monitors** and S-parameter extraction workflow for compact modeling.
- Streamlined parametric design module and interactive 3D web-view.
- Optimization/autodiff utilities for gradient-based **inverse-design** with Jax.


## Examples
Read and try out our **[example notebooks](https://beamzorg.github.io/beamz-notebooks/)** or download and run [`examples/` from this repository](https://github.com/beamzorg/beamz/tree/main/examples).


## About
BEAMZ's goal is to become the **pragmatic** FDTD engine of choice for **photonic chip designers**.

It focuses on **streamlined workflows** to produce **useful results** without tedious setup or configuration files. While currently still experimental, this is _not_ a research project with the goal to demo a novel framework we can publish, nor a costly, closed API that hides how it works and gives you no ownership. A **modular architecture** is chosen over a purely object-oriented architecture to **make the code readable and development easy** so that, if there is something that isn't working or missing, you can quickly add it yourself.

If any of this excites you or if have any questions, please open an issue on GitHub. Feel free to fork this project, to suggest or contribute new features, or simply support the project by **giving this repo a star.** Thank you!
