chore: release v2.10.0 official

daquinteroflex · daquinteroflex · commit bdbb0aee0295 · 2025-12-17T10:26:39.000+01:00
diff --git a/.github/workflows/tidy3d-docs-sync-readthedocs-repo.yml b/.github/workflows/tidy3d-docs-sync-readthedocs-repo.yml
@@ -76,6 +76,17 @@ jobs:
           fetch-tags: true
           persist-credentials: true
 
+      - name: convert-ssh-submodules-to-https
+        run: |
+          if [ -f .gitmodules ]; then
+            echo "Converting SSH submodule URLs to HTTPS..."
+            sed -i 's|git@github.com:|https://github.com/|g' .gitmodules
+            git submodule sync
+            echo "Submodule URLs converted successfully"
+          else
+            echo "No .gitmodules file found, skipping conversion"
+          fi
+
       - name: push-mirror-repo
         id: sync-result
         env:
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -23,6 +23,7 @@ API |:computer:|
     heat/index
     charge/index
     eme/index
+    mode/index
     microwave/index
     plugins/index
     spice
diff --git a/docs/api/mode.rst b/docs/api/mode.rst
diff --git a/docs/api/mode/index.rst b/docs/api/mode/index.rst
@@ -0,0 +1,39 @@
+.. currentmodule:: tidy3d
+
+Mode |:dart:|
+=============
+
+.. include:: /api/mode/sources.rst
+
+
+Interpolation Specifications
+----------------------------
+
+.. autosummary::
+   :toctree: _autosummary/
+   :template: module.rst
+
+   tidy3d.ModeInterpSpec
+
+
+Sort Specifications
+-------------------
+
+.. autosummary::
+   :toctree: _autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSortSpec
+
+
+Sampling Specifications
+-----------------------
+
+.. autosummary::
+   :toctree: _autosummary/
+   :template: module.rst
+
+   tidy3d.UniformSampling
+   tidy3d.ChebSampling
+   tidy3d.CustomSampling
+
diff --git a/docs/api/mode/sources.rst b/docs/api/mode/sources.rst
@@ -0,0 +1,41 @@
+Mode Source
+-----------
+
+.. autosummary::
+   :toctree: _autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSource
+   tidy3d.ModeSpec
+   tidy3d.PECFrame
+
+The ``ModeSource`` class represents a propagating mode in a given structure cross section.
+
+Behind the scenes, the desired mode is initially obtained by running the mode solver on the ``ModeSource`` plane. The ``ModeSpec`` class provides the settings for the mode solver. Once the desired mode is found, it is injected into the 3D simulation along the plane normal. The user does not need to invoke the mode solver explicitly; it is performed automatically whenever a ``ModeSource`` or ``ModeMonitor`` is included in a Tidy3D simulation.
+
+.. code-block:: python
+
+   # custom mode specification tells the mode solver to search for
+   # two modes around effective index = 1.5
+   my_mode_spec = ModeSpec(num_modes=2, target_neff=1.5)
+
+   # custom mode source injects the first mode along the +x direction
+   my_mode_source = ModeSource(
+       size=(0,10,10),
+       source_time=my_source_time,
+       direction='+',
+       mode_spec=my_mode_spec,
+       mode_index=0,
+   )
+       
+.. seealso::
+
+   For more detailed explanation and examples, please see the following learning center resources:
+
+   + `Defining mode sources and monitors <../notebooks/ModalSourcesMonitors.html>`_
+   + `Injecting modes in bent and angled waveguides <../notebooks/ModeBentAngled.html>`_
+
+   For a short introduction to the use of mode sources, see the following FDTD101 lecture:
+
+   + `Mode injection <https://www.flexcompute.com/fdtd101/Lecture-4-Prelude-to-Integrated-Photonics-Simulation-Mode-Injection/>`_
+
diff --git a/docs/api/plugins/smatrix.rst b/docs/api/plugins/smatrix.rst
@@ -1,7 +1,7 @@
 .. currentmodule:: tidy3d
 
 S-Matrix Component Modelers Plugin
-----------------------------------
+==================================
 
 This plugin provides component modelers for computing S-parameters (scattering parameters) for both **photonics** and **RF/microwave** applications. The plugin supports:
 
diff --git a/docs/api/sources.rst b/docs/api/sources.rst
@@ -185,46 +185,7 @@ The ``GaussianBeam`` and ``AstigmaticGaussianBeam`` classes implement the paraxi
 
 ~~~~
 
-Mode Source
------------
-
-.. autosummary::
-   :toctree: _autosummary/
-   :template: module.rst
-
-   tidy3d.ModeSource
-   tidy3d.ModeSpec
-   tidy3d.PECFrame
-
-The ``ModeSource`` class represents a propagating mode in a given structure cross section.
-
-Behind the scenes, the desired mode is initially obtained by running the mode solver on the ``ModeSource`` plane. The ``ModeSpec`` class provides the settings for the mode solver. Once the desired mode is found, it is injected into the 3D simulation along the plane normal. The user does not need to invoke the mode solver explicitly; it is performed automatically whenever a ``ModeSource`` or ``ModeMonitor`` is included in a Tidy3D simulation.
-
-.. code-block:: python
-
-   # custom mode specification tells the mode solver to search for
-   # two modes around effective index = 1.5
-   my_mode_spec = ModeSpec(num_modes=2, target_neff=1.5)
-
-   # custom mode source injects the first mode along the +x direction
-   my_mode_source = ModeSource(
-       size=(0,10,10),
-       source_time=my_source_time,
-       direction='+',
-       mode_spec=my_mode_spec,
-       mode_index=0,
-   )
-       
-.. seealso::
-
-   For more detailed explanation and examples, please see the following learning center resources:
-
-   + `Defining mode sources and monitors <../notebooks/ModalSourcesMonitors.html>`_
-   + `Injecting modes in bent and angled waveguides <../notebooks/ModeBentAngled.html>`_
-
-   For a short introduction to the use of mode sources, see the following FDTD101 lecture:
-
-   + `Mode injection <https://www.flexcompute.com/fdtd101/Lecture-4-Prelude-to-Integrated-Photonics-Simulation-Mode-Injection/>`_
+.. include:: /api/mode/sources.rst
 
 ~~~~
 
diff --git a/docs/api/submit_simulations.rst b/docs/api/submit_simulations.rst
@@ -13,12 +13,12 @@ Core Workflow
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.webapi.run
-   tidy3d.web.api.webapi.upload
-   tidy3d.web.api.webapi.start
-   tidy3d.web.api.webapi.monitor
-   tidy3d.web.api.webapi.download
-   tidy3d.web.api.webapi.load
+   tidy3d.web.run
+   tidy3d.web.upload
+   tidy3d.web.start
+   tidy3d.web.monitor
+   tidy3d.web.download
+   tidy3d.web.load
    tidy3d.web.api.asynchronous.run_async
 
 Download Utilities
@@ -28,10 +28,10 @@ Download Utilities
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.webapi.download_json
-   tidy3d.web.api.webapi.download_hdf5
-   tidy3d.web.api.webapi.download_log
-   tidy3d.web.api.webapi.load_simulation
+   tidy3d.web.download_json
+   tidy3d.web.download_hdf5
+   tidy3d.web.download_log
+   tidy3d.web.load_simulation
 
 Task Information
 ~~~~~~~~~~~~~~~~
@@ -40,9 +40,9 @@ Task Information
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.webapi.get_info
-   tidy3d.web.api.webapi.get_run_info
-   tidy3d.web.api.webapi.get_tasks
+   tidy3d.web.get_info
+   tidy3d.web.get_run_info
+   tidy3d.web.get_tasks
 
 Cost Estimation
 ~~~~~~~~~~~~~~~
@@ -51,8 +51,8 @@ Cost Estimation
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.webapi.estimate_cost
-   tidy3d.web.api.webapi.real_cost
+   tidy3d.web.estimate_cost
+   tidy3d.web.real_cost
 
 Task Management
 ~~~~~~~~~~~~~~~
@@ -61,9 +61,9 @@ Task Management
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.webapi.delete
-   tidy3d.web.api.webapi.delete_old
-   tidy3d.web.api.webapi.abort
+   tidy3d.web.delete
+   tidy3d.web.delete_old
+   tidy3d.web.abort
 
 Account and System
 ~~~~~~~~~~~~~~~~~~
@@ -72,8 +72,8 @@ Account and System
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.webapi.account
-   tidy3d.web.api.webapi.test
+   tidy3d.web.account
+   tidy3d.web.test
 
 Job and Batch Containers
 -------------------------
@@ -82,9 +82,9 @@ Job and Batch Containers
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.web.api.container.Job
-   tidy3d.web.api.container.Batch
-   tidy3d.web.api.container.BatchData
+   tidy3d.web.Job
+   tidy3d.web.Batch
+   tidy3d.web.BatchData
 
 Information Containers
 ----------------------
diff --git a/docs/notebooks b/docs/notebooks
@@ -1 +1 @@
-Subproject commit 17e845fd1fb361d1c9ef5d2d850fc6f1d81fb097
+Subproject commit e278860a711872a90320d66235ddd8fe00b83aa0
diff --git a/tidy3d/components/mode_spec.py b/tidy3d/components/mode_spec.py
@@ -31,11 +31,15 @@
 class ModeSortSpec(Tidy3dBaseModel):
     """Specification for filtering and sorting modes within each frequency.
 
-    First, an optional filtering step splits the modes into two groups based on a threshold
-    applied to ``filter_key``: modes "over" or "under" ``filter_reference`` are placed first,
-    with the remaining modes placed next. Second, an optional sorting step orders modes within
-    each group according to ``sort_key``, optionally with respect to ``sort_reference`` and in
-    the specified ``sort_order``.
+    Notes
+    -----
+
+        First, an optional filtering step splits the modes into two groups based on a threshold
+        applied to ``filter_key``: modes "over" or "under" ``filter_reference`` are placed first,
+        with the remaining modes placed next. Second, an optional sorting step orders modes within
+        each group according to ``sort_key``, optionally with respect to ``sort_reference`` and in
+        the specified ``sort_order``.
+
     """
 
     # Filtering stage
@@ -225,13 +229,14 @@ def _num_points(self) -> int:
 class ModeInterpSpec(Tidy3dBaseModel):
     """Specification for mode frequency interpolation.
 
-    Allows computing modes at a reduced set of frequencies and interpolating
-    to obtain results at all requested frequencies. This can significantly
-    reduce computational cost for broadband simulations where modes vary
-    smoothly with frequency.
+    Notes
+    -----
+
+        Allows computing modes at a reduced set of frequencies and interpolating
+        to obtain results at all requested frequencies. This can significantly
+        reduce computational cost for broadband simulations where modes vary
+        smoothly with frequency.
 
-    Note
-    ----
         Requires frequency tracking to be enabled (``mode_spec.sort_spec.track_freq``
         must not be ``None``) to ensure mode ordering is consistent across frequencies.
 
