Skip to content

🚨 🌐 Migrate docs structure to links to webcenter #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/basics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ This section provides a quick and general introduction to Tidy3D, serving as a g
:class: example-notebook-toc
:maxdepth: 0

../../StartHere
../../Simulation
../../Primer
../../WebAPI
../../DivergedFDTDSimulation
Quickstart <https://www.flexcompute.com/tidy3d/examples/notebooks/StartHere>
Tidy3D First Walkthrough <https://www.flexcompute.com/tidy3d/examples/notebooks/Simulation>
Introduction on Tidy3D working principles <https://www.flexcompute.com/tidy3d/examples/notebooks/Primer>
Running simulations through the cloud <https://www.flexcompute.com/tidy3d/examples/notebooks/WebAPI>
How to troubleshoot a diverged FDTD simulation <https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation>
2 changes: 1 addition & 1 deletion docs/case_studies/fiber.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Fiber optics play a crucial role in optical communication, enabling the transmis
:class: example-notebook-toc
:maxdepth: 1

../../AntiResonantHollowCoreFiber
Anti-resonant hollow-core fiber <https://www.flexcompute.com/tidy3d/examples/notebooks/AntiResonantHollowCoreFiber>
8 changes: 4 additions & 4 deletions docs/case_studies/lenses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Lenses are pivotal components in many optical systems. In this section, we delve
:class: example-notebook-toc
:maxdepth: 1

../../OpticalLuneburgLens
../../Metalens
../../MidIRMetalens
../../FresnelLens
3D optical Luneburg lens <https://www.flexcompute.com/tidy3d/examples/notebooks/OpticalLuneburgLens>
Metalens in the visible frequency range <https://www.flexcompute.com/tidy3d/examples/notebooks/Metalens>
Mid-IR metalens based on silicon nanopillars <https://www.flexcompute.com/tidy3d/examples/notebooks/MidIRMetalens>
Spherical Fresnel lens <https://www.flexcompute.com/tidy3d/examples/notebooks/FresnelLens>
30 changes: 15 additions & 15 deletions docs/case_studies/metamaterials_gratings_periodic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ In addition, Tidy3D’s speed and scalability allow users to model the response
:class: example-notebook-toc
:maxdepth: 1

../../DielectricMetasurfaceAbsorber
../../GradientMetasurfaceReflector
../../GrapheneMetamaterial
../../TunableChiralMetasurface
../../MicrowaveFrequencySelectiveSurface
../../HighQSi
../../HighQGe
../../GratingEfficiency
../../BiosensorGrating
../../DistributedBraggReflectorCavity
../../CMOSRGBSensor
../../PlasmonicNanorodArray
../../AllDielectricStructuralColor
../../MIMResonator
../../VortexMetasurface
Dielectric metasurface absorber <https://www.flexcompute.com/tidy3d/examples/notebooks/DielectricMetasurfaceAbsorber>
Gradient metasurface reflector <https://www.flexcompute.com/tidy3d/examples/notebooks/GradientMetasurfaceReflector>
Graphene metamaterial absorber <https://www.flexcompute.com/tidy3d/examples/notebooks/GrapheneMetamaterial>
Tunable chiral metasurface based on phase change material <https://www.flexcompute.com/tidy3d/examples/notebooks/TunableChiralMetasurface>
Microwave frequency selective surface <https://www.flexcompute.com/tidy3d/examples/notebooks/MicrowaveFrequencySelectiveSurface>
High-Q silicon resonator <https://www.flexcompute.com/tidy3d/examples/notebooks/HighQSi>
Germanium Fano metasurface <https://www.flexcompute.com/tidy3d/examples/notebooks/HighQGe>
Multilevel blazed diffraction grating <https://www.flexcompute.com/tidy3d/examples/notebooks/GratingEfficiency>
Biosensor grating simulation <https://www.flexcompute.com/tidy3d/examples/notebooks/BiosensorGrating>
Distributed Bragg reflector and cavity <https://www.flexcompute.com/tidy3d/examples/notebooks/DistributedBraggReflectorCavity>
CMOS RGB image sensor <https://www.flexcompute.com/tidy3d/examples/notebooks/CMOSRGBSensor>
Plasmonic cavity resonator consisting of a gold nanorod array <https://www.flexcompute.com/tidy3d/examples/notebooks/PlasmonicNanorodArray>
All-dielectric structural colors <https://www.flexcompute.com/tidy3d/examples/notebooks/AllDielectricStructuralColor>
MIM resonator <https://www.flexcompute.com/tidy3d/examples/notebooks/MIMResonator>
Vortex beam metasurface <https://www.flexcompute.com/tidy3d/examples/notebooks/VortexMetasurface>
4 changes: 2 additions & 2 deletions docs/case_studies/microwave.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Microwave and RF (Radio Frequency) devices are essential for communication and s
:class: example-notebook-toc
:maxdepth: 1

../../CoupledLineBandpassFilter
../../RadarAbsorbingMetamaterial
Designing and optimizing a coupled line bandpass filter <https://www.flexcompute.com/tidy3d/examples/notebooks/CoupledLineBandpassFilter>
Radar absorbing metamaterial <https://www.flexcompute.com/tidy3d/examples/notebooks/RadarAbsorbingMetamaterial>
12 changes: 6 additions & 6 deletions docs/case_studies/nanophotonics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Nanophotonics, a broad field at the intersection of photonics and nanotechnology
:class: example-notebook-toc
:maxdepth: 1

../../NanostructuredBoronNitride
../../NonHermitianMetagratings
../../AndersonLocalization
../../MoS2Waveguide
../../RadiativeCoolingGlass
../../MetalOxideSunscreen
Hyperbolic polaritons in nanostructured hBN <https://www.flexcompute.com/tidy3d/examples/notebooks/NanostructuredBoronNitride>
Unidirectional SPP from non-Hermitian metagratings <https://www.flexcompute.com/tidy3d/examples/notebooks/NonHermitianMetagratings>
Anderson localization of electromagnetic waves in 3D <https://www.flexcompute.com/tidy3d/examples/notebooks/AndersonLocalization>
Atomically thin waveguides based on MoS2 monolayers <https://www.flexcompute.com/tidy3d/examples/notebooks/MoS2Waveguide>
Radiative cooling glass coating <https://www.flexcompute.com/tidy3d/examples/notebooks/RadiativeCoolingGlass>
Metal oxide sunscreen <https://www.flexcompute.com/tidy3d/examples/notebooks/MetalOxideSunscreen>
8 changes: 4 additions & 4 deletions docs/case_studies/photonic_crystals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Photonic crystals utilize periodic optical nanostructures to affect the motion o
:class: example-notebook-toc
:maxdepth: 1

../../Bandstructure
../../OptimizedL3
../../BistablePCCavity
../../NanobeamCavity
Band structure calculation of a photonic crystal slab <https://www.flexcompute.com/tidy3d/examples/notebooks/Bandstructure>
Optimized photonic crystal L3 cavity <https://www.flexcompute.com/tidy3d/examples/notebooks/OptimizedL3>
Bistability in photonic crystal microcavities <https://www.flexcompute.com/tidy3d/examples/notebooks/BistablePCCavity>
Nanobeam cavity <https://www.flexcompute.com/tidy3d/examples/notebooks/NanobeamCavity>
10 changes: 5 additions & 5 deletions docs/case_studies/photonic_opt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ For gradient-based optimization examples, please see the inverse design/ adjoint
:class: example-notebook-toc
:maxdepth: 1

../../ParticleSwarmOptimizedPBS
../../BullseyeCavityPSO
../../OpticalSwitchDBS
../../SbendCMAES
../../GeneticAlgorithmReflector
Particle swarm optimization of a polarization beam splitter <https://www.flexcompute.com/tidy3d/examples/notebooks/ParticleSwarmOptimizedPBS>
Particle swarm optimization of a bullseye cavity for quantum emitter light extraction <https://www.flexcompute.com/tidy3d/examples/notebooks/BullseyeCavityPSO>
Compact on-chip optical switch design optimization using DBS <https://www.flexcompute.com/tidy3d/examples/notebooks/OpticalSwitchDBS>
Optimization of an S-bend with CMA-ES <https://www.flexcompute.com/tidy3d/examples/notebooks/SbendCMAES>
Genetic algorithm optimization of a silicon on-chip reflector <https://www.flexcompute.com/tidy3d/examples/notebooks/GeneticAlgorithmReflector>
70 changes: 35 additions & 35 deletions docs/case_studies/pic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,38 @@ Passive photonic integrated circuit (PIC) components form the backbone of many o
:class: example-notebook-toc
:maxdepth: 1

../../YJunction
../../WaveguideToRingCoupling
../../WaveguideCrossing
../../EulerWaveguideBend
../../EdgeCoupler
../../EffectiveIndexApproximation
../../GratingCoupler
../../FocusedApodGC
../../MMI1x4
../../RingResonator
../../BilevelPSR
../../WaveguideSizeConverter
../../StripToSlotConverters
../../BraggGratings
../../BroadbandDirectionalCoupler
../../PolarizationSplitterRotator
../../8ChannelDemultiplexer
../../THzDemultiplexerFilter
../../PhotonicCrystalWaveguidePolarizationFilter
../../90OpticalHybrid
../../SWGBroadbandPolarizer
../../ZeroCrossTalkTE
../../AdiabaticCouplerLN
../../90BendPolarizationSplitterRotator
../../PlasmonicWaveguideCO2Sensor
../../BilayerSiNEdgeCoupler
../../ScaleInvariantWaveguide
../../WaveguideGratingAntenna
../../FreeFormCoupler
../../MultiplexingMMI
../../TaperedWgDispersion
../../LNOIPolarizationSplitterRotator
../../IntegratedVivaldiAntenna
../../KerrSidebands
../../AnisotropicMetamaterialBroadbandPBS
Waveguide Y junction <https://www.flexcompute.com/tidy3d/examples/notebooks/YJunction>
Waveguide to ring coupling <https://www.flexcompute.com/tidy3d/examples/notebooks/WaveguideToRingCoupling>
Waveguide crossing based on cosine tapers <https://www.flexcompute.com/tidy3d/examples/notebooks/WaveguideCrossing>
Euler waveguide bend <https://www.flexcompute.com/tidy3d/examples/notebooks/EulerWaveguideBend>
Inverse taper edge coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/EdgeCoupler>
2D effective index approximation of 3D simulations <https://www.flexcompute.com/tidy3d/examples/notebooks/EffectiveIndexApproximation>
Uniform grating coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/GratingCoupler>
Focusing apodized grating coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/FocusedApodGC>
1x4 MMI power splitter <https://www.flexcompute.com/tidy3d/examples/notebooks/MMI1x4>
2D ring resonator <https://www.flexcompute.com/tidy3d/examples/notebooks/RingResonator>
Broadband bi-level taper polarization rotator-splitter <https://www.flexcompute.com/tidy3d/examples/notebooks/BilevelPSR>
Waveguide mode size converters <https://www.flexcompute.com/tidy3d/examples/notebooks/WaveguideSizeConverter>
Strip to slot waveguide converters <https://www.flexcompute.com/tidy3d/examples/notebooks/StripToSlotConverters>
Waveguide bragg gratings <https://www.flexcompute.com/tidy3d/examples/notebooks/BraggGratings>
Broadband directional coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/BroadbandDirectionalCoupler>
Compact polarization splitter-rotator <https://www.flexcompute.com/tidy3d/examples/notebooks/PolarizationSplitterRotator>
8-Channel mode and polarization de-multiplexer <https://www.flexcompute.com/tidy3d/examples/notebooks/8ChannelDemultiplexer>
THz integrated demultiplexer/filter based on a ring resonator <https://www.flexcompute.com/tidy3d/examples/notebooks/THzDemultiplexerFilter>
Photonic crystal waveguide polarization filter <https://www.flexcompute.com/tidy3d/examples/notebooks/PhotonicCrystalWaveguidePolarizationFilter>
90 degree optical hybrid <https://www.flexcompute.com/tidy3d/examples/notebooks/90OpticalHybrid>
Broadband polarizer assisted by anisotropic metamaterial <https://www.flexcompute.com/tidy3d/examples/notebooks/SWGBroadbandPolarizer>
Exceptional coupling for waveguide crosstalk reduction <https://www.flexcompute.com/tidy3d/examples/notebooks/ZeroCrossTalkTE>
Thin film lithium niobate adiabatic waveguide coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/AdiabaticCouplerLN>
Polarization splitter and rotator based on 90 degree bends <https://www.flexcompute.com/tidy3d/examples/notebooks/90BendPolarizationSplitterRotator>
Plasmonic waveguide sensor for carbon dioxide detection <https://www.flexcompute.com/tidy3d/examples/notebooks/PlasmonicWaveguideCO2Sensor>
Bi-layer SiN edge coupler in the visible frequency <https://www.flexcompute.com/tidy3d/examples/notebooks/BilayerSiNEdgeCoupler>
Dielectric waveguide with scale-invariant effective index <https://www.flexcompute.com/tidy3d/examples/notebooks/ScaleInvariantWaveguide>
Unidirectional waveguide grating antenna <https://www.flexcompute.com/tidy3d/examples/notebooks/WaveguideGratingAntenna>
Free-form chip-to-chip coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/FreeFormCoupler>
MMI-based NIR/MIR demultiplexer <https://www.flexcompute.com/tidy3d/examples/notebooks/MultiplexingMMI>
Dispersion calculation in tapered waveguide <https://www.flexcompute.com/tidy3d/examples/notebooks/TaperedWgDispersion>
Designing a polarization splitter/rotator on thin-film lithium niobate <https://www.flexcompute.com/tidy3d/examples/notebooks/LNOIPolarizationSplitterRotator>
Integrated plasmonic Vivaldi antenna with silicon waveguide <https://www.flexcompute.com/tidy3d/examples/notebooks/IntegratedVivaldiAntenna>
Generation of Kerr sideband <https://www.flexcompute.com/tidy3d/examples/notebooks/KerrSidebands>
Broadband polarization beam splitter using anisotropic metamaterial <https://www.flexcompute.com/tidy3d/examples/notebooks/AnisotropicMetamaterialBroadbandPBS>
8 changes: 4 additions & 4 deletions docs/case_studies/pic_active.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ At the moment, Tidy3D’s heat solver can be used with the FDTD solver to model
:class: example-notebook-toc
:maxdepth: 1

../../MetalHeaterPhaseShifter
../../ThermallyTunedRingResonator
../../MachZehnderModulator
../../ThermoOpticDopedModulator
Thermally tuned waveguide <https://www.flexcompute.com/tidy3d/examples/notebooks/MetalHeaterPhaseShifter>
Thermally tuned ring resonator <https://www.flexcompute.com/tidy3d/examples/notebooks/ThermallyTunedRingResonator>
Carrier injection based Mach-Zehnder modulator <https://www.flexcompute.com/tidy3d/examples/notebooks/MachZehnderModulator>
Thermo-optic modulator with a doped silicon heater <https://www.flexcompute.com/tidy3d/examples/notebooks/ThermoOpticDopedModulator>
10 changes: 5 additions & 5 deletions docs/case_studies/scattering_far_field.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ In this section, we explore the interaction between light and materials at the n
:class: example-notebook-toc
:maxdepth: 1

../../Near2FarSphereRCS
../../PlasmonicNanoparticle
../../PlasmonicYagiUdaNanoantenna
../../ZonePlateFieldProjection
../../MultipoleExpansion
Scattering cross-section calculation of a dielectric sphere <https://www.flexcompute.com/tidy3d/examples/notebooks/Near2FarSphereRCS>
Scattering of a plasmonic nanoparticle <https://www.flexcompute.com/tidy3d/examples/notebooks/PlasmonicNanoparticle>
Plasmonic Yagi-Uda nanoantenna <https://www.flexcompute.com/tidy3d/examples/notebooks/PlasmonicYagiUdaNanoantenna>
Field projection for a zone plate <https://www.flexcompute.com/tidy3d/examples/notebooks/ZonePlateFieldProjection>
Multipole expansion for electromagnetic scattering <https://www.flexcompute.com/tidy3d/examples/notebooks/MultipoleExpansion>
32 changes: 16 additions & 16 deletions docs/features/adjoint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ For gradient-free optimization examples, please see the global optimization sect
:class: example-notebook-toc
:maxdepth: 1

../../Invdes
../../AdjointPlugin0Quickstart
../../AdjointPlugin1Intro
../../AdjointPlugin2GradientChecking
../../AdjointPlugin3InverseDesign
../../AdjointPlugin4MultiObjective
../../AdjointPlugin5BoundaryGradients
../../AdjointPlugin6GratingCoupler
../../AdjointPlugin7Metalens
../../AdjointPlugin8WaveguideBend
../../AdjointPlugin9WDM
../../AdjointPlugin10YBranchLevelSet
../../AdjointPlugin11CircuitMZI
../../AdjointPlugin12LightExtractor
../../AdjointPlugin13Metasurface
../../AdjointPlugin14PreFab
Inverse design plugin <https://www.flexcompute.com/tidy3d/examples/notebooks/InverseDesign/>
Inverse design quickstart <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin0Quickstart>
Jax, automatic differentiation, and adjoint optimization: basics <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin1Intro>
Adjoint analysis of a multi-layer slab <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin2GradientChecking>
Inverse design optimization of a mode converter <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin3InverseDesign>
Multi-objective adjoint optimization <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin4MultiObjective>
Inverse design optimization of a waveguide taper <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin5BoundaryGradients>
Inverse design optimization of a compact grating coupler <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin6GratingCoupler>
Inverse design optimization of a metalens <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin7Metalens>
Adjoint-based shape optimization of a waveguide bend <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin8WaveguideBend>
Adjoint optimization of a wavelength division multiplexer <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin9WDM>
Parameterized level set optimization of a y-branch <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin10YBranchLevelSet>
Inverse design integrated with circuit simulation <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin11CircuitMZI>
Adjoint inverse design of a quantum emitter light extractor <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin12LightExtractor>
Diffractive metasurface inverse design with topology optimization <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin13Metasurface>
Machine learning-based fabrication constraints for inverse design using PreFab <https://www.flexcompute.com/tidy3d/examples/notebooks/AdjointPlugin14PreFab>
4 changes: 2 additions & 2 deletions docs/features/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ In this section, we demonstrate more advanced applications of Tidy3D. For exampl
:class: example-notebook-toc
:maxdepth: 1

../../WaveguideBendSimulator
../../SimpleModeSolverGUI
Build a simple waveguide bend simulator GUI <https://www.flexcompute.com/tidy3d/examples/notebooks/WaveguideBendSimulator>
Build a simple waveguide mode solver GUI <https://www.flexcompute.com/tidy3d/examples/notebooks/SimpleModeSolverGUI>
Loading