API Reference¶

Every public module, class, and function in gds_fdtd. Each module page below is generated from the source docstrings and links to the individual classes and functions it defines.

If you are looking for a task-oriented introduction instead, start with Setting Up Simulations (GDS → S-parameters), Technology and Materials (materials and the layer stack), or the Examples gallery.

Core data types¶

The objects that flow through every simulation, independent of engine.

`gds_fdtd.geometry`	gds_fdtd simulation toolbox.
`gds_fdtd.smatrix`	gds_fdtd simulation toolbox.
`gds_fdtd.spec`	gds_fdtd simulation toolbox.

Technology and materials¶

The layer stack, named materials, and the three optical-constant sources (engine model / refractiveindex.info / constant nk). See Technology and Materials.

`gds_fdtd.technology`	gds_fdtd simulation toolbox.
`gds_fdtd.materials.rii`	refractiveindex.info database support.
`gds_fdtd.materials.select`	Per-engine material-source selection — how a solver picks a material model.

Layout frontends¶

Turning a layout (GDS, gdsfactory, SiEPIC/KLayout) into a Component. See Layout Frontends.

`gds_fdtd.lyprocessor`	gds_fdtd simulation toolbox.
`gds_fdtd.simprocessor`	gds_fdtd simulation toolbox.
`gds_fdtd.layout.gdsfactory`	gds_fdtd simulation toolbox.

Solvers¶

The engine-agnostic Solver contract, the registry (get_solver), and the tidy3d / Lumerical / beamz adapters. See Solvers and Adding your own solver.

`gds_fdtd.solvers`	Solver adapters implementing the Solver contract (gds_fdtd.solvers.base).
`gds_fdtd.solvers.base`	gds_fdtd simulation toolbox.
`gds_fdtd.solvers.tidy3d`	gds_fdtd simulation toolbox.
`gds_fdtd.solvers.lumerical`	gds_fdtd simulation toolbox.
`gds_fdtd.solvers.beamz`	gds_fdtd simulation toolbox.

Fields, modes, and meshing¶

The kernel-engine pipeline: permittivity rasterization, local mode solving, and mode-overlap S-parameter extraction.

`gds_fdtd.grid`	gds_fdtd simulation toolbox.
`gds_fdtd.modes`	gds_fdtd simulation toolbox.
`gds_fdtd.extraction`	gds_fdtd simulation toolbox.

Analysis and visualization¶

Reading, plotting, converging, and cross-validating results. See Working with S-Parameters.

`gds_fdtd.plotting`	gds_fdtd simulation toolbox.
`gds_fdtd.viewer3d`	gds_fdtd simulation toolbox.
`gds_fdtd.convergence`	gds_fdtd simulation toolbox.
`gds_fdtd.validation`	gds_fdtd simulation toolbox.
`gds_fdtd.caching`	gds_fdtd simulation toolbox.

Execution and CLI¶

Serializable jobs, local/subprocess backends, and the gds-fdtd command-line interface. See Running gds_fdtd jobs on remote compute.

`gds_fdtd.execution.jobspec`	gds_fdtd simulation toolbox.
`gds_fdtd.execution.backends`	gds_fdtd simulation toolbox.
`gds_fdtd.cli`	gds_fdtd simulation toolbox.

Configuration and errors¶

`gds_fdtd.errors`	gds_fdtd simulation toolbox.
`gds_fdtd.settings`	gds_fdtd simulation toolbox.
`gds_fdtd.logging_config`	Logging configuration for gds_fdtd package.