Skip to main content

Build codecov docs PyPI version DOI

What this package can do

  • Calculate reflectance, transmittance, and scattering parameters from stacks of planar thin films
  • Simulate diffraction efficiencies, scattering matrices from 1D diffraction gratings
  • Simulate diffraction efficiencies, scattering matrices from 2D photonic crystals

Getting Started

Installation

The recommended way to install this software is with pip:

pip install rcwa

And that's it!

Hello World Program

To see a simple example, run:

python -m rcwa.examples.bragg_mirror

This should run an example with a 10-layer bragg mirror (also known as a dielectric mirror), which can have very high reflectance near its design wavelength, and output the reflectance as a function of wavelength, as seen below:

Bragg Mirror Plot

Features

  • Implements 1D Transfer Matrix Method for homogenous layers
  • Implements full rectangular 2D RCWA for periodic layers
  • Huge material database for n/k values in optical range built-in based on refractiveindex.info, including metals, plastics, glass, and ceramics
  • Easy to use class-based syntax
  • Integrated parameter sweeps of any simulation parameter: geometry, materials, wavelength, angle of incidence, etc.
  • Compute reflection and transmission spectra at arbitrary incidence and polarization
  • Compute spectroscopic ellipsometry curves
  • Compute reflected power, transmitted power, and S-parameters
  • Large, fast-to-run test suite
  • Extremely fast narrowband, rigorously correct simulations well suited for resonant devices
  • Built-in convergence testing

Example Uses

  • Compute reflected and transmitted power from a thin film stack
  • Determine resonant frequency of a VCSEL
  • Determine reflectance of a bragg mirror, on or off-axis
  • Find diffraction efficiencies for a 1D or 2D diffraction grating
  • Compute reflected power from a metallic mirror

Examples

All examples are in the examples/ directory in your locally installed rcwa package, or in rcwa/examples/ on this repository.

Reflection off Dispersive Materials

The below example demonstrates the reflection spectra you get reflecting off a bare surface of silicon, using the built-in materials database.

from rcwa import Material, Layer, LayerStack, Source, Solver, Plotter

import numpy as np
import pandas as pd
from matplotlib import pyplot as plt
startWavelength = 0.25
stopWavelength = 0.8
stepWavelength = 0.001

# Setup the source
source = Source(wavelength=startWavelength)

# Setup the materials and geometry
si = Material(name='Si')

# Setup the interface
reflectionLayer = Layer(n=1) # Free space
transmissionLayer = Layer(material=si)
stack = LayerStack(incident_layer=reflectionLayer, transmission_layer=transmissionLayer)

# Setup the solver
TMMSolver = Solver(stack, source, (1, 1))

# Setup and run the sweep
wavelengths = np.arange(startWavelength, stopWavelength + stepWavelength,
        stepWavelength)
results = TMMSolver.solve(wavelength=wavelengths)
results.plot(x='wavelength', y='RTot', show=True)

Dispersive Si Plot

Source Wavelength / Angle Sweeps

import numpy as np
from rcwa import Material, Layer, LayerStack, Source, Solver, Plotter

# Setup the source
startWavelength = 0.25
stopWavelength = 0.8
stepWavelength = 0.02
wavelengths = np.arange(startWavelength, stopWavelength + stepWavelength,
        stepWavelength)
thetas = np.linspace(0, np.pi/4,10)

source = Source(wavelength=startWavelength)

thin_film = Layer(thickness=0.1, n=2)
substrate = Layer(n=4)
stack = LayerStack(thick_film, transmission_layer=substrate)

solver = Solver(stack, source)

results = solver.solve(wavelength=wavelengths, theta=thetas)
results.plot(x='wavelength', y='RTot', show=True)

Reflectance vs Wavelength with varying angle

Geometry Sweeps

Here, we set up a simulation with a rectangular grating on a substrate with a relative permittivity of 9, and a wavelength of 0.5 units (microns, meters, whatever you like!). This can be found in the grating_sweep.py example. In this example we are sweeping the thickness, but we could have swept the period or refractive index or permittivity.

from rcwa import Source, Layer, LayerStack, Crystal, Solver, RectangularGrating
import numpy as np
from matplotlib import pyplot as plt

reflection_layer = Layer(er=1.0, ur=1.0)
transmission_layer = Layer(er=9.0, ur=1.0)

wavelength = 0.5
source = Source(wavelength=wavelength)

N_harmonics = 11

grating_layer = RectangularGrating(period=2, thickness=0.5, n=4, n_void=1, nx=500)
layer_stack = LayerStack(grating_layer, incident_layer=reflection_layer, transmission_layer=transmission_layer)

solver_1d = Solver(layer_stack, source, N_harmonics)
results = solver_1d.solve((grating_layer, {'thickness': np.linspace(0.3, 0.5, 100)}))

results.plot(x='thickness', y='RTot', show=True)

Reflectance vs Thickness

Documentation

This project is documented on Github Pages. For additional information, including downloading examples, you can view this project on github.

Author: Jordan Edmunds, UC Irvine Alumnus, UC Berkeley Ph.D. Student

Date Started: 2020/01/05

Frequently Asked Questions

Q: How do I tell the solver to use the Transfer Matrix Method or Rigorous Coupled Wave Analysis? A: Don't worry, it will figure it out for you.

License

This project is distributed under the MIT license.

Dependencies

Dependencies are comprehensively covered by the setup.py file, and the most recent set of dependencies can be found there. Currently, this requires numpy, scipy, pandas, matplotlib, and pyyaml. The documentation is built using Sphinx and hosted on readthedocs.io.

Acknowledgements / References

This work is based primarily on a set of lectures and associated course material by Professor Raymond Rumpf at the University of Texas, El Paso.

[1] Rakić, Aleksandar D., Aleksandra B. Djurišić, Jovan M. Elazar, and Marian L. Majewski. "Optical properties of metallic films for vertical-cavity optoelectronic devices." Applied optics 37, no. 22 (1998): 5271-5283.

Release files for rcwa 1.0.48

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rcwa 1.0.48
File Size Uploaded
rcwa-1.0.48.tar.gz 8.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for rcwa 1.0.48
File Interpreter ABI Platform
rcwa-1.0.48-py3-none-any.whl Python 3 none any Details

Total release size:12.9 MB

Release files / rcwa-1.0.48.tar.gz

Download URL rcwa-1.0.48.tar.gz
Size 8.3 MB
Tags Source
SHA-256 checksum
How to use checksums
74ef6062acc04ef411011b963d16224537fcf912e2cb771f6f4b58de0300ac1b
BLAKE2b-256 checksum
How to use checksums
85ee1e467333281ca1c55e486a75f35fd95dd3636df6db67ba20ad52e36201a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / rcwa-1.0.48-py3-none-any.whl

Download URL rcwa-1.0.48-py3-none-any.whl
Size 4.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
915d9f7c7d91045c1f73f8cff54aeb1d5c0fdd010ce5a79ebbadf25502c2bee8
BLAKE2b-256 checksum
How to use checksums
87de0a17c02ec366cd678f38ac05436e85dd09e0003621cd20e4ce980e69992b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release history Release notifications | RSS feed

This release

1.0.48 This release

2 release files

1.0.45

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.7

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.55

2 release files

0.1.54

2 release files

0.1.53

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page