Toggle navigation sidebar
Toggle in-page Table of Contents
User Guide
Start Here
Examples
Start here
Tidy3D first walkthrough
Tidy3D Primer
GDSII import
Dispersive materials
Dispersion fitting tool
Self-intersecting PolySlab
STL File Import
Total-Field Scattered-Field Plane Wave Source
Boundary conditions
Automatic nonuniform grid
Mode solver
Mode sources and mode monitors
Modes in bent and angled waveguides
Web API
Parameter scan
Geometry plotting
Data plotting
Importing custom source data
Defining spatially varying index using custom medium
Adjoint Plugin: 1 Introduction
Adjoint Plugin: 2 Checking Gradients
Adjoint Plugin: 3 Inverse Design Demo
Adjoint Plugin: 4 Multi-Objective Gradients
Field projections
Scattering matrix plugin
Waveguide Y junction
MMI 1 x 4 power splitter
Waveguide crossing based on cosine tapers
Waveguide size converter
Bragg grating sections
Euler waveguide bend
Compact polarization splitter-rotator
8-channel mode and polarization (de)multiplexer
Grating coupler
2D ring resonator
THz integrated demultiplexer/filter based on ring resonator
Photonic crystal waveguide polarization filter
Edge coupler
90 degree optical hybrid
All-dielectric metasurface absorber
Gradient metasurface reflector
Graphene metamaterial absorber
Microwave frequency selective surface (FSS)
Silicon resonator benchmark
Germanium resonator benchmark
Grating efficiency benchmark
Biosensor grating
Distributed Bragg reflector and cavity
Photonic crystal slab band structure calculation
Optimized photonic crystal cavity
Scattering cross-section calculation
Gold nanoparticle validation
Plasmonic Yagi-Uda nanoantenna
Field projection for a zone plate
3D optical Luneburg lens
Large-area metalens
Frequently Asked Questions
How do I …
API Reference
tidy3d.Simulation
tidy3d.BoundarySpec
tidy3d.Boundary
tidy3d.BoundaryEdge
tidy3d.Periodic
tidy3d.PECBoundary
tidy3d.PMCBoundary
tidy3d.BlochBoundary
tidy3d.PML
tidy3d.StablePML
tidy3d.Absorber
tidy3d.AbsorberParams
tidy3d.PMLParams
tidy3d.Box
tidy3d.Sphere
tidy3d.Cylinder
tidy3d.PolySlab
tidy3d.TriangleMesh
tidy3d.GeometryGroup
tidy3d.Medium
tidy3d.PECMedium
tidy3d.CustomMedium
tidy3d.PoleResidue
tidy3d.Lorentz
tidy3d.Sellmeier
tidy3d.Drude
tidy3d.Debye
tidy3d.AnisotropicMedium
tidy3d.Medium2D
Material Library
tidy3d.Graphene
tidy3d.Structure
tidy3d.MeshOverrideStructure
tidy3d.PointDipole
tidy3d.UniformCurrentSource
tidy3d.PlaneWave
tidy3d.ModeSource
tidy3d.GaussianBeam
tidy3d.AstigmaticGaussianBeam
tidy3d.CustomFieldSource
tidy3d.TFSF
tidy3d.GaussianPulse
tidy3d.FieldMonitor
tidy3d.FieldTimeMonitor
tidy3d.FluxMonitor
tidy3d.FluxTimeMonitor
tidy3d.ModeMonitor
tidy3d.ModeSolverMonitor
tidy3d.PermittivityMonitor
tidy3d.FieldProjectionCartesianMonitor
tidy3d.FieldProjectionAngleMonitor
tidy3d.FieldProjectionKSpaceMonitor
tidy3d.DiffractionMonitor
tidy3d.ApodizationSpec
tidy3d.ModeSpec
tidy3d.GridSpec
tidy3d.AutoGrid
tidy3d.UniformGrid
tidy3d.CustomGrid
tidy3d.Coords
tidy3d.FieldGrid
tidy3d.YeeGrid
tidy3d.Grid
tidy3d.FieldProjectionSurface
tidy3d.FieldProjector
tidy3d.SimulationData
tidy3d.FieldData
tidy3d.FieldTimeData
tidy3d.ModeSolverData
tidy3d.PermittivityData
tidy3d.FluxData
tidy3d.FluxTimeData
tidy3d.ModeData
tidy3d.FieldProjectionAngleData
tidy3d.FieldProjectionCartesianData
tidy3d.FieldProjectionKSpaceData
tidy3d.DiffractionData
tidy3d.PermittivityDataset
tidy3d.ScalarFieldDataArray
tidy3d.ScalarModeFieldDataArray
tidy3d.ScalarFieldTimeDataArray
tidy3d.ModeAmpsDataArray
tidy3d.ModeIndexDataArray
tidy3d.FluxDataArray
tidy3d.FluxTimeDataArray
tidy3d.FieldProjectionAngleDataArray
tidy3d.FieldProjectionCartesianDataArray
tidy3d.FieldProjectionKSpaceDataArray
tidy3d.DiffractionDataArray
tidy3d.log
tidy3d.set_logging_level
tidy3d.set_logging_file
tidy3d.web.run
tidy3d.web.upload
tidy3d.web.estimate_cost
tidy3d.web.real_cost
tidy3d.web.get_info
tidy3d.web.start
tidy3d.web.monitor
tidy3d.web.download
tidy3d.web.load
tidy3d.web.delete
tidy3d.web.download_log
tidy3d.web.download_json
tidy3d.web.load_simulation
tidy3d.web.run_async
tidy3d.web.Job
tidy3d.web.Batch
tidy3d.web.BatchData
tidy3d.web.task.TaskInfo
tidy3d.web.task.TaskStatus
tidy3d.plugins.mode.ModeSolver
tidy3d.plugins.mode.ModeSolverData
tidy3d.plugins.dispersion.DispersionFitter
tidy3d.plugins.dispersion.StableDispersionFitter
tidy3d.plugins.dispersion.AdvancedFitterParam
tidy3d.plugins.polyslab.ComplexPolySlab
tidy3d.plugins.smatrix.ComponentModeler
tidy3d.plugins.smatrix.Port
tidy3d.plugins.smatrix.SMatrixDataArray
tidy3d.plugins.resonance.ResonanceFinder
tidy3d.plugins.adjoint.run
tidy3d.plugins.adjoint.run_async
tidy3d.plugins.adjoint.JaxBox
tidy3d.plugins.adjoint.JaxMedium
tidy3d.plugins.adjoint.JaxAnisotropicMedium
tidy3d.plugins.adjoint.JaxCustomMedium
tidy3d.plugins.adjoint.JaxStructure
tidy3d.plugins.adjoint.JaxSimulation
tidy3d.plugins.adjoint.JaxSimulationData
tidy3d.plugins.adjoint.JaxModeData
tidy3d.plugins.adjoint.JaxPermittivityDataset
tidy3d.plugins.adjoint.JaxDataArray
tidy3d.C_0
tidy3d.HBAR
tidy3d.Q_e
tidy3d.ETA_0
tidy3d.EPSILON_0
tidy3d.MU_0
tidy3d.inf
tidy3d.PEC
tidy3d.config.Tidy3dConfig
tidy3d.DefaultPMLParameters
tidy3d.DefaultStablePMLParameters
tidy3d.DefaultAbsorberParameters
tidy3d.components.base.Tidy3dBaseModel
tidy3d.components.boundary.AbsorberSpec
tidy3d.components.medium.AbstractMedium
tidy3d.components.medium.DispersiveMedium
tidy3d.components.geometry.Geometry
tidy3d.components.geometry.Planar
tidy3d.components.geometry.Circular
tidy3d.components.source.SourceTime
tidy3d.components.source.Source
tidy3d.components.source.FieldSource
tidy3d.components.monitor.Monitor
Changelog
repository
open issue
suggest edit
.rst
.pdf
tidy3d.log
tidy3d.log
#
tidy3d.
log
=
<tidy3d.log.Logger
object>
#
Custom logger to avoid the complexities of the logging module
