chore: add dependency groups for design plugin as well as heat &

charge solvers

Author: yaugenst-flex

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Dependencies for the `design` plugin can now be installed via `pip install tidy3d[design]`.
+
 ### Fixed
 - Bug in `LayerRefinementSpec` that refines grids outside the layer region when one in-plane dimension is of size infinity.
 - Querying tasks was sometimes erroring unexpectedly.

docs/install.rst

@@ -171,6 +171,63 @@ Some users or systems may require a more specialized installation, which we will
 
         See the development installation `instructions <../development/index.html>`_. You can install ``tidy3d`` within reproducible environment guaranteed by the developers using the ``poetry.lock`` installation and the ``poetry`` toolchain.
 
+Optional Dependencies
+=====================
+
+Tidy3D provides several optional dependency groups that you can install based on your specific needs.
+
+Installing Optional Core Dependencies
+-------------------------------------
+
+Tidy3D has several optional dependencies that provide additional functionality. You can install these using the following syntax:
+
+.. code-block:: bash
+
+    pip install "tidy3d[dependency_group]"
+
+Where ``dependency_group`` is one of the following:
+
+- ``gdspy``: Adds support for GDS export using `gdspy <https://github.com/heitzmann/gdspy>`_.
+- ``gdstk``: Adds support for GDS export using `gdstk <https://github.com/heitzmann/gdstk>`_.
+- ``trimesh``: Support for more complex mesh handling and manipulation.
+- ``vtk``: Support for working with unstructured data.
+- ``heatcharge``: Additional dependencies for heat & charge solvers.
+
+For example, to install Tidy3D with trimesh support:
+
+.. code-block:: bash
+
+    pip install "tidy3d[trimesh]"
+
+Installing Plugin Dependencies
+------------------------------
+
+Tidy3D also offers plugins that require additional dependencies:
+
+- ``design``: Design space exploration and optimization.
+- ``pytorch``: A PyTorch wrapper for objective functions defined using autograd.
+- ``adjoint``: Adjoint optimization using JAX (deprecated in favor of native autorad support in Tidy3D)
+
+For example, to install the design plugin dependencies:
+
+.. code-block:: bash
+
+    pip install "tidy3d[design]"
+
+Multiple dependency groups can be installed simultaneously:
+
+.. code-block:: bash
+
+    pip install "tidy3d[design,trimesh]"
+
+Developer Installation
+----------------------
+
+For developers and those who want to install all optional dependencies:
+
+.. code-block:: bash
+
+    pip install "tidy3d[dev]"
 
 Next Steps
 ==========

poetry.lock

@@ -208,11 +208,15 @@ docs = [
 ]
 gdspy = ["gdspy"]
 gdstk = ["gdstk"]
-jax = ["jaxlib", "jax"]
 scikit-rf = ["scikit-rf"]
 trimesh = ["trimesh", "networkx", "rtree"]
 vtk = ["vtk"]
 ruff = ["ruff"]
+heatcharge = ["trimesh", "vtk", "devsim"]
+# plugins with extra deps
+adjoint = ["jaxlib", "jax"]
+pytorch = ["torch"]
+design = ["bayesian-optimization", "pygad", "pyswarms"]
 
 [tool.poetry.scripts]
 tidy3d = "tidy3d.web.cli:tidy3d_cli"

pyproject.toml

@@ -245,7 +245,8 @@ def _run(self, parameters: Tuple[ParameterType, ...], run_fn: Callable, console)
             from bayes_opt import BayesianOptimization, UtilityFunction
         except ImportError:
             raise ImportError(
-                "Cannot run Bayesian optimization as 'bayes_opt' module not found. Please check installation or run 'pip install bayesian-optimization'."
+                "Cannot run Bayesian optimization as 'bayes_opt' module not found. "
+                "Please check installation or run 'pip install bayesian-optimization==1.5.1'."
             )
 
         # Identify non-numeric params and define boundaries for Bay-opt