FIX: Post 2.6 release 🚨

flexcompute · Feb 23, 2024 · 89d9d43 · 89d9d43
1 parent a872049
commit 89d9d43
Show file tree

Hide file tree

Showing 12 changed files with 94 additions and 28 deletions.
diff --git a/docs/api/charge/index.rst b/docs/api/charge/index.rst
@@ -0,0 +1,10 @@
+CHARGE |:zap:|
+==============
+
+.. toctree::
+    :hidden:
+
+    mediums
+
+
+.. include:: /api/charge/mediums.rst
diff --git a/docs/api/charge/mediums.rst b/docs/api/charge/mediums.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: tidy3d
+
+Charge Perturbation Specification
+------------------------------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.LinearChargePerturbation
+   tidy3d.CustomChargePerturbation
diff --git a/docs/api/heat/mediums.rst b/docs/api/heat/mediums.rst
@@ -9,3 +9,15 @@ Material Thermal Specification
 
    tidy3d.FluidSpec
    tidy3d.SolidSpec
+
+
+Thermal Perturbation Specification
+------------------------------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.LinearHeatPerturbation
+   tidy3d.CustomHeatPerturbation
+
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -20,6 +20,7 @@ API |:computer:|
     logging
     submit_simulations
     heat/index
+    charge/index
     plugins/index
     constants
     abstract_base

diff --git a/docs/api/mediums.rst b/docs/api/mediums.rst
@@ -52,6 +52,18 @@ Spatially varying
    tidy3d.CustomDrude
    tidy3d.CustomDebye
 
+
+Medium Perturbations
+--------------------
+
+.. autosummary::
+   :toctree: _autosummary/
+   :template: module.rst
+
+   tidy3d.PerturbationMedium
+   tidy3d.PerturbationPoleResidue
+
+
 General Mediums (can be both dispersive and non-dispersive)
 -----------------------------------------------------------
 

diff --git a/docs/api/submit_simulations.rst b/docs/api/submit_simulations.rst
@@ -24,7 +24,7 @@ Through python API
    tidy3d.web.api.webapi.download_log
    tidy3d.web.api.webapi.download_json
    tidy3d.web.api.webapi.load_simulation
-   tidy3d.web.api.webapi.run_async
+   tidy3d.web.api.asynchronous.run_async
 
 Convenience for Single and Batch
 --------------------------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -80,6 +80,7 @@
     "IPython.sphinxext.ipython_directive",
     "IPython.sphinxext.ipython_console_highlighting",
     "nbsphinx",  # Integrate Jupyter Notebooks and Sphinx
+    "notfound.extension",
     "myst_parser",
     # "sphinxcontrib.divparams", # TODO FIX
     "sphinx.ext.autodoc",  # Core Sphinx library for auto html doc generation from docstrings
@@ -112,7 +113,7 @@
 html_css_files = [
     "css/custom.css",
 ]
-html_extra_path = ["./_static/robots.txt"]
+html_extra_path = ["./_static/robots.txt", "./_static/"]
 html_favicon = "_static/logo.ico"
 html_js_files = ["js/custom-download.js"]
 htmlhelp_basename = "tidy3ddoc"

diff --git a/docs/faq b/docs/faq
diff --git a/docs/install.rst b/docs/install.rst
@@ -177,7 +177,7 @@ Next Steps
 
 That should get you started!  
 
-To see some other examples of Tidy3D being used in large scale photonics simulations, see `Examples <./examples.html>`_.
+To see some other examples of Tidy3D being used in large scale photonics simulations, see `Examples <./notebooks/docs/index.html>`_.
 
 To learn more about the many features of Tidy3D, check out our `Feature Walkthrough <./notebooks/Simulation.html>`_.
 

diff --git a/docs/notebooks b/docs/notebooks
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -93,6 +93,7 @@ pydata-sphinx-theme = {version = ">=0.13.3", optional = true}
 tmm = {version="*", optional = true}
 grcwa = {version="*", optional = true}
 sphinx-sitemap = {version=">=2.5.1", optional = true}
+sphinx-notfound-page = {version="*", optional = true}
 sphinx-tabs = {version="*", optional = true}
 nbdime = {version="*", optional = true}
 myst-parser = {version="*", optional = true}
@@ -109,9 +110,9 @@ cma = {version="*", optional = true}
 dev = ['black', "coverage", 'dill', 'divparams', 'gdspy', 'gdstk', 'gdstk', 'grcwa', 'ipython', 'ipython', 'jax', 'jaxlib', 'jinja2',
   'jupyter', 'jupyterblack', 'myst-parser', 'memory_profiler', 'nbconvert', 'nbdime', 'nbsphinx', 'networkx', 'optax', 'pre-commit',
   'pydata-sphinx-theme', 'pylint', 'pyswarms', 'pytest', 'pytest-timeout', 'rtree', 'ruff', 'sax', 'signac', 'sphinx',
-  'sphinx-book-theme', 'sphinx-copybutton', 'sphinx-sitemap', 'sphinx-tabs', 'sphinxemoji', 'tmm', 'tox', 'trimesh',
+  'sphinx-book-theme', 'sphinx-copybutton', 'sphinx-notfound-page', 'sphinx-sitemap', 'sphinx-tabs', 'sphinxemoji', 'tmm', 'tox', 'trimesh',
     'vtk', 'devsim', 'cma']
-docs = ["jupyter", "jinja2", "nbconvert", "sphinx", "nbsphinx", "ipython", "divparams", "sphinx-copybutton", "sphinx-book-theme", "pydata-sphinx-theme", "tmm", "gdstk", "grcwa", "sphinx-sitemap", "nbdime", "optax", "signac", "sax", "pylint", "jupyterblack", "sphinx-tabs", "sphinxemoji", "myst-parser", "devsim", "cma"]
+docs = ["jupyter", "jinja2", "nbconvert", "sphinx", "nbsphinx", "ipython", "divparams", "sphinx-copybutton", "sphinx-book-theme", "pydata-sphinx-theme", "tmm", "gdstk", "grcwa", "sphinx-sitemap", 'sphinx-notfound-page', "nbdime", "optax", "signac", "sax", "pylint", "jupyterblack", "sphinx-tabs", "sphinxemoji", "myst-parser", "devsim", "cma"]
 gdspy = ["gdspy"]
 gdstk = ["gdstk"]
 jax = ["jaxlib", "jax"]
+1 −1		_faqs/can-i-get-a-discount-as-a-student-or-teacher.md
+1 −1		_faqs/how-do-i-create-a-material-from-optical-n-k-data.md
+1 −1		_faqs/how-do-i-load-the-data-from-a-simulation-task-id-task-id-into-the-python-client.md
+1 −1		_faqs/how-do-i-load-the-results-of-a-simulation.md
+1 −1		_faqs/how-do-i-loop-through-tidy3d-web-batchdata-without-loading-all-of-the-data-into-memory.md
+3 −3		_faqs/how-do-i-run-a-parameter-sweep.md
+1 −1		_faqs/how-do-i-save-or-load-a-tidy3d-web-batch-so-i-can-work-with-it-later.md
+3 −3		_faqs/how-do-i-submit-multiple-simulations.md
+1 −1		docs/faq/can-i-get-a-discount-as-a-student-or-teacher.md
+1 −1		docs/faq/how-do-i-create-a-material-from-optical-n-k-data.md
+1 −1		docs/faq/how-do-i-load-the-data-from-a-simulation-task-id-task-id-into-the-python-client.md
+1 −1		docs/faq/how-do-i-load-the-results-of-a-simulation.md
+1 −1		docs/faq/how-do-i-loop-through-tidy3d-web-batchdata-without-loading-all-of-the-data-into-memory.md
+3 −3		docs/faq/how-do-i-run-a-parameter-sweep.md
+1 −1		docs/faq/how-do-i-save-or-load-a-tidy3d-web-batch-so-i-can-work-with-it-later.md
+3 −3		docs/faq/how-do-i-submit-multiple-simulations.md
+2 −1		.github/workflows/sync-to-proxy-repo.yaml
+1 −1		AdiabaticCouplerLN.ipynb
+1 −1		AdjointPlugin10YBranchLevelSet.ipynb
+1,842 −1		AdjointPlugin12LightExtractor.ipynb
+3 −3		AdjointPlugin3InverseDesign.ipynb
+1 −1		AdjointPlugin6GratingCoupler.ipynb
+1 −1		AdjointPlugin8WaveguideBend.ipynb
+1 −1		AdjointPlugin9WDM.ipynb
+2 −2		BilayerSiNEdgeCoupler.ipynb
+1 −1		CMOSRGBSensor.ipynb
+1 −1		EdgeCoupler.ipynb
+1 −1		FocusedApodGC.ipynb
+1 −1		GDSExport.ipynb
+8 −8		GeometryTransformations.ipynb
+3 −3		HeatSolver.ipynb
+9 −3		MetalHeaterPhaseShifter.ipynb
+1 −1		MoS2Waveguide.ipynb
+3 −3		Near2FarSphereRCS.ipynb
+220 −221		ParameterScan.ipynb
+1 −1		ParticleSwarmOptimizedPBS.ipynb
+7 −7		Primer.ipynb
+1 −1		RadiativeCoolingGlass.ipynb
+1 −1		Simulation.ipynb
+5 −1		ThermallyTunedRingResonator.ipynb
+1 −1		TimeModulationTutorial.ipynb
+1 −1		TunableChiralMetasurface.ipynb
+1 −1		VizData.ipynb
+1 −1		VizSimulation.ipynb
+9 −9		WebAPI.ipynb
+ −		img/thermally_tuned_waveguide.png
+2 −2		metadata/metadata.txt