beamz 0.5.1

BeamZ is a GPU-accelerated electromagnetic simulation framework for photonic chip designers using the FDTD method. It enables fast, large-scale simulations and offers a familiar, high-level API for fast prototyping with just a few lines of code as well as an inverse design module for gradient-based optimization using the adjoint method.

Homepage / Documentation / Example Library

Core Features

• Python-first, free (Apache-2.0 license) & open-source, with a native Rust rasterizer.
• FDTD simulation in 2D and 3D.
• GPU-accelerated, achieving high GCUPS performance.
• Multi-GPU runs, handling large-scale simulations with billions of cells.
• CPU-capable for fast prototyping, even on your laptop.
• Intuitive and familiar API.
• Native FDFD mode solver with discrete Yee-grid refinement and validation.
• CPML, absorbing layers and PEC boundaries.
• Unidirectional mode sources (single freq. and broadband, Huygens fields + TFSF, TE/TM).
• Gaussian sources, e.g. for grating coupler simulations.
• Integrated rasterization module.
• Sub-pixel averaging using super-sampling.
• Custom source time profiles.
• Built-in layout flow (GDSII import/export).
• DFT monitors and S-parameter extraction workflow for compact modeling.
• Streamlined parametric design module.
• Optimization/autodiff utilities for gradient-based inverse-design with Jax.

Examples

Try out notebooks from our growing example library. It includes:

• 1) Mode Sources and Monitors
• 2) Waveguide Crossing with Cosine Tapers
• 3) Topology Optimized 90° Bend (2D)

Integration

BeamZ is used by several other OSS packages as an FDTD engine:

• SiEPIC's GDS FDTD, an EDA- and solver-agnostic 3D FDTD compact modeling framework.
• Lumix, a research codebase for optical neural networks and matrix inverse design.

Installation

Install BeamZ using pip:

pip install beamz

Development uses uv. Clone the repository and sync the package with its contributor dependencies:

git clone https://github.com/beamzorg/beamz
cd beamz
uv sync --extra dev --extra test

For a ready-to-use CUDA and Jupyter development environment, see the Docker and RunPod guide.

About

BeamZ's mission is to be the pragmatic FDTD engine of choice for photonic chip designers.

It focuses on streamlined workflows over feature bloat to produce useful results without tedious setup or configuration files and bringing GPU-acceleration for maximum performance in large-scale simulations to everyone.

The project is actively maintained. We aim to keep the code in Python, minimize dependencies, keep the line-count low, commented, and features local within the code 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. The engine is grounded in hundreds of tests, verifiable simulations and benchmarks, replicating known results from the established literature. Beyond benchmarking the core engine stats, we aim to reduce friction for chip designers at every step - from installation, to setting up the sim using a familiar API, to optimizing the performance of the rasterizer, mode solver, compiler, optimization loop, and integration into the overall chip design workflow.

Contributing

We appreciate all contributions. If you are planning to contribute bug-fixes, please do so without any further discussion. If you would like to add new features, please first open an issue and discuss the feature with us. There may be ongoing work that could conflict with your changes, or we may be heading in a different direction and we don't want to waste your time working on something that might be rejected. - You can find more information here.

The simplest way to support the project of course is by giving this repo a star. Thank you!

Copyright © 2026 Quentin Wach — Apache-2.0