Skip to content

Commit

Permalink
Backlink building for SEO
Browse files Browse the repository at this point in the history
  • Loading branch information
tomflexcompute committed Nov 15, 2023
1 parent f5f270f commit 8606204
Show file tree
Hide file tree
Showing 41 changed files with 1,876 additions and 214 deletions.
12 changes: 7 additions & 5 deletions docs/source/notebooks/8ChannelDemultiplexer.ipynb

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions docs/source/notebooks/90BendPolarizationSplitterRotator.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -12885,12 +12885,11 @@
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "358aa00e",
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": []
"source": [
" > For more integrated photonic examples such as the [8-Channel mode and polarization de-multiplexer](https://www.flexcompute.com/tidy3d/examples/notebooks/8ChannelDemultiplexer/), the [broadband bi-level taper polarization rotator-splitter](https://www.flexcompute.com/tidy3d/examples/notebooks/BilevelPSR/), and the [broadband directional coupler](https://www.flexcompute.com/tidy3d/examples/notebooks/BroadbandDirectionalCoupler/), please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it. "
]
}
],
"metadata": {
Expand Down
10 changes: 5 additions & 5 deletions docs/source/notebooks/AdiabaticCouplerLN.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source/notebooks/AdjointPlugin10YBranchLevelSet.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/notebooks/AdjointPlugin11CircuitMZI.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": "9347ddbd-a499-412d-941e-12fd17d429ab",
"metadata": {},
"source": [
"# Inverse Design Integrated with Circuit Simulation\n",
"# Inverse design integrated with circuit simulation\n",
"\n",
"In this tutorial, we will show how to integrate the `adjoint` plugin of `Tidy3D` with a differentiable optical circuit simulator `sax`. This allows one to model a complicated circuit composed of many connected components, each simulated independently using `Tidy3D`. Through the `adjoint` plugin and `jax`, the gradients of all of the individual components are similarly connected. This allows one to write an objective function in terms of the scattering matrix of the entire circuit and optimize this function with respect to the design parameters in each of the individual `Tidy3D` simulations.\n",
"\n",
Expand Down Expand Up @@ -2504,7 +2504,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.9"
"version": "3.10.12"
}
},
"nbformat": 4,
Expand Down
107 changes: 1 addition & 106 deletions docs/source/notebooks/AdjointPlugin6GratingCoupler.ipynb

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/source/notebooks/BilevelPSR.ipynb

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/source/notebooks/BistablePCCavity.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
"\n",
"<center><img src=\"img/bistability.png\" alt=\"diagram\" width=\"600\"/></center>\n",
"\n",
"For more simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it.\n",
"\n",
"## Setup\n",
"\n",
"We first import the packages we'll need."
Expand Down
2 changes: 1 addition & 1 deletion docs/source/notebooks/BoundaryConditions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"This notebook will give a tutorial on setting up boundary conditions in `Tidy3D`.\n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. "
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. For simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notebooks/DielectricMetasurfaceAbsorber.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"\n",
"In Tidy3D's example library, we have demonstrated a [gradient metasurface reflector](https://www.flexcompute.com/tidy3d/examples/notebooks/GradientMetasurfaceReflector/), a [metalens at the visible frequency](https://www.flexcompute.com/tidy3d/examples/notebooks/Metalens/), and a [graphene metamaterial absorber](https://www.flexcompute.com/tidy3d/examples/notebooks/GrapheneMetamaterial/). In addition, we also investigated a [frequency selected surface](https://www.flexcompute.com/tidy3d/examples/notebooks/MicrowaveFrequencySelectiveSurface/) for the microwave frequency range. \n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. "
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down Expand Up @@ -1981,7 +1981,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"nbdime-conflicts": {
"local_diff": [
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notebooks/Dispersion.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"\n",
"Here we show how to model dispersive materials in `Tidy3D` with an example showing transmission spectrum of a multilayer stack of slabs.\n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. "
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. For simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down Expand Up @@ -1370,7 +1370,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Modeling Dispersive Materials in Tidy3D | Flexcompute",
"widgets": {
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notebooks/DistributedBraggReflectorCavity.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"\n",
"For a relevant example, please see the [waveguide bragg gratings notebook](https://www.flexcompute.com/tidy3d/examples/notebooks/BraggGratings/).\n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. "
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. For more simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down Expand Up @@ -1406,7 +1406,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Distributed Bragg Reflector and Cavity | Flexcompute",
"widgets": {
Expand Down
1,739 changes: 1,738 additions & 1 deletion docs/source/notebooks/DivergedFDTDSimulation.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/notebooks/EdgeCoupler.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"\n",
"In this notebook, we will show an example of using Tidy3D to evaluate the performance of edge couplers built using inverted taper mode transformers of linear, quadratic, and exponential profiles. We will also see how to set up a [Gaussian beam](../_autosummary/tidy3d.GaussianBeam.html) to simulate the field launched by a lensed fiber and the use of [Batch](../_autosummary/tidy3d.web.Batch.html) simulations to perform parameter sweeps.\n",
"\n",
"For more integrated photonic examples such as the [8-Channel mode and polarization de-multiplexer](https://www.flexcompute.com/tidy3d/examples/notebooks/8ChannelDemultiplexer/), the [broadband bi-level taper polarization rotator-splitter](https://www.flexcompute.com/tidy3d/examples/notebooks/BilevelPSR/), and the [broadband directional coupler](https://www.flexcompute.com/tidy3d/examples/notebooks/BroadbandDirectionalCoupler/), please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/)."
"For more integrated photonic examples such as the [8-Channel mode and polarization de-multiplexer](https://www.flexcompute.com/tidy3d/examples/notebooks/8ChannelDemultiplexer/), the [broadband bi-level taper polarization rotator-splitter](https://www.flexcompute.com/tidy3d/examples/notebooks/BilevelPSR/), and the [broadband directional coupler](https://www.flexcompute.com/tidy3d/examples/notebooks/BroadbandDirectionalCoupler/), please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down Expand Up @@ -2577,7 +2577,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Inverse Taper Edge Coupler Modeling in Tidy3D | Flexcompute",
"vscode": {
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notebooks/Fitting.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"`Tidy3D`'s dispersion fitting tool peforms an optimization to find a medium defined as a dispersive [PoleResidue](../_autosummary/tidy3d.PoleResidue.html) model that minimizes the RMS error between the model results and the data. This can then be directly used as a material in simulations.\n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. \n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. For simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it.\n",
"\n",
"We recommend using the [FastDispersionFitter](../_autosummary/tidy3d.plugins.dispersion.FastDispersionFitter.html), with advanced options configurable using the [AdvancedFastFitterParam](../_autosummary/tidy3d.plugins.dispersion.AdvancedFastFitterParam.html). As a backup, we also offer another fitter that uses global optimization and is based on a webservice. See below for the usage details of this dispersion fitter webservice."
]
Expand Down Expand Up @@ -672,7 +672,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Fitting Dispersive Material Models in Tidy3D | Flexcompute",
"widgets": {
Expand Down
8 changes: 6 additions & 2 deletions docs/source/notebooks/FocusedApodGC.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@
"\n",
"In this notebook, we will design a focusing apodized grating coupler (GC) to vertically couple light in/out photonic integrated circuits (PICs). We will build the grating coupler following the design guidelines presented in the following paper: R. Marchetti, C. Lacava, A. Khokhar, et al. \"High-efficiency grating-couplers: demonstration of a new design strategy,\" Sci Rep 7, 16670 (2017) [DOI: 10.1038/s41598-017-16505-z](https://doi.org/10.1038/s41598-017-16505-z). In a previous case study, we modeled an [uniform grating coupler](https://www.flexcompute.com/tidy3d/examples/notebooks/GratingCoupler/). The apodized grating coupler demonstrated in this notebook shows superior performance.\n",
"\n",
"To begin, we import the typical Python packages along with `tidy3d` and its plugins."
"For more integrated photonic examples such as the [8-Channel mode and polarization de-multiplexer](https://www.flexcompute.com/tidy3d/examples/notebooks/8ChannelDemultiplexer/), the [broadband bi-level taper polarization rotator-splitter](https://www.flexcompute.com/tidy3d/examples/notebooks/BilevelPSR/), and the [broadband directional coupler](https://www.flexcompute.com/tidy3d/examples/notebooks/BroadbandDirectionalCoupler/), please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/).\n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. \n",
"\n",
"FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it. "
]
},
{
Expand Down Expand Up @@ -1580,7 +1584,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Focusing Apodized Grating Coupler | Flexcompute",
"widgets": {
Expand Down
18 changes: 9 additions & 9 deletions docs/source/notebooks/FresnelLens.ipynb

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/source/notebooks/FullyAnisotropic.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
"source": [
"# Defining fully anisotropic materials\n",
"\n",
"`Tidy3D`'s capabilities include modeling of non-dispersive [fully anisotropic materials](../_autosummary/tidy3d.FullyAnisotropicMedium.html). In this tutorial we explain how to set up and run a simulation containing such materials. Specifically, we will consider scattering of a plane wave from fully anisotropic dielectric spheres and compare results to an equivalent setup containing only diagonally anisotropic materials."
"`Tidy3D`'s capabilities include modeling of non-dispersive [fully anisotropic materials](../_autosummary/tidy3d.FullyAnisotropicMedium.html). In this tutorial we explain how to set up and run a simulation containing such materials. Specifically, we will consider scattering of a plane wave from fully anisotropic dielectric spheres and compare results to an equivalent setup containing only diagonally anisotropic materials.\n",
"\n",
"For simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notebooks/GrapheneMetamaterial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"\n",
"<img src=\"img/graphene_metamaterial_schematic.png\" width=\"400\" alt=\"Schematic of the graphene metamaterial absorber\">\n",
"\n",
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. "
"If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. For more simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down Expand Up @@ -2035,7 +2035,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Graphene Metamaterial Absorber | Flexcompute",
"widgets": {
Expand Down
4 changes: 3 additions & 1 deletion docs/source/notebooks/Gyrotropic.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
"where $\\varepsilon_u$ and $\\sigma_u$ are real symmetric matrices describing unperturbed permittivity and conductivity of the material, and $G$ is a real antisymmetric matrix representing the magneto-optic effect. That is, \n",
"$$G = \\begin{pmatrix} 0 & g_z & -g_y \\\\ -g_z & 0 & g_x \\\\ g_y & -g_x & 0\\end{pmatrix}$$\n",
"for a gyration vector $\\boldsymbol{g} = \\begin{pmatrix} g_x & g_y & g_z \\end{pmatrix}$. Denoting the electromagnetic frequency of interest as $\\omega_0$, we can approximate the complex permittivity of material in the vicinity of $\\omega_0$ as $$\\varepsilon \\approx \\varepsilon_u + i \\frac{1}{\\omega} \\left( \\sigma_u + \\varepsilon_0 G \\omega_0 \\right).$$ \n",
"Thus, the gyrotropic effect of a medium can be modeled by providing a modified conductivity tensor $\\sigma = \\sigma_u + \\varepsilon_0 G \\omega_0$ that contains both symmetric and antisymmetric parts. Note that because of this approximation, the simulation results will be most accurate in the vicinity of the frequency of interest $\\omega_0$."
"Thus, the gyrotropic effect of a medium can be modeled by providing a modified conductivity tensor $\\sigma = \\sigma_u + \\varepsilon_0 G \\omega_0$ that contains both symmetric and antisymmetric parts. Note that because of this approximation, the simulation results will be most accurate in the vicinity of the frequency of interest $\\omega_0$.\n",
"\n",
"For more simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notebooks/HighQGe.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"\n",
"To do this calculation, we use a broadband pulse and frequency monitor to measure the flux on the opposite side of the structure.\n",
"\n",
"Please check out another case study where we investigated a high-Q [silicon Fano resonator](https://www.flexcompute.com/tidy3d/examples/notebooks/HighQSi/)."
"Please check out another case study where we investigated a high-Q [silicon Fano resonator](https://www.flexcompute.com/tidy3d/examples/notebooks/HighQSi/). For more simulation examples, please visit our [examples page](https://www.flexcompute.com/tidy3d/examples/). If you are new to the finite-difference time-domain (FDTD) method, we highly recommend going through our [FDTD101](https://www.flexcompute.com/fdtd101/) tutorials. FDTD simulations can diverge due to various reasons. If you run into any simulation divergence issues, please follow the steps outlined in our [troubleshooting guide](https://www.flexcompute.com/tidy3d/examples/notebooks/DivergedFDTDSimulation/) to resolve it."
]
},
{
Expand Down Expand Up @@ -794,7 +794,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
},
"title": "Germanium Fano Metasurface Modeling in Tidy3D | Flexcompute",
"widgets": {
Expand Down
Loading

0 comments on commit 8606204

Please sign in to comment.