API Reference

Use this section when you need exact class names, module boundaries, configuration fields, or result objects. The reference is intentionally terse: it complements the runnable Guide and the conceptual Theory.

API Map

Area	Start here	Use it for
Package overview	API Map	Understand the major modules and workflow
Geometry	PixelStack	Build solver-agnostic CMOS pixel stacks
Materials	MaterialDB	Query wavelength-dependent optical constants
Solvers	SolverBase	Implement or call RCWA/FDTD backends
Sources	Sources	Configure plane waves, cone illumination, and ray inputs
Analysis	Analysis	Compute QE, energy balance, and solver comparisons
Configuration	Config Reference	Check YAML schema fields and defaults
Terms	Glossary	Resolve names used across theory and guides

When to Use This Section

• You are writing code against COMPASS classes.
• You need the exact YAML key or default value for a simulation.
• You are implementing a new solver adapter or analysis module.
• You are debugging how data flows from config to geometry to solver result.