logo

User Guide

  • Start Here
    • Installation instructions
    • Basic simulation template
    • Tidy3D first walkthrough
    • Introduction on Tidy3D working principles
  • Learning FDTD Through Examples
    • FDTD 101
    • Inverse design in photonics
    • Defining geometries using GDS file import
    • Defining arbitrary 3D geometries using STL file import
    • Modeling dispersive materials
    • Fitting dispersive material models
    • Defining fully anisotropic materials
    • Defining gyrotropic materials
    • Defining complex, spatially-varying dielectric structures
    • Defining complex polygon geometries
    • Setting up boundary conditions
    • Using automatic nonuniform meshing
    • Defining mode sources and monitors
    • Injecting modes in bent and angled waveguides
    • Defining a total-field scattered-field (TFSF) plane wave source
    • Defining complex, spatially-varying sources
    • Running simulations through the cloud
    • Performing parallel / batch processing of simulations
    • Visualizing geometries in Tidy3D
    • Performing visualization of simulation data
    • Creating FDTD animations
    • Using the mode solver for optical mode analysis
    • Using the waveguide plugin to analyze waveguide modes
    • Performing near field to far field projections
    • Computing the scattering matrix of a device
    • Defining common integrated photonic components
    • Defining common photonic crystal structures
    • Jax, automatic differentiation, and adjoint optimization: basics
    • Adjoint analysis of a multi-layer slab
    • Inverse design optimization of a mode converter
    • Multi-objective adjoint optimization
    • Inverse design optimization of a waveguide taper
    • Inverse design optimization of a compact grating coupler
    • Inverse design optimization of a metalens
    • Waveguide Y junction
    • Waveguide to ring coupling
    • Waveguide crossing based on cosine tapers
    • Euler waveguide bend
    • Inverse taper edge coupler
    • Uniform grating coupler
    • Focusing apodized grating coupler
    • 1x4 MMI power splitter
    • 2D ring resonator
    • Broadband bi-level taper polarization rotator-splitter
    • Waveguide mode size converters
    • Strip to slot waveguide converters
    • Waveguide bragg gratings
    • Broadband directional coupler
    • Compact polarization splitter-rotator
    • 8-Channel mode and polarization de-multiplexer
    • THz integrated demultiplexer/filter based on a ring resonator
    • Photonic crystal waveguide polarization filter
    • 90 degree optical hybrid
    • Broadband polarizer assisted by anisotropic metamaterial
    • Exceptional coupling for waveguide crosstalk reduction
    • Dielectric metasurface absorber
    • Gradient metasurface reflector
    • Graphene metamaterial absorber
    • Microwave frequency selective surface
    • High-Q silicon resonator
    • Germanium Fano metasurface
    • Multilevel blazed diffraction grating
    • Biosensor grating simulation
    • Distributed Bragg reflector and cavity
    • Band structure calculation of a photonic crystal slab
    • Optimized photonic crystal L3 cavity
    • Scattering cross-section calculation of a dielectric sphere
    • Scattering of a plasmonic nanoparticle
    • Plasmonic Yagi-Uda nanoantenna
    • Field projection for a zone plate
    • 3D optical Luneburg lens
    • Metalens in the visible frequency range
    • Spherical Fresnel lens
    • Hyperbolic polaritons in nanostructured hBN
    • Unidirectional SPP from non-Hermitian metagratings
    • Anderson localization of electromagnetic waves in three dimensions
  • 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.RotationAroundAxis
    • tidy3d.Medium
    • tidy3d.PECMedium
    • tidy3d.FullyAnisotropicMedium
    • tidy3d.CustomMedium
    • tidy3d.PoleResidue
    • tidy3d.Lorentz
    • tidy3d.Sellmeier
    • tidy3d.Drude
    • tidy3d.Debye
    • tidy3d.CustomPoleResidue
    • tidy3d.CustomLorentz
    • tidy3d.CustomSellmeier
    • tidy3d.CustomDrude
    • tidy3d.CustomDebye
    • tidy3d.AnisotropicMedium
    • tidy3d.Medium2D
    • tidy3d.CustomAnisotropicMedium
    • Material Library
      • tidy3d.Graphene
    • tidy3d.Structure
    • tidy3d.MeshOverrideStructure
    • tidy3d.PointDipole
    • tidy3d.UniformCurrentSource
    • tidy3d.PlaneWave
    • tidy3d.ModeSource
    • tidy3d.GaussianBeam
    • tidy3d.AstigmaticGaussianBeam
    • tidy3d.CustomFieldSource
    • tidy3d.CustomCurrentSource
    • 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.SpatialDataArray
    • 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.FastDispersionFitter
    • tidy3d.plugins.dispersion.AdvancedFastFitterParam
    • tidy3d.plugins.dispersion.DispersionFitter
    • tidy3d.plugins.dispersion.AdvancedFitterParam
    • tidy3d.plugins.dispersion.web.run
    • tidy3d.plugins.dispersion.StableDispersionFitter
    • tidy3d.plugins.polyslab.ComplexPolySlab
    • tidy3d.plugins.smatrix.ComponentModeler
    • tidy3d.plugins.smatrix.Port
    • tidy3d.plugins.smatrix.SMatrixDataArray
    • tidy3d.plugins.resonance.ResonanceFinder
    • tidy3d.plugins.waveguide.RectangularDielectric
    • 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
Theme by the Executable Book Project
  • repository
  • open issue
  • suggest edit
  • .rst

Start Here

Start Here#

  • Installation instructions
  • Basic simulation template
  • Tidy3D first walkthrough
  • Introduction on Tidy3D working principles

previous

Tidy3D Documentation

next

Installation instructions

By Flexcompute
© Copyright Flexcompute 2020-2023.