`tidy3d-notebooks`

You can see our pretty example library documentation to explore each of these notebooks in more detail.

Development Guidance

Make sure all your internal API references start with tidy3d.<your_reference>
In notebooks, always have absolute links, otherwise the links will break when the user downloads them.
The develop branch is syced to the state of the webcenter in order to enable new notebooks to be featured quickly.
If you are developing a notebook using a version that is not the latest official version (i.e. 2.9.1 vs the python client develop branch) make sure to merge it only after the python client has been released. Or use a pre/2.10 branch.

These instructions are valid as of Nov 2025, but may change depending on structural planned changes and you can verify with the team.

Common Documentation References

API Resource	URL
Installation Guide	https://docs.flexcompute.com/projects/tidy3d/en/latest/install.html
Documentation	https://docs.flexcompute.com/projects/tidy3d/en/latest/index.html
Example Library	https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/docs/index.html
FAQ	https://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/index.html

Related Source Repositories

Name	Repository
Source Code	https://github.com/flexcompute/tidy3d
Example Notebooks	https://github.com/flexcompute/tidy3d-notebooks
FAQ Source Code	https://github.com/flexcompute/tidy3d-faq

Name		Name	Last commit message	Last commit date
Latest commit History 1,416 Commits
.binder		.binder
.github/workflows		.github/workflows
2025-10-09-invdes-seminar		2025-10-09-invdes-seminar
checks		checks
docs		docs
img		img
misc		misc
scripts		scripts
tests		tests
.gitattributes		.gitattributes
.gitconfig		.gitconfig
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.readthedocs.yaml		.readthedocs.yaml
8ChannelDemultiplexer.ipynb		8ChannelDemultiplexer.ipynb
90BendPolarizationSplitterRotator.ipynb		90BendPolarizationSplitterRotator.ipynb
90OpticalHybrid.ipynb		90OpticalHybrid.ipynb
AbsorbingBoundaryReflection.ipynb		AbsorbingBoundaryReflection.ipynb
AdiabaticCouplerLN.ipynb		AdiabaticCouplerLN.ipynb
AdvancedGaussianSources.ipynb		AdvancedGaussianSources.ipynb
AllDielectricStructuralColor.ipynb		AllDielectricStructuralColor.ipynb
AndersonLocalization.ipynb		AndersonLocalization.ipynb
AnimationTutorial.ipynb		AnimationTutorial.ipynb
AnisotropicBendsEME.ipynb		AnisotropicBendsEME.ipynb
AnisotropicMetamaterialBroadbandPBS.ipynb		AnisotropicMetamaterialBroadbandPBS.ipynb
AntiResonantHollowCoreFiber.ipynb		AntiResonantHollowCoreFiber.ipynb
AutoGrid.ipynb		AutoGrid.ipynb
Autograd0Overview.ipynb		Autograd0Overview.ipynb
Autograd0Quickstart.ipynb		Autograd0Quickstart.ipynb
Autograd0QuickstartII.ipynb		Autograd0QuickstartII.ipynb
Autograd10YBranchLevelSet.ipynb		Autograd10YBranchLevelSet.ipynb
Autograd12LightExtractor.ipynb		Autograd12LightExtractor.ipynb
Autograd13Metasurface.ipynb		Autograd13Metasurface.ipynb
Autograd15Antenna.ipynb		Autograd15Antenna.ipynb
Autograd16BilayerCoupler.ipynb		Autograd16BilayerCoupler.ipynb
Autograd17BandPassFilter.ipynb		Autograd17BandPassFilter.ipynb
Autograd18TopologyBend.ipynb		Autograd18TopologyBend.ipynb
Autograd19ApodizedCoupler.ipynb		Autograd19ApodizedCoupler.ipynb
Autograd1Intro.ipynb		Autograd1Intro.ipynb
Autograd20MetalensWaveguideTaper.ipynb		Autograd20MetalensWaveguideTaper.ipynb
Autograd21GaPLightExtractor.ipynb		Autograd21GaPLightExtractor.ipynb
Autograd22PhotonicCrystal.ipynb		Autograd22PhotonicCrystal.ipynb
Autograd23FabricationAwareInvdes.ipynb		Autograd23FabricationAwareInvdes.ipynb
Autograd24DigitalSplitter.ipynb		Autograd24DigitalSplitter.ipynb
Autograd25WaveguideCrossing.ipynb		Autograd25WaveguideCrossing.ipynb
Autograd26DiffractiveBeamSplitter.ipynb		Autograd26DiffractiveBeamSplitter.ipynb
Autograd27Smatrix.ipynb		Autograd27Smatrix.ipynb
Autograd28FiberLens.ipynb		Autograd28FiberLens.ipynb
Autograd29SourceGradients.ipynb		Autograd29SourceGradients.ipynb
Autograd2GradientChecking.ipynb		Autograd2GradientChecking.ipynb
Autograd30ParallelAdjoint.ipynb		Autograd30ParallelAdjoint.ipynb
Autograd31GratingCouplerWithBeamOptimization.ipynb		Autograd31GratingCouplerWithBeamOptimization.ipynb
Autograd3InverseDesign.ipynb		Autograd3InverseDesign.ipynb
Autograd4MultiObjective.ipynb		Autograd4MultiObjective.ipynb
Autograd5BoundaryGradients.ipynb		Autograd5BoundaryGradients.ipynb
Autograd6GratingCoupler.ipynb		Autograd6GratingCoupler.ipynb
Autograd7Metalens.ipynb		Autograd7Metalens.ipynb
Autograd8WaveguideBend.ipynb		Autograd8WaveguideBend.ipynb
Autograd9WDM.ipynb		Autograd9WDM.ipynb
AvalanchePhotodiode.ipynb		AvalanchePhotodiode.ipynb
Bandstructure.ipynb		Bandstructure.ipynb
BatchModeSolver.ipynb		BatchModeSolver.ipynb
BayesianOptimizationYJunction.ipynb		BayesianOptimizationYJunction.ipynb
BeerLambert.ipynb		BeerLambert.ipynb
BilayerSiNEdgeCoupler.ipynb		BilayerSiNEdgeCoupler.ipynb
BilayerSiNSiGC.ipynb		BilayerSiNSiGC.ipynb
BilevelPSR.ipynb		BilevelPSR.ipynb
BiosensorGrating.ipynb		BiosensorGrating.ipynb
BistablePCCavity.ipynb		BistablePCCavity.ipynb
BlueMicroLED.ipynb		BlueMicroLED.ipynb
BoundaryConditions.ipynb		BoundaryConditions.ipynb
BraggGratings.ipynb		BraggGratings.ipynb
BroadbandDirectionalCoupler.ipynb		BroadbandDirectionalCoupler.ipynb
BroadbandPlaneWaveWithConstantObliqueIncidentAngle.ipynb		BroadbandPlaneWaveWithConstantObliqueIncidentAngle.ipynb
BullseyeCavityPSO.ipynb		BullseyeCavityPSO.ipynb
CMOSRGBSensor.ipynb		CMOSRGBSensor.ipynb
CPOHeat.ipynb		CPOHeat.ipynb
CavityFOM.ipynb		CavityFOM.ipynb
ChargeSolver.ipynb		ChargeSolver.ipynb
CreatingGeometryUsingTrimesh.ipynb		CreatingGeometryUsingTrimesh.ipynb
CustomFieldSource.ipynb		CustomFieldSource.ipynb
CustomMediumTutorial.ipynb		CustomMediumTutorial.ipynb
Design.ipynb		Design.ipynb
DielectricMetasurfaceAbsorber.ipynb		DielectricMetasurfaceAbsorber.ipynb
DirectionalCoupler.ipynb		DirectionalCoupler.ipynb
DirectionalCouplerSurrogate.ipynb		DirectionalCouplerSurrogate.ipynb
DirectionalScatteringNanodisks.ipynb		DirectionalScatteringNanodisks.ipynb
DisorderedPlasmonicColor.ipynb		DisorderedPlasmonicColor.ipynb
Dispersion.ipynb		Dispersion.ipynb
DistributedBraggReflectorCavity.ipynb		DistributedBraggReflectorCavity.ipynb
DivergedFDTDSimulation.ipynb		DivergedFDTDSimulation.ipynb
EMEBends.ipynb		EMEBends.ipynb
EMESolver.ipynb		EMESolver.ipynb
EdgeCoupler.ipynb		EdgeCoupler.ipynb
EffectiveIndexApproximation.ipynb		EffectiveIndexApproximation.ipynb
EulerWaveguideBend.ipynb		EulerWaveguideBend.ipynb
FarFieldProjectionNonDecayingField.ipynb		FarFieldProjectionNonDecayingField.ipynb
FieldProjections.ipynb		FieldProjections.ipynb
Fitting.ipynb		Fitting.ipynb
FocusedApodGC.ipynb		FocusedApodGC.ipynb

Navigation Menu

Uh oh!

Repository files navigation

`tidy3d-notebooks`

Development Guidance

Common Documentation References

Related Source Repositories

About

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

tidy3d-notebooks

Development Guidance

Common Documentation References

Related Source Repositories

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

`tidy3d-notebooks`