Skip to content

docs: introduce ModeSimulation #2977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

docs: introduce ModeSimulation #2977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ API |:computer:|
utilities
configuration
mesh/index
mode/index
heat/index
charge/index
eme/index
Expand Down
11 changes: 1 addition & 10 deletions docs/api/mode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1 @@
.. currentmodule:: tidy3d

Mode Specifications
===================

.. autosummary::
:toctree: _autosummary/
:template: module.rst

tidy3d.ModeSpec
.. include:: /api/mode/index.rst
14 changes: 14 additions & 0 deletions docs/api/mode/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Mode |:record_button:|
======================

.. toctree::
:hidden:

simulation
specification
output_data


.. include:: /api/mode/simulation.rst
.. include:: /api/mode/specification.rst
.. include:: /api/mode/output_data.rst
33 changes: 33 additions & 0 deletions docs/api/mode/output_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. currentmodule:: tidy3d

Output Data
-----------

Simulation Data
^^^^^^^^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
:template: module.rst

tidy3d.ModeSimulationData


Monitor Data
^^^^^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
:template: module.rst

tidy3d.ModeSolverData


Datasets
^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
:template: module.rst

tidy3d.ModeSolverDataset
10 changes: 10 additions & 0 deletions docs/api/mode/simulation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. currentmodule:: tidy3d

Mode Simulation
===============

.. autosummary::
:toctree: ../_autosummary/
:template: module.rst

tidy3d.ModeSimulation
11 changes: 11 additions & 0 deletions docs/api/mode/specification.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. currentmodule:: tidy3d

Mode Specifications
===================

.. autosummary::
:toctree: ../_autosummary/
:template: module.rst

tidy3d.ModeSpec
tidy3d.ModeSortSpec
2 changes: 1 addition & 1 deletion docs/api/simulation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Other Simulation Types
:toctree: _autosummary/
:template: module.rst

tidy3d.plugins.mode.ModeSolver
tidy3d.ModeSimulation
tidy3d.EMESimulation
tidy3d.HeatSimulation
tidy3d.HeatChargeSimulation
Expand Down