Skip to content
BeamZ BeamZ

Getting Started

BeamZ is a differentiable, GPU-accelerated electromagnetic simulation framework for photonic chip designers using the FDTD method. Its engine 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.

Install

Install BeamZ using pip:

Bash
pip install beamz

For development installation, clone the repository and install in editable mode:

Bash
git clone https://github.com/beamzorg/beamz
cd beamz
pip install -e ".[dev]"