Skip to content
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

📚 Multiple docs fixes and improvements #2009

Merged
merged 1 commit into from
Oct 17, 2024
Merged

📚 Multiple docs fixes and improvements #2009

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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
Expand Down
5 changes: 0 additions & 5 deletions docs/api/_custom_autosummary/tidy3d.SimulationData.rst
View file
Open in desktop

This file was deleted.

17 changes: 13 additions & 4 deletions docs/api/abstract_base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,24 @@
Abstract Base Models
=====================

Base classes that represent abstractions of the core elements of a Simulation.
Base classes that represent abstractions of the core elements of a common components. Provide inherited functionality.


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

tidy3d.components.base_sim.simulation.AbstractSimulation
tidy3d.components.base_sim.data.sim_data.AbstractSimulationData
tidy3d.components.base_sim.monitor.AbstractMonitor
tidy3d.components.base_sim.simulation.AbstractSimulation
tidy3d.components.base_sim.source.AbstractSource
tidy3d.components.source.Source
tidy3d.components.monitor.Monitor
tidy3d.components.data.dataset.AbstractFieldDataset
tidy3d.components.data.monitor_data.AbstractFieldProjectionData
tidy3d.components.parameter_perturbation.AbstractPerturbation
tidy3d.components.parameter_perturbation.AbstractPerturbation
tidy3d.components.medium.AbstractCustomMedium
tidy3d.components.medium.AbstractMedium
tidy3d.components.simulation.AbstractYeeGridSimulation
tidy3d.components.structure.AbstractStructure
tidy3d.components.time.AbstractTimeDependence

68 changes: 29 additions & 39 deletions docs/api/abstract_models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,47 @@
.. currentmodule:: tidy3d

Abstract Models
Base Models
===============

These are some classes that are used to organize the tidy3d components, but aren't to be used directly in the code. Documented here mainly for reference.
These are some classes that are used to organize the tidy3d components, but aren't to be used directly in the code. Documented here mainly for reference of inherited components.


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

tidy3d.Geometry
tidy3d.components.base.Tidy3dBaseModel
tidy3d.components.base_sim.simulation.AbstractSimulation
tidy3d.components.simulation.AbstractYeeGridSimulation
tidy3d.components.boundary.AbsorberSpec
tidy3d.Geometry
tidy3d.components.data.data_array.DataArray
tidy3d.components.data.dataset.FieldDataset
tidy3d.components.data.dataset.FieldTimeDataset
tidy3d.components.data.dataset.ModeSolverDataset
tidy3d.components.data.monitor_data.ElectromagneticFieldData
tidy3d.components.data.monitor_data.MonitorData
tidy3d.components.data.sim_data.SimulationData
tidy3d.components.geometry.base.Centered
tidy3d.components.geometry.base.Planar
tidy3d.components.geometry.base.Circular
tidy3d.components.medium.AbstractMedium
tidy3d.components.medium.AbstractCustomMedium
tidy3d.components.medium.DispersiveMedium
tidy3d.components.geometry.base.Planar
tidy3d.components.geometry.base.SimplePlaneIntersection
tidy3d.components.grid.grid_spec.GridSpec1d
tidy3d.components.lumped_element.LumpedElement
tidy3d.components.medium.CustomDispersiveMedium
tidy3d.components.structure.AbstractStructure
tidy3d.components.source.SourceTime
tidy3d.components.source.Source
tidy3d.components.source.FieldSource
tidy3d.components.source.CurrentSource
tidy3d.components.source.ReverseInterpolatedSource
tidy3d.components.medium.DispersiveMedium
tidy3d.components.monitor.FreqMonitor
tidy3d.components.monitor.Monitor
tidy3d.components.monitor.PlanarMonitor
tidy3d.components.monitor.TimeMonitor
tidy3d.components.source.AngledFieldSource
tidy3d.components.source.PlanarSource
tidy3d.components.source.DirectionalSource
tidy3d.components.source.BroadbandSource
tidy3d.components.source.VolumeSource
tidy3d.components.source.CurrentSource
tidy3d.components.source.DirectionalSource
tidy3d.components.source.FieldSource
tidy3d.components.source.PlanarSource
tidy3d.components.source.Pulse
tidy3d.components.monitor.Monitor
tidy3d.components.monitor.FreqMonitor
tidy3d.components.monitor.TimeMonitor
tidy3d.components.monitor.AbstractFieldMonitor
tidy3d.components.monitor.AbstractFluxMonitor
tidy3d.components.monitor.PlanarMonitor
tidy3d.components.monitor.AbstractFieldProjectionMonitor
tidy3d.components.lumped_element.LumpedElement
tidy3d.components.grid.grid_spec.GridSpec1d
tidy3d.components.base_sim.data.sim_data.SimulationData
tidy3d.components.data.sim_data.AbstractYeeGridSimulationData
tidy3d.components.data.sim_data.SimulationData
tidy3d.components.data.data_array.DataArray
tidy3d.components.data.monitor_data.MonitorData
tidy3d.components.data.monitor_data.AbstractFieldProjectionData
tidy3d.components.data.monitor_data.ElectromagneticFieldData
tidy3d.components.data.monitor_data.AbstractMonitorData
tidy3d.components.data.dataset.AbstractFieldDataset
tidy3d.components.data.dataset.FieldDataset
tidy3d.components.data.dataset.FieldTimeDataset
tidy3d.components.data.dataset.ModeSolverDataset
tidy3d.components.source.ReverseInterpolatedSource
tidy3d.components.source.Source
tidy3d.components.source.SourceTime
tidy3d.components.source.VolumeSource


9 changes: 4 additions & 5 deletions docs/api/constants.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Constants
=========

Physical Constants
------------------
---------------------

.. autosummary::
:toctree: _autosummary/
Expand All @@ -27,10 +27,9 @@ Tidy3D Special Constants
:template: module.rst

tidy3d.constants.inf
tidy3d.constants.PEC

Tidy3D Configuration
--------------------
---------------------

.. autosummary::
:toctree: _autosummary/
Expand All @@ -39,7 +38,7 @@ Tidy3D Configuration
tidy3d.config.Tidy3dConfig

Default Absorber Parameters
---------------------------
----------------------------

.. autosummary::
:toctree: _autosummary/
Expand Down Expand Up @@ -83,7 +82,7 @@ Units


Precision & Comparator Values
---------------------------
------------------------------

.. autosummary::
:toctree: _autosummary/
Expand Down
4 changes: 2 additions & 2 deletions docs/api/eme/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
EME
=============
EME |:rainbow:|
===============

.. toctree::
:hidden:
Expand Down
6 changes: 3 additions & 3 deletions docs/api/heat/boundary_conditions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thermal Boundary Conditions
-----------------------------

Specifications
''''''''''''''''''
^^^^^^^^^^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
Expand All @@ -14,7 +14,7 @@ Specifications


Types
''''''''''''''''''
^^^^^^^^^^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
Expand All @@ -26,7 +26,7 @@ Types


Placement
''''''''''''''''''
^^^^^^^^^^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
Expand Down
2 changes: 2 additions & 0 deletions docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ API |:computer:|
sources
monitors
mode
field_projector
lumped_elements
discretization
subpixel_averaging
Expand All @@ -37,6 +38,7 @@ API |:computer:|
.. include:: /api/sources.rst
.. include:: /api/monitors.rst
.. include:: /api/mode.rst
.. include:: /api/field_projector.rst
.. include:: /api/lumped_elements.rst
.. include:: /api/discretization.rst
.. include:: /api/subpixel_averaging.rst
Expand Down
10 changes: 10 additions & 0 deletions docs/api/mediums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,13 @@ Material Library

.. toctree::
material_library


Abstract Classes
-----------------

.. autosummary::
:toctree: _autosummary/

tidy3d.components.medium.AbstractPerturbationMedium
tidy3d.components.medium.NonlinearModel
2 changes: 1 addition & 1 deletion docs/api/plugins/adjoint.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Adjoint

.. toctree::

../../../tidy3d/plugins/adjoint/README
./../../../tidy3d/plugins/adjoint/README.md

.. autosummary::
:toctree: ../_autosummary/
Expand Down
2 changes: 1 addition & 1 deletion docs/api/plugins/autograd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Automatic Differentiation with Autograd

.. toctree::

../../../tidy3d/plugins/autograd/README
./../../../tidy3d/plugins/autograd/README

.. autosummary::
:toctree: ../_autosummary/
Expand Down
6 changes: 3 additions & 3 deletions docs/api/plugins/design.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Design Space Exploration
:toctree: ../_autosummary/
:template: module.rst

tidy3d.plugins.design.Parameter
tidy3d.plugins.design.parameter.Parameter
tidy3d.plugins.design.ParameterFloat
tidy3d.plugins.design.ParameterInt
tidy3d.plugins.design.ParameterAny
tidy3d.plugins.design.Method
tidy3d.plugins.design.method.Method
tidy3d.plugins.design.MethodGrid
tidy3d.plugins.design.MethodMonteCarlo
tidy3d.plugins.design.MethodRandomCustom
tidy3d.plugins.design.MethodRandom
tidy3d.plugins.design.DesignSpace
tidy3d.plugins.design.Results
tidy3d.plugins.design.Result
22 changes: 11 additions & 11 deletions docs/api/plugins/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Plugins
.. toctree::
:hidden:

mode_solver
dispersion
polyslab
smatrix
resonance
autograd
adjoint
design
invdes
waveguide
microwave
./mode_solver
./dispersion
./polyslab
./smatrix
./resonance
./autograd
./adjoint
./invdes
./design
./waveguide
./microwave


.. include:: /api/plugins/mode_solver.rst
Expand Down
14 changes: 7 additions & 7 deletions docs/api/plugins/invdes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Inverse Design Plugin

.. toctree::

../../../tidy3d/plugins/invdes/README
./../../../tidy3d/plugins/invdes/README.md

.. autosummary::
:toctree: ../_autosummary/
Expand All @@ -18,9 +18,9 @@ Inverse Design Plugin
tidy3d.plugins.invdes.InverseDesignMulti
tidy3d.plugins.invdes.InverseDesignResult
tidy3d.plugins.invdes.AdamOptimizer
tidy3d.plugins.invdes.get_amps
tidy3d.plugins.invdes.get_field_component
tidy3d.plugins.invdes.get_intensity
tidy3d.plugins.invdes.sum_array
tidy3d.plugins.invdes.sum_abs_squared
tidy3d.plugins.invdes.get_phase
tidy3d.plugins.invdes.utils.get_amps
tidy3d.plugins.invdes.utils.get_field_component
tidy3d.plugins.invdes.utils.get_intensity
tidy3d.plugins.invdes.utils.sum_array
tidy3d.plugins.invdes.utils.sum_abs_squared
tidy3d.plugins.invdes.utils.get_phase
Loading
Loading