Skip to content
PhotonForge
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting Started
Key Concepts
Quick Start I: Local GUI
Quick Start II: Passive
Quick Start III: Active
Guides
Technology
Layers
Ports
Electrical Ports
Fiber Ports
PDK Components
Parametric Component Library
Custom Technology
Custom Parametric Components
Routing and Connections
Auto Routing
Importing a GDSII/OASIS Layout
Exporting a GDSII/OASIS Layout
S Parameters
Tidy3D Model
Circuit Model
Data Model
Custom Model
Layout vs. Schematic (LVS)
Inverse Design with Autograd
Photonic Design Automation
Custom Component Library in the GUI
Verilog-A Export
Layout Examples
Components
Instances and References
Paths, Routes, and Transitions
Grid Snapping
Grid and Pack
Design Rule Check
Compact Models
Analytic Directional Coupler Model
Analytic Waveguide Model
Analytic MZI Model
Analytic Ring Resonator Model
Analytic Dual-Ring Resonator Model
Mux/Demux Model
Analytic Waveguide Crossing Model
Analytic Bragg Grating Model
Analytic Data Models Overview
Time Domain Models
CW Laser
Signal Source
Photodiode
Avalanche Photodiode
Phase Modulator
Traveling-Wave Modulator
Mach-Zehnder Modulator
Ring Resonator
Nonlinear Ring Resonator
Nonlinear Waveguide
Electrical Filter
Optical Pulse
Directly Modulated Laser
Optical Amplifier
Semiconductor Optical Amplifier
Optical Fiber
Optical Noise
Electrical Amplifier
Amplitude Modulator
Electro-Absorption Modulator
Custom Expressions
Differentiator
Integrator
Time Delay
Examples
Component design
Y Splitter
Mach-Zehnder Interferometer
Waveguide Crossing
Waveguide Crossing Yield Analysis
90° Optical Hybrid
Cascaded MZI Filter
Cascaded Rings Filter
Eight-Channel DWDM Filter on Thin-Film Lithium Niobate
Polarization Splitter Rotator
Grating Coupler
Inverse Designed Grating Coupler
Efficient simulation of a large, high-Q micro-ring resonator
Inverse Design of a Fabrication-Robust Bent Directional Coupler
Edge Coupler
MMI Optimization with Tidy3D Design Plugin
MMI 3 dB Coupler with EME
Waveguide Coupling Simulation with Port Bending
Spiral Waveguide
Time-Domain Simulation of a Mach–Zehnder Interferometer
Polarizing Beam Splitter
Fabrication-Aware Simulation: Two Coupled Ring Resonator Filter
Bandstructure Analysis of 1D Periodic Waveguides
Active device design
Tunable MZI
Electro-Optic Mach-Zehnder Modulator
Signal Integrity Analysis of a 100 Gbps Transmitter
Folded Electro-Optic Modulators on TFLN: Analysis
Programmable Photonic Circuit
BTO Electro-Optic Modulator
Switch Array
Time-Domain Simulation of a Low-Pass Filter
Differential Coplanar Waveguide
Four-Channel WDM Filter
Time-Domain Simulation of a Mach–Zehnder Modulator (Toy Model)
Time-Domain Simulation of a Mach–Zehnder Modulator
Self Pulsing in Silicon Microring Resonator
Two-Segment Silicon Microring Modulator
Microring Modulator: PCell with Attached Model
3D doping extrusion from a 2D carrier profile
Noise Under Large-Signal Modulation
Series Push-Pull Mach-Zehnder Modulator with Slow-Wave T-Rail Electrodes
Optical Peaking in a Microring Modulator
Laser Dynamics with External Optical Feedback
Thermal Stabilization of Microring Resonators
Full chip layout
Add-Drop Filter Layout
Building Circuit Models from Layout Files
Microring Modulator
Automated Routing of a Selector Switch
Dual Polarization IQ Modulator
Quantum Chip
LIDAR
Automated Routing and Path Length Matching of a Photonic Mesh
Foundry-Compatible PIC Design Flow
Folded Electro-Optic Modulators on TFLN: Layout
Automated Routing of a Ring Filter Bank
Automated Routing of a Dual Polarization Coherent Transceiver
Chip Design Tutorials
Data Communication
Technology and PDK Setup
Custom Component Library
Chip Layout
Design Rule Check
Chip Simulation
Optical I/O
Technology and PDK Setup
Custom Component Library
Chip Layout
Wavelength Plan and Thermal Budget
Link Simulation
Resonance Locking
Coherent Transceiver
800G Coherent Link Budget and Technology
800G Coherent Transmitter Components
800G Coherent Receiver Components
800G Coherent Chip Layout and Verification
800G Coherent Link Simulation
Quantum
Custom Component Library
Quantum Chip Layout
Quantum Chip Simulation
LiDAR
LiDAR System Budget and Technology
LiDAR Grating Antenna Design
LiDAR Component Library
LiDAR Chip Layout and Verification
LiDAR Beam Steering and Thermal Budget
FMCW Ranging with the LiDAR Chip
API reference
Module Configuration
config
Structures
Circle
Path
Polygon
Rectangle
ConstructiveSolid
Extruded
Polyhedron
boolean
envelope
heal
intersects
offset
text
tidy3d_structures_from_layout
Stencils
stencil
apodized_focused_grating
apodized_grating
cross
focused_grating
grating
linear_taper
mmi
ruler
vernier_scale
as_component
Components
Component
FiberPort
GaussianPort
Label
PhfStream
Port
Reference
Terminal
component_from_netlist
find_top_level
load_layout
load_full_phf
load_phf
parametric_component
reference_chain
select_references
set_unique_names
write_layout
write_phf
Parametric Components
parametric
bend
crossing
crossing45
dual_ring_coupler
extend_ports
fill
rectangular_spiral
circular_spiral
ring_coupler
s_bend
s_bend_coupler
s_bend_ring_coupler
s_bend_straight_coupler
straight
transition
route
route_auto
route_l
route_u
route_z
route_s_bend
route_taper
route_manhattan
route_electrical
route_length
effective_route_length
routing_collisions
Abstract Components
abstract
absolute
adder
amplitude_modulator
avalanche_photodiode
awg
bend
bragg_grating
circulator
crossing
cw_laser
differentiator
directional_coupler
dm_laser
edge_coupler
electrical_amplifier
electrical_termination
electro_absorption_modulator
fiber
filter
grating_coupler
impedance_mismatch
integrator
isolator
mach_zehnder_modulator
multiplier
mux_demux
nonlinear_ring
optical_amplifier
optical_noise
optical_pulse
optical_termination
phase_modulator
photodiode
pmd_fiber
polarization_beam_splitter
polarization_splitter_grating_coupler
polarization_splitter_rotator
ring_resonator
scaler
semiconductor_amplifier
signal_source
straight
taper
terminated_modulator
transition
vcsel
y_splitter
Technology
ExtrusionSpec
LayerSpec
MaskSpec
PortSpec
Technology
basic_technology
cpw_spec
virtual_port_spec
parametric_technology
port_modes
Models
Model
AnalyticDirectionalCouplerModel
AnalyticMZIModel
AnalyticWaveguideModel
BraggGratingModel
CircuitModel
CirculatorModel
CrossingModel
DataModel
DirectionalCouplerCircuitModel
DirectionalCouplerModel
DualRingModel
EMEModel
IsolatorModel
MultimodeInterferometerModel
MuxDemuxModel
PolarizationBeamSplitterModel
PolarizationModeDispersionModel
PolarizationSplitterRotatorModel
PowerSplitterModel
RingModel
TerminationModel
Tidy3DModel
TwoPortModel
WaveguideModel
LumpedModel
Capacitor
IdealTransformer
IdealTransmissionLine
Inductor
ParallelRLC
Resistor
SeriesRLC
MNAMatrix
PoleResidueMatrix
SMatrix
Tidy3DAutogradConfig
YMatrix
ZMatrix
abort_pending_tasks
dispersion_from_beta2
franz_keldysh_absorption
frequency_classification
load_snp
pole_residue_fit
register_model_class
s_to_y_matrix
s_to_z_matrix
y_to_s_matrix
y_to_z_matrix
z_to_s_matrix
z_to_y_matrix
cache_s_matrix
cache_capacity
clear_cache
Time Steppers
TimeStepper
AmplitudeModTimeStepper
AnalyticWaveguideTimeStepper
AvalanchePhotodiodeTimeStepper
CWLaserTimeStepper
CircuitTimeStepper
DMLaserTimeStepper
DelayedTimeStepper
DifferentialTimeStepper
ElectricalAmplifierTimeStepper
ElectroAbsorptionModTimeStepper
ExpressionTimeStepper
FilterTimeStepper
IntegralTimeStepper
MZMTimeStepper
OpticalAmplifierTimeStepper
OpticalNoiseTimeStepper
OpticalPulseTimeStepper
PhaseModTimeStepper
PhotodiodeTimeStepper
PolarizationModeDispersionTimeStepper
RingTimeStepper
SMatrixTimeStepper
SemiconductorAmplifierTimeStepper
TerminatedModTimeStepper
WaveformTimeStepper
TimeDomainModel
TimeSeries
eo_s21
miller_gain
register_time_stepper_class
saturation_output_power
srh_lifetime
Monte Carlo
monte_carlo
RandomVariable
s_matrix
Utilities
utils
Expression
Interpolator
Properties
PathLengthMatching
LayerTable
ExtrusionTable
PortSpecTable
LiveViewer
grid_layout
pack_layout
s_bend_length
match_path_lengths
grid_ceil
grid_floor
snap_to_grid
plot_s_matrix
tidy3d_plot
replay_edits
C_0
Z_INF
cache
live_viewer
MAX_TILE_LAYOUT_BYTES
H
HBAR
K_B
M_0
Q
Layout Verification
verification
drc_check
lvs_check
load_drc_results
load_lvs_results
DRCResults
DRCViolation
DRCCell
DRCCellReference
Placement
DRCMarker
EdgeMarker
EdgePairMarker
PolygonMarker
TextMarker
ValueMarker
layout_pins
LVSResults
LVSComparison
LVSPair
LVSMessage
LVSGeometry
LVSNetlist
LVSCircuit
LVSNet
LVSConnection
LVSLabel
LVSPin
LVSDevice
LVSDevicePart
LVSDeviceClass
LVSParameterDefinition
LVSDeviceAbstract
LVSSubcircuit
LVSLayer
Edge
LVSSeverity
LVSStatus
LVSVerdict
Point
Polygon
Typing
typing
annotate
kwargs_for
array
expression
Angle
Capacitance
ComplexFieldAmplitude
Coordinate
Coordinate2D
Dimension
Dimension2D
Dispersion
DispersionSlope
FieldAmplitude
Fraction
Frequency
Gain
Impedance
Inductance
Layer
Loss
Medium
NegativeFloat
NegativeInt
NonNegativeFloat
NonNegativeInt
NonPositiveFloat
NonPositiveInt
PositiveDimension
PositiveDimension2D
PositiveFloat
PositiveInt
Power
Power_dBm
PropagationLoss
Resistance
Temperature
Time
TimeDelay
Velocity
Voltage
Photonic Design Automation
pda
Project
AttachmentStatus
BoundQuery
Edit
EditLog
History
HistoryEntry
ProjectTree
Trace
TraceabilityMatrix
Version
Watcher
create_project
init
last_timing_report
list_libraries
list_projects
load_project
restore_project
retire_project
stop
user_info
Fiber Utilities
fiber
brillouin_gain_spectrum
brillouin_threshold
fiber_parameters
filter_taps
raman_efficiency_at_shift
raman_on_off_gain
raman_profile
section_count
BRILLOUIN_SHIFT_1550
RAMAN_PEAK_SHIFT
SMF28
FAQ
PhotonForge
Photonic Canvas
Changelog
Software License Agreement
Third-Party Licenses
Privacy and Usage Data
Select theme
Dark
Light
Auto
typing.NonPositiveInt
Value:
typing.Annotated[int, maximum=0]
