Skip to main content

EM package to create inverse / generative designs for your photonic devices with ease and efficiency.

Project description

BEAMZ

BEAMZ is an electromagnetic simulation package for photonic chip designers using the FDTD 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.

pip install beamz

License Last Update Tests Coverage

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 or download and run examples/ from this repository.

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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beamz-0.3.1.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beamz-0.3.1-py3-none-any.whl (334.3 kB view details)

Uploaded Python 3

File details

Details for the file beamz-0.3.1.tar.gz.

File metadata

  • Download URL: beamz-0.3.1.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for beamz-0.3.1.tar.gz
Algorithm Hash digest
SHA256 98539de32426724ef1dd4fa03c0617183ddeec15b6b3d9031102ec994ac3ebe7
MD5 6cdca8a2fbb5165b06f8df25535cae96
BLAKE2b-256 e272a3f2dbd1fea3800e341f93bd8854d6853df264999a80aface762053657ce

See more details on using hashes here.

File details

Details for the file beamz-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: beamz-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 334.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for beamz-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd7a95f54c148ccc67f697ab6c7491360a004f1da1b4fe01644381e36eabac6b
MD5 d4c306118d7cc1dca08935ddec13fa96
BLAKE2b-256 9b248f591012dcdf8896e1bb1241bcfad44a7e53b193d41b80dadfbfc066a4be

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page