From 6192392e7ccf515f318953f47c980160f766e4e5 Mon Sep 17 00:00:00 2001 From: daquinteroflex Date: Fri, 7 Nov 2025 16:37:37 +0100 Subject: [PATCH] docs: introduce ModeSimulation --- docs/api/index.rst | 1 + docs/api/mode.rst | 11 +---------- docs/api/mode/index.rst | 14 ++++++++++++++ docs/api/mode/output_data.rst | 33 +++++++++++++++++++++++++++++++++ docs/api/mode/simulation.rst | 10 ++++++++++ docs/api/mode/specification.rst | 11 +++++++++++ docs/api/simulation.rst | 2 +- 7 files changed, 71 insertions(+), 11 deletions(-) create mode 100644 docs/api/mode/index.rst create mode 100644 docs/api/mode/output_data.rst create mode 100644 docs/api/mode/simulation.rst create mode 100644 docs/api/mode/specification.rst diff --git a/docs/api/index.rst b/docs/api/index.rst index 9a77908bd4..70e96612c5 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -20,6 +20,7 @@ API |:computer:| utilities configuration mesh/index + mode/index heat/index charge/index eme/index diff --git a/docs/api/mode.rst b/docs/api/mode.rst index 7237cb4b2f..48ca0cec1a 100644 --- a/docs/api/mode.rst +++ b/docs/api/mode.rst @@ -1,10 +1 @@ -.. currentmodule:: tidy3d - -Mode Specifications -=================== - -.. autosummary:: - :toctree: _autosummary/ - :template: module.rst - - tidy3d.ModeSpec \ No newline at end of file +.. include:: /api/mode/index.rst \ No newline at end of file diff --git a/docs/api/mode/index.rst b/docs/api/mode/index.rst new file mode 100644 index 0000000000..12a68ef5e2 --- /dev/null +++ b/docs/api/mode/index.rst @@ -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 \ No newline at end of file diff --git a/docs/api/mode/output_data.rst b/docs/api/mode/output_data.rst new file mode 100644 index 0000000000..38ea54f84f --- /dev/null +++ b/docs/api/mode/output_data.rst @@ -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 diff --git a/docs/api/mode/simulation.rst b/docs/api/mode/simulation.rst new file mode 100644 index 0000000000..003134f381 --- /dev/null +++ b/docs/api/mode/simulation.rst @@ -0,0 +1,10 @@ +.. currentmodule:: tidy3d + +Mode Simulation +=============== + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.ModeSimulation \ No newline at end of file diff --git a/docs/api/mode/specification.rst b/docs/api/mode/specification.rst new file mode 100644 index 0000000000..958e05727f --- /dev/null +++ b/docs/api/mode/specification.rst @@ -0,0 +1,11 @@ +.. currentmodule:: tidy3d + +Mode Specifications +=================== + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.ModeSpec + tidy3d.ModeSortSpec \ No newline at end of file diff --git a/docs/api/simulation.rst b/docs/api/simulation.rst index 9427064255..44b9cd1954 100644 --- a/docs/api/simulation.rst +++ b/docs/api/simulation.rst @@ -40,7 +40,7 @@ Other Simulation Types :toctree: _autosummary/ :template: module.rst - tidy3d.plugins.mode.ModeSolver + tidy3d.ModeSimulation tidy3d.EMESimulation tidy3d.HeatSimulation tidy3d.HeatChargeSimulation