post-release: update to v2.10.0rc3

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Added support for `tidy3d-extras`, an optional plugin that enables more accurate local mode solving via subpixel averaging.
+
 ### Changed
 - Improved performance of antenna metrics calculation by utilizing cached wave amplitude calculations instead of recomputing wave amplitudes for each port excitation in the `TerminalComponentModelerData`.
 

docs/index.rst

@@ -255,6 +255,7 @@ Contents
   api/index
   GUI <https://tidy3d.simulation.cloud/>
   Photonforge <https://docs.flexcompute.com/projects/photonforge/en/latest/>
+  extras/index
   development/index
   changelog
   About our Solver <https://www.flexcompute.com/tidy3d/solver/>

docs/install.rst

@@ -218,6 +218,23 @@ Multiple dependency groups can be installed simultaneously:
 
     pip install "tidy3d[design,trimesh]"
 
+Extras Plugin
+----------------------
+
+An optional plugin providing additional local functionality,
+including a more accurate local mode solver:
+
+.. code-block:: bash
+
+    pip install "tidy3d[extras]"
+
+An API key is needed to use the extras plugin.
+For more information on the extras plugin, see `Extras Plugin <./extras/index.html>`_.
+
+.. important::
+
+   ``tidy3d-extras`` is **not compatible with Conda environments**.
+   Please use a standard Python virtual environment (e.g., ``venv`` or ``virtualenv``) for installation.
 
 Developer Installation
 ----------------------

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tidy3d"
-version = "2.10.0rc2"
+version = "2.10.0rc3"
 description = "A fast FDTD solver"
 authors = ["Tyler Hughes <tyler@flexcompute.com>"]
 license = "LGPLv2+"
@@ -116,7 +116,7 @@ sphinxemoji = { version = "*", optional = true }
 devsim = { version = "*", optional = true }
 cma = { version = "*", optional = true }
 openpyxl = { version = "*", optional = true }
-# tidy3d-extras = { version = "2.10.0rc2", optional = true }
+# tidy3d-extras = { version = "2.10.0rc3", optional = true }
 
 [tool.poetry.extras]
 dev = [

schemas/EMESimulation.json

@@ -12013,7 +12013,7 @@
       "type": "string"
     },
     "version": {
-      "default": "2.10.0rc2",
+      "default": "2.10.0rc3",
       "type": "string"
     }
   },

schemas/HeatChargeSimulation.json

@@ -9904,7 +9904,7 @@
       "type": "string"
     },
     "version": {
-      "default": "2.10.0rc2",
+      "default": "2.10.0rc3",
       "type": "string"
     }
   },

schemas/HeatSimulation.json

@@ -9904,7 +9904,7 @@
       "type": "string"
     },
     "version": {
-      "default": "2.10.0rc2",
+      "default": "2.10.0rc3",
       "type": "string"
     }
   },

schemas/ModeSimulation.json

@@ -11767,7 +11767,7 @@
       "type": "string"
     },
     "version": {
-      "default": "2.10.0rc2",
+      "default": "2.10.0rc3",
       "type": "string"
     }
   },

schemas/Simulation.json

@@ -15999,7 +15999,7 @@
       "type": "string"
     },
     "version": {
-      "default": "2.10.0rc2",
+      "default": "2.10.0rc3",
       "type": "string"
     }
   },

schemas/TerminalComponentModeler.json

@@ -14700,7 +14700,7 @@
           "type": "string"
         },
         "version": {
-          "default": "2.10.0rc2",
+          "default": "2.10.0rc3",
           "type": "string"
         }
       },

tidy3d/version.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "2.10.0rc2"
+__version__ = "2.10.0rc3"