diff --git a/docs/basics/index.rst b/docs/basics/index.rst index 9b2d6169..faac5ef4 100644 --- a/docs/basics/index.rst +++ b/docs/basics/index.rst @@ -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 \ No newline at end of file + Quickstart + Tidy3D First Walkthrough + Introduction on Tidy3D working principles + Running simulations through the cloud + How to troubleshoot a diverged FDTD simulation diff --git a/docs/case_studies/fiber.rst b/docs/case_studies/fiber.rst index 10eb08e7..3e38ad2d 100644 --- a/docs/case_studies/fiber.rst +++ b/docs/case_studies/fiber.rst @@ -7,4 +7,4 @@ Fiber optics play a crucial role in optical communication, enabling the transmis :class: example-notebook-toc :maxdepth: 1 - ../../AntiResonantHollowCoreFiber \ No newline at end of file + Anti-resonant hollow-core fiber diff --git a/docs/case_studies/lenses.rst b/docs/case_studies/lenses.rst index 4b2f7887..9219aad4 100644 --- a/docs/case_studies/lenses.rst +++ b/docs/case_studies/lenses.rst @@ -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 \ No newline at end of file + 3D optical Luneburg lens + Metalens in the visible frequency range + Mid-IR metalens based on silicon nanopillars + Spherical Fresnel lens diff --git a/docs/case_studies/metamaterials_gratings_periodic.rst b/docs/case_studies/metamaterials_gratings_periodic.rst index c0efe401..06c21741 100644 --- a/docs/case_studies/metamaterials_gratings_periodic.rst +++ b/docs/case_studies/metamaterials_gratings_periodic.rst @@ -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 + Gradient metasurface reflector + Graphene metamaterial absorber + Tunable chiral metasurface based on phase change material + Microwave frequency selective surface + High-Q silicon resonator + Germanium Fano metasurface + Multilevel blazed diffraction grating + Biosensor grating simulation + Distributed Bragg reflector and cavity + CMOS RGB image sensor + Plasmonic cavity resonator consisting of a gold nanorod array + All-dielectric structural colors + MIM resonator + Vortex beam metasurface diff --git a/docs/case_studies/microwave.rst b/docs/case_studies/microwave.rst index d0058ea5..5b78550d 100644 --- a/docs/case_studies/microwave.rst +++ b/docs/case_studies/microwave.rst @@ -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 + Radar absorbing metamaterial diff --git a/docs/case_studies/nanophotonics.rst b/docs/case_studies/nanophotonics.rst index 6db0b8ce..87f1909b 100644 --- a/docs/case_studies/nanophotonics.rst +++ b/docs/case_studies/nanophotonics.rst @@ -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 + Unidirectional SPP from non-Hermitian metagratings + Anderson localization of electromagnetic waves in 3D + Atomically thin waveguides based on MoS2 monolayers + Radiative cooling glass coating + Metal oxide sunscreen diff --git a/docs/case_studies/photonic_crystals.rst b/docs/case_studies/photonic_crystals.rst index 4eb1e74e..08c55947 100644 --- a/docs/case_studies/photonic_crystals.rst +++ b/docs/case_studies/photonic_crystals.rst @@ -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 + Optimized photonic crystal L3 cavity + Bistability in photonic crystal microcavities + Nanobeam cavity diff --git a/docs/case_studies/photonic_opt.rst b/docs/case_studies/photonic_opt.rst index 79e096bd..03b37eef 100644 --- a/docs/case_studies/photonic_opt.rst +++ b/docs/case_studies/photonic_opt.rst @@ -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 \ No newline at end of file + Particle swarm optimization of a polarization beam splitter + Particle swarm optimization of a bullseye cavity for quantum emitter light extraction + Compact on-chip optical switch design optimization using DBS + Optimization of an S-bend with CMA-ES + Genetic algorithm optimization of a silicon on-chip reflector diff --git a/docs/case_studies/pic.rst b/docs/case_studies/pic.rst index dcbcff9e..5d0f7359 100644 --- a/docs/case_studies/pic.rst +++ b/docs/case_studies/pic.rst @@ -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 + Waveguide to ring coupling + Waveguide crossing based on cosine tapers + Euler waveguide bend + Inverse taper edge coupler + 2D effective index approximation of 3D simulations + 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 + Thin film lithium niobate adiabatic waveguide coupler + Polarization splitter and rotator based on 90 degree bends + Plasmonic waveguide sensor for carbon dioxide detection + Bi-layer SiN edge coupler in the visible frequency + Dielectric waveguide with scale-invariant effective index + Unidirectional waveguide grating antenna + Free-form chip-to-chip coupler + MMI-based NIR/MIR demultiplexer + Dispersion calculation in tapered waveguide + Designing a polarization splitter/rotator on thin-film lithium niobate + Integrated plasmonic Vivaldi antenna with silicon waveguide + Generation of Kerr sideband + Broadband polarization beam splitter using anisotropic metamaterial diff --git a/docs/case_studies/pic_active.rst b/docs/case_studies/pic_active.rst index 0ad68295..85e5ca9c 100644 --- a/docs/case_studies/pic_active.rst +++ b/docs/case_studies/pic_active.rst @@ -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 + Thermally tuned ring resonator + Carrier injection based Mach-Zehnder modulator + Thermo-optic modulator with a doped silicon heater diff --git a/docs/case_studies/scattering_far_field.rst b/docs/case_studies/scattering_far_field.rst index 7cb148d4..f3a8b5e1 100644 --- a/docs/case_studies/scattering_far_field.rst +++ b/docs/case_studies/scattering_far_field.rst @@ -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 \ No newline at end of file + Scattering cross-section calculation of a dielectric sphere + Scattering of a plasmonic nanoparticle + Plasmonic Yagi-Uda nanoantenna + Field projection for a zone plate + Multipole expansion for electromagnetic scattering diff --git a/docs/features/adjoint.rst b/docs/features/adjoint.rst index be8e3967..637fd0ba 100644 --- a/docs/features/adjoint.rst +++ b/docs/features/adjoint.rst @@ -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 + Inverse design quickstart + 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 + Adjoint-based shape optimization of a waveguide bend + Adjoint optimization of a wavelength division multiplexer + Parameterized level set optimization of a y-branch + Inverse design integrated with circuit simulation + Adjoint inverse design of a quantum emitter light extractor + Diffractive metasurface inverse design with topology optimization + Machine learning-based fabrication constraints for inverse design using PreFab diff --git a/docs/features/advanced.rst b/docs/features/advanced.rst index e1ff9092..7bf38f81 100644 --- a/docs/features/advanced.rst +++ b/docs/features/advanced.rst @@ -7,5 +7,5 @@ In this section, we demonstrate more advanced applications of Tidy3D. For exampl :class: example-notebook-toc :maxdepth: 1 - ../../WaveguideBendSimulator - ../../SimpleModeSolverGUI \ No newline at end of file + Build a simple waveguide bend simulator GUI + Build a simple waveguide mode solver GUI diff --git a/docs/features/autograd.rst b/docs/features/autograd.rst index 2976df19..894823ca 100644 --- a/docs/features/autograd.rst +++ b/docs/features/autograd.rst @@ -7,26 +7,26 @@ The adjoint method is an extremely powerful tool for photonics optimization, all :class: example-notebook-toc :maxdepth: 1 - ../../InverseDesign - ../../Autograd0Quickstart - ../../Autograd1Intro - ../../Autograd2GradientChecking - ../../Autograd3InverseDesign - ../../Autograd4MultiObjective - ../../Autograd5BoundaryGradients - ../../Autograd6GratingCoupler - ../../Autograd7Metalens - ../../Autograd8WaveguideBend - ../../Autograd9WDM - ../../Autograd10YBranchLevelSet - ../../Autograd13Metasurface - ../../Autograd12LightExtractor - ../../Autograd15Antenna - ../../Autograd16BilayerCoupler - ../../Autograd17BandPassFilter - ../../Autograd18TopologyBend - ../../Autograd19ApodizedCoupler - ../../Autograd20MetalensWaveguideTaper - ../../Autograd21GaPLightExtractor - ../../Autograd22PhotonicCrystal - ../../Autograd23FabricationAwareInvdes + Inverse design plugin + Inverse design quickstart + Autograd, 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 + Adjoint-based shape optimization of a waveguide bend + Adjoint optimization of a wavelength division multiplexer + Parameterized level set optimization of a y-branch + Diffractive metasurface inverse design with topology optimization + Adjoint inverse design of a quantum emitter light extractor + Inverse design optimization of a plasmonic nanoantenna metasurface + Inverse design optimization of a bilayer grating coupler + Adjoint optimization of an integrated bandpass filter + Topology optimization of a waveguide bend + Inverse design of an apodized grating coupler through shape optimization + Design and shape optimization of a metalens-assisted waveguide taper + Inverse design of a GaP photon extractor for nitrogen-vacancy centers in diamond + Adjoint optimization of a photonic crystal + Fabrication-aware inverse design (FAID) of a wavelength division multiplexer diff --git a/docs/features/data_visualisation.rst b/docs/features/data_visualisation.rst index bb162fbe..9f63f5b4 100644 --- a/docs/features/data_visualisation.rst +++ b/docs/features/data_visualisation.rst @@ -7,9 +7,9 @@ Visualizing and analyzing data is crucial for validating and extracting meaningf :class: example-notebook-toc :maxdepth: 1 - ../../VizSimulation - ../../VizData - ../../XarrayTutorial - ../../AnimationTutorial - ../../FieldProjections - ../../UnstructuredData + Visualizing geometries in Tidy3D + Performing visualization of simulation data + Advanced monitor data (xarray) manipulation and visualization + Creating FDTD animations + Performing near field to far field projections + Unstructured datasets diff --git a/docs/features/eme.rst b/docs/features/eme.rst index 8aad93d5..e86b51e1 100644 --- a/docs/features/eme.rst +++ b/docs/features/eme.rst @@ -7,5 +7,5 @@ Eigenmode expansion (EME) is a frequency-domain method particularly suitable for :class: example-notebook-toc :maxdepth: 1 - ../../EMESolver - ../../EMEBends + EME solver + Simulating bent waveguides using the EME solver diff --git a/docs/features/grid.rst b/docs/features/grid.rst index 94eca860..9f9918bd 100644 --- a/docs/features/grid.rst +++ b/docs/features/grid.rst @@ -7,4 +7,6 @@ Tidy3D grid specifications enable the efficient simulation of intricate geometri :class: example-notebook-toc :maxdepth: 1 - ../../AutoGrid \ No newline at end of file + Using automatic nonuniform meshing + + diff --git a/docs/features/heat.rst b/docs/features/heat.rst index 89ec3248..310fe73b 100644 --- a/docs/features/heat.rst +++ b/docs/features/heat.rst @@ -7,4 +7,4 @@ This section introduces the HEAT solver, a Tidy3D feature that solves the steady :class: example-notebook-toc :maxdepth: 1 - ../../HeatSolver + Heat solver diff --git a/docs/features/medium.rst b/docs/features/medium.rst index 64036ecc..ef51bdd9 100644 --- a/docs/features/medium.rst +++ b/docs/features/medium.rst @@ -7,9 +7,9 @@ Tidy3D supports a variety of medium types: nondispersive, dispersive, anisotropi :class: example-notebook-toc :maxdepth: 1 - ../../Dispersion - ../../Fitting - ../../FullyAnisotropic - ../../Gyrotropic - ../../CustomMediumTutorial - ../../TimeModulationTutorial \ No newline at end of file + Modeling dispersive materials + Fitting dispersive material models + Defining fully anisotropic materials + Defining gyrotropic materials + Defining spatially-varying dielectric structures + Applying time modulation to materials diff --git a/docs/features/microwave.rst b/docs/features/microwave.rst index faed55da..21817f16 100644 --- a/docs/features/microwave.rst +++ b/docs/features/microwave.rst @@ -7,4 +7,4 @@ This section illustrates essential microwave simulation components, such as lump :class: example-notebook-toc :maxdepth: 1 - ../../CharacteristicImpedanceCalculator \ No newline at end of file + Computing the characteristic impedance of transmission lines using Tidy3D diff --git a/docs/features/mode.rst b/docs/features/mode.rst index 3c920ead..6a216a96 100644 --- a/docs/features/mode.rst +++ b/docs/features/mode.rst @@ -7,7 +7,7 @@ Tidy3D offers convenient plugins for optical and waveguide mode analysis. With m :class: example-notebook-toc :maxdepth: 1 - ../../ModeSolver - ../../WaveguidePluginDemonstration - ../../BatchModeSolver - ../../RadiativeLossesModeSolver + Using the mode solver for optical mode analysis + Using the waveguide plugin to analyze waveguide modes + Running mode solver tasks in parallel + Radiative losses analysis with ModeSolver diff --git a/docs/features/parameter_sweep.rst b/docs/features/parameter_sweep.rst index c897dc3a..d7999321 100644 --- a/docs/features/parameter_sweep.rst +++ b/docs/features/parameter_sweep.rst @@ -7,5 +7,5 @@ Tidy3D excels at exploring a high-dimensional design space because it is able to :class: example-notebook-toc :maxdepth: 1 - ../../ParameterScan - ../../Design \ No newline at end of file + Performing parallel / batch processing of simulations + Design Space Exploration Plugin diff --git a/docs/features/resonance.rst b/docs/features/resonance.rst index 41f157f2..7afd0d43 100644 --- a/docs/features/resonance.rst +++ b/docs/features/resonance.rst @@ -7,5 +7,5 @@ Analyzing resonant frequencies in photonic cavities is a common task in electrom :class: example-notebook-toc :maxdepth: 1 - ../../ResonanceFinder - ../../CavityFOM \ No newline at end of file + Extracting resonance information using Resonance Finder + Cavity quality factor, effective mode volume, and Purcell factor diff --git a/docs/features/scattering_matrix.rst b/docs/features/scattering_matrix.rst index 4a28f7f1..d9fbf231 100644 --- a/docs/features/scattering_matrix.rst +++ b/docs/features/scattering_matrix.rst @@ -7,4 +7,4 @@ The scattering matrix (S-matrix) calculation is a fundamental aspect of analyzin :class: example-notebook-toc :maxdepth: 1 - ../../SMatrix \ No newline at end of file + Computing the scattering matrix of a device diff --git a/docs/features/sources.rst b/docs/features/sources.rst index 6210d956..3610229e 100644 --- a/docs/features/sources.rst +++ b/docs/features/sources.rst @@ -7,7 +7,7 @@ Sources are a fundamental component for input power in electromagnetic simulatio :class: example-notebook-toc :maxdepth: 1 - ../../ModalSourcesMonitors - ../../ModesBentAngled - ../../TFSF - ../../CustomFieldSource + Defining mode sources and monitors + Injecting modes in bent and angled waveguides + Defining a total-field scattered-field (TFSF) plane wave source + Defining spatially-varying sources diff --git a/docs/features/structures.rst b/docs/features/structures.rst index f8d73e70..039a0127 100644 --- a/docs/features/structures.rst +++ b/docs/features/structures.rst @@ -7,11 +7,11 @@ Tidy3D natively supports the definition of various primitive geometries such as :class: example-notebook-toc :maxdepth: 1 - ../../GDSImport - ../../GDSExport - ../../STLImport - ../../SelfIntersectingPolyslab - ../../GeometryTransformations - ../../PICComponents - ../../PhotonicCrystalsComponents - ../../CreatingGeometryUsingTrimesh + Importing GDS files + Export to GDS file + Importing STL files + Defining self-intersecting polygons + Geometry transformations + Defining common integrated photonic components + Defining common photonic crystal structures + Defining complex geometries using trimesh diff --git a/docs/features/symmetry.rst b/docs/features/symmetry.rst index 6069fac4..ac7c1a83 100644 --- a/docs/features/symmetry.rst +++ b/docs/features/symmetry.rst @@ -5,6 +5,6 @@ Boundary Conditions & Symmetry :class: example-notebook-toc :maxdepth: 1 - ../../BoundaryConditions - ../../Symmetry - ../../AbsorbingBoundaryReflection \ No newline at end of file + Setting up boundary conditions + Defining and using symmetries + Suppressing artificial reflections with absorber and PML boundaries