API Reference

This page provides an auto-generated summary of legume’s API.

legume

set_backend

GuidedModeExp

Creating a simulation

GuidedModeExp

Attributes

GuidedModeExp.freqs
GuidedModeExp.freqs_im
GuidedModeExp.eigvecs
GuidedModeExp.kpoints
GuidedModeExp.gvec
GuidedModeExp.rad_coup
GuidedModeExp.rad_gvec

Methods

GuidedModeExp.run
GuidedModeExp.run_im
GuidedModeExp.compute_rad
GuidedModeExp.get_eps_xy
GuidedModeExp.ft_field_xy
GuidedModeExp.get_field_xy
GuidedModeExp.get_field_xz
GuidedModeExp.get_field_yz
GuidedModeExp.set_run_options

PlaneWaveExp

Creating a simulation

PlaneWaveExp

Attributes

PlaneWaveExp.freqs
PlaneWaveExp.eigvecs
PlaneWaveExp.kpoints
PlaneWaveExp.gvec

Methods

PlaneWaveExp.run
PlaneWaveExp.get_eps_xy
PlaneWaveExp.ft_field_xy
PlaneWaveExp.get_field_xy

Photonic crystal

Lattice
Lattice.bz_path
PhotCryst
Layer
ShapesLayer

Geometry

Circle
Poly
Square
Hexagon
FourierShape

Visualization

viz.bands
viz.structure
viz.shapes
viz.eps_xz
viz.eps_xy
viz.eps_yz
viz.eps_ft
viz.reciprocal
viz.field

GDS

gds.generate_gds
gds.generate_gds_raster