Skip to main content

A JAX-based Differentiable Optical and Radio Frequency Simulator for Multilayer Structures

Project description

JaxLayerLumos: A JAX-based Differentiable Optical and Radio Frequency Simulator for Multilayer Structures

DOI DOI PyPI - Python Version GitHub Release License: MIT Code style: black Documentation Status

Overview

JaxLayerLumos is open-source transfer-matrix method (TMM) software designed for scientists, engineers, and researchers in optics and photonics. It provides a powerful yet intuitive interface for calculating the reflection and transmission (RT) of light through multi-layer optical structures. By inputting the refractive index, thickness of each layer, and the frequency vector, users can analyze how light interacts with layered materials, including the option to adjust for incidence angles. Our mission is to offer a lightweight, flexible, and fast alternative to commercial software, enabling users to perform complex optical simulations with ease. JaxLayerLumos is built with performance and usability in mind, facilitating the exploration of optical phenomena in research and development settings.

Features

  • Lightweight and Efficient: Optimized for performance, JaxLayerLumos ensures rapid calculations without the overhead of large-scale commercial software.
  • Gradient Calculation: Calculates the gradients over any variables involved in RT, powered by JAX.
  • Flexibility: Accommodates a wide range of materials and structures by allowing users to specify complex refractive indices, layer thicknesses, and frequency vectors.
  • Angle of Incidence Support: Expands simulation capabilities to include angled light incidence, providing more detailed analysis for advanced optical designs.
  • Open Source and Community-Driven: Encourages contributions and feedback from the community, ensuring continuous improvement and innovation.
  • Comprehensive Material Database: Includes a growing database of materials with their optical properties, streamlining the simulation setup process.

Installation

JaxLayerLumos can be easily installed by the following command using the PyPI repository.

pip install jaxlayerlumos

Alternatively, JaxLayerLumos can be installed from source.

pip install .

In addition, we support three installation modes, dev, benchmarking, and examples, where dev is defined for installing the packages required for development and software testing, benchmarking is for installing the packages required for benchmarking against differnt TMM software programs, and examples is needed for running the examples included in the examples directory. One of these modes can be used by commanding pip install .[dev], pip install .[benchmarking], or pip install .[examples].

Examples

A collection of examples in the examples directory exhibits various use cases and capabilities of our software. We provide the following examples:

  1. Reflection Spectra over Wavelengths Varying Incidence Angles
  2. Color Conversion
  3. Color Exploration with Thin-Film Structures
  4. Gradient Computation
  5. Visualization of Light Sources
  6. Plotting of Optical Constants
  7. Thin-Film Structure Optimization with Bayesian Optimization
  8. Thin-Film Structure Optimization with DoG Optimizer
  9. Reflection Spectra over Frequencies for Radar Design
  10. Analysis of Solar Cells
  11. Transmission Spectra over Wavelengths Varying Thicknesses
  12. Triple Junction Solar Cells

Comparison of TMM Packages

We compare Ansys Optics, TMM-Fast, and tmm to our software.

Feature Ansys Optics (stackrt) TMM-Fast (PyTorch/NumPy) tmm (Pure Python) JaxLayerLumos (JAX)
Lightweight ❌ Bulky
Speed ❌ Slow ✅ Fast ❌ Slow 🟨 Moderate
Gradient Support
GPU Support
TPU Support$^1$
Position-Dependent Absorption
Optical Simulations
Infrared Simulations 🟨 Limited 🟨 Limited
Radio Wave Simulations 🟨 Limited ✅ Handles magnetic materials
Open Source ❌ Commercial ✅ MIT ✅ BSD-3-Clause ✅ MIT

$^1$ Because TPUs are optimized for low-precision computation, their simulation results may show reduced numerical precision.

Benchmarking against Other Software

We benchmark JaxLayerLumos against other software. Detailed benchmarking results can be found in COMPARISONS.md. These comparisons include the results of Ansys Optics, TMM-Fast, and tmm.

To obtain these results, you should install additional required packages. Before installing the packages, you should install PyTorch first. In particular, if you need the CPU version of PyTorch, you can install it using the following command.

pip install torch --index-url https://download.pytorch.org/whl/cpu

For details, you can refer to the official instruction of PyTorch. Then, the required packages can be installed by the following command.

pip install .[benchmarking]

Finally, you can run the benchmarking code compare_methods.py in the benchmarking directory.

Software Testing and Test Automation

We provide a variety of test files in the tests directory. Before running the test files, the required packages should be installed by using pip install .[dev]. They can be run by commanding pytest tests/. Moreover, these test files are automatically tested via GitHub Actions, of which the configuration is defined in .github/workflows/pytest.yml.

Supported Materials

Materials supported by our software are described in MATERIALS.md.

JaxLayerLumos includes a growing library of materials, which are specified using either complex refractive indices or complex permittivities and permeabilities, which can be sourced from the literature or specified by users based on experimental data. When only complex refractive indices are provided, magnetic effects are assumed to be negligible, and the relative permeability is set to unity ($\mu_{r,j} = 1$), an assumption typically valid at optical frequencies. In the RF and microwave regimes, the electromagnetic properties of metals are derived from their electrical conductivity and magnetic susceptibility, while dielectrics are generally modeled with constant permittivity and negligible loss.

Contributing Guidelines

To contribute, please read CONTRIBUTING.md for our guidelines on issues, enhancements, and pull requests. Follow the outlined standards to keep the project consistent and collaborative.

Citation

@article{LiM2025joss,
    author={Li, Mingxuan and Kim, Jungtaek and Leu, Paul W.},
    title={{JaxLayerLumos}: A {JAX}-based Differentiable Optical and Radio Frequency Simulator for Multilayer Structures},
    journal={Journal of Open Source Software},
    volume={10},
    number={114},
    pages={8572},
    year={2025}
}

License

JaxLayerLumos is released under the MIT License, promoting open and unrestricted access to software for academic and commercial use.

Acknowledgments

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

jaxlayerlumos-0.3.4.tar.gz (7.6 MB view details)

Uploaded Source

Built Distribution

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

jaxlayerlumos-0.3.4-py3-none-any.whl (299.0 kB view details)

Uploaded Python 3

File details

Details for the file jaxlayerlumos-0.3.4.tar.gz.

File metadata

  • Download URL: jaxlayerlumos-0.3.4.tar.gz
  • Upload date:
  • Size: 7.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for jaxlayerlumos-0.3.4.tar.gz
Algorithm Hash digest
SHA256 481b00ef38225794bceb662650a937dd50f5774d522492a2df7fa26a82e2f97f
MD5 a59a16895bee2d6346bad43f77174fa2
BLAKE2b-256 259d3284e35922ec9f7c030e40e9b319c75651e9dfc8b6196d1e03f5ba3c4aa8

See more details on using hashes here.

File details

Details for the file jaxlayerlumos-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: jaxlayerlumos-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 299.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for jaxlayerlumos-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3ef1128a4bbafabb560bb25b8f653c7ccfe5f0874084c2120860df2ec47aab20
MD5 970b6fb0ca22edad8d77eaf6ae800e1c
BLAKE2b-256 1ded1691b07c763c8f524615c2d908c79c585321bdaf083651c709e34db2e4d6

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