Welcome to S4Utils’s documentation!

What is it?

S4Utils is a collection of python utility functions to ease the use of the S4 software 1

References

1

Liu, V. and Fan, S., Computer Physics Communications 183, 2233-2244 (2012) 10.1016/j.cpc.2012.04.026

Documentation Contents

Contents:

• Download and installation
  • Installing S⁴ and the Python API
  • Installing S4Utils
• Tutorials
  • Tutorial 1: A single, flat interface
  • Tutorial 2: A single slab, or Fabry-Pérot etalon
  • Tutorial 3: Calculating absorption
  • Tutorial 4: Dispersive Metal-Insulator-Metal grating

API Reference

API Reference:

• Material database
  • epsAu()
  • epsGaAs()
  • epsAlGaAs()
  • epsInP()
  • epsInGaAs()
  • epsAlInAs()
  • epsGaNx()
  • epsGaNz()
  • epsAlNx()
  • epsAlNz()
  • epsSiN()
  • epsCaF2()
  • epsZal()
  • epsPQW()
  • epsDrude()
  • eps2Phonons()
  • epsLorentzPhonon()
  • omegaP_2D()
  • omegaP_3D()
• S4Utils functions references
  • Basic Utility functions
  • Simulation Functions
  • S4Utils Plotting Utilities
• epsInterpolator functions references
  • eps_interpolator()
  • eps_Au()

Indices and tables

• Index

• Module Index

• Search Page