FDTDX Documentation¶

FDTDX is a high-performance framework for electromagnetic simulations and inverse design of photonic devices. Built on JAX, it provides GPU-accelerated FDTD (Finite-Difference Time-Domain) simulations with automatic differentiation capabilities.

Installation¶

Install FDTDX using pip:

pip install fdtdx

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

git clone https://github.com/ymahlau/fdtdx
cd fdtdx
pip install -e .

Key Features¶

High Performance Computing¶

Native GPU acceleration through JAX
Multi-GPU scaling for large simulations
Memory-efficient time-reversal implementation
Optimized for large-scale inverse design
Flexible boundary conditions with PML support

Guides¶

Object Placement Guide - Learn how to position and configure simulation objects
Materials Guide - Learn how to use materials in FDTDX
Fabrication Constraints - Learn how to use the constraint mapping API to include fabrication constraints
Interface Compression - Learn how to use The compresion API to compute gradients with reversible autodiff
See the examples folder for complete scripts for inverse design in FDTDX
More guides will follow shortly

Citation¶

If you find this repository helpful for your work, please consider citing:

@article{schubert2024quantized,
  title={Quantized Inverse Design for Photonic Integrated Circuits},
  author={Schubert, Frederik and Mahlau, Yannik and Bethmann, Konrad and Hartmann, Fabian and Caspary, Reinhard and Munderloh, Marco and Ostermann, J{\"o}rn and Rosenhahn, Bodo},
  journal={arXiv preprint arXiv:2407.10273},
  year={2024}
}