Skip to content

Commit a535435

Browse files
committed
added design to docs
1 parent bf8b6dd commit a535435

File tree

3 files changed

+23
-13
lines changed

3 files changed

+23
-13
lines changed

CHANGELOG.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66
## [Unreleased]
77

88
### Added
9-
- `ModeData.dispersion` and `ModeSolverData.dispersion` are calculated together with the group index.
109
- `tidy3d.plugins.design` tool to explore user-defined design spaces.
10+
- `ModeData.dispersion` and `ModeSolverData.dispersion` are calculated together with the group index.
1111

1212
### Changed
1313

@@ -80,18 +80,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8080
- Ensure that mode solver fields are returned in single precision if `ModeSolver.ModeSpec.precision == "single"`.
8181
- If there are no adjoint sources for a simulation involved in an objective function, make a mock source with zero amplitude and warn user.
8282

83-
## [2.5.0rc1] - 2023-10-10
84-
85-
### Added
86-
- Time zone in webAPI logging output.
87-
- Class `Scene` consisting of a background medium and structures for easier drafting and visualization of simulation setups as well as transferring such information between different simulations.
88-
- Solver for thermal simulation (see `HeatSimulation` and related classes).
89-
- Specification of material thermal properties in medium classes through an optional field `.heat_spec`.
90-
91-
### Changed
92-
- Internal refactor of Web API functionality.
93-
- `Geometry.from_gds` doesn't create unnecessary groups of single elements.
94-
9583
## [2.4.3] - 2023-10-16
9684

9785
### Added

docs/api/plugins/design.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. currentmodule:: tidy3d
2+
3+
Design Space Exploration
4+
------------------------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.plugins.design.Parameter
11+
tidy3d.plugins.design.ParameterFloat
12+
tidy3d.plugins.design.ParameterInt
13+
tidy3d.plugins.design.ParameterAny
14+
tidy3d.plugins.design.Method
15+
tidy3d.plugins.design.MethodGrid
16+
tidy3d.plugins.design.MethodMonteCarlo
17+
tidy3d.plugins.design.MethodRandomCustom
18+
tidy3d.plugins.design.MethodRandom
19+
tidy3d.plugins.design.DesignSpace
20+
tidy3d.plugins.design.Results

docs/api/plugins/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Plugins
1111
resonance
1212
adjoint
1313
waveguide
14+
design
1415

1516

1617
.. include:: /api/plugins/mode_solver.rst
@@ -20,3 +21,4 @@ Plugins
2021
.. include:: /api/plugins/resonance.rst
2122
.. include:: /api/plugins/adjoint.rst
2223
.. include:: /api/plugins/waveguide.rst
24+
.. include:: /api/plugins/design.rst

0 commit comments

Comments
 (0)