docs(charge): Fix rendering & further descriptions

damiano-flex · daquinteroflex · commit 07ddba557602 · 2025-09-16T13:14:47.000Z
* Fixing charge doc typos and formatting errors.
diff --git a/docs/api/charge/output_data.rst b/docs/api/charge/output_data.rst
@@ -28,3 +28,11 @@ Monitor Data
    tidy3d.SteadyElectricFieldData
    tidy3d.SteadyCurrentDensityData
 
+Device Data
+^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.DeviceCharacteristics
diff --git a/docs/api/heat/boundary_conditions.rst b/docs/api/heat/boundary_conditions.rst
@@ -37,4 +37,13 @@ Placement
    tidy3d.StructureBoundary
    tidy3d.MediumMediumInterface
    tidy3d.StructureSimulationBoundary
-   tidy3d.SimulationBoundary
+   tidy3d.SimulationBoundary
+
+Coefficient Models
+^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.VerticalNaturalConvectionCoeffModel
diff --git a/docs/api/mediums.rst b/docs/api/mediums.rst
@@ -139,6 +139,7 @@ Anisotropic
    :template: module.rst
 
    tidy3d.AnisotropicMedium
+   tidy3d.AnisotropicMediumFromMedium2D
    tidy3d.FullyAnisotropicMedium
    tidy3d.Medium2D
 
@@ -403,7 +404,7 @@ Multiphysics Medium
 .. autosummary::
    :toctree: _autosummary/
 
-   tidy3d.components.material.multi_physics.MultiPhysicsMedium
+   tidy3d.MultiPhysicsMedium
 
 This section is still under construction. 
 
diff --git a/docs/api/mesh/output_data.rst b/docs/api/mesh/output_data.rst
@@ -45,3 +45,6 @@ Individual Datasets
    tidy3d.PointDataArray
    tidy3d.CellDataArray
    tidy3d.IndexedDataArray
+   tidy3d.IndexedVoltageDataArray
+   tidy3d.IndexedTimeDataArray
+   tidy3d.IndexedFieldVoltageDataArray
diff --git a/docs/api/output_data.rst b/docs/api/output_data.rst
@@ -87,3 +87,4 @@ List of Dataset Types
    tidy3d.DiffractionDataArray
    tidy3d.DirectivityDataArray
    tidy3d.AxialRatioDataArray
+   tidy3d.SteadyVoltageDataArray
diff --git a/tidy3d/components/base_sim/simulation.py b/tidy3d/components/base_sim/simulation.py
@@ -128,8 +128,8 @@ class AbstractSimulation(Box, ABC):
         title="Structure Priority Setting",
         description="This field only affects structures of `priority=None`. "
         "If `equal`, the priority of those structures is set to 0; if `conductor`, "
-        "the priority of structures made of `LossyMetalMedium` is set to 90, "
-        "`PECMedium` to 100, and others to 0.",
+        "the priority of structures made of :class:`LossyMetalMedium` is set to 90, "
+        ":class:`PECMedium` to 100, and others to 0.",
     )
 
     """ Validating setup """
diff --git a/tidy3d/components/material/tcad/charge.py b/tidy3d/components/material/tcad/charge.py
@@ -33,7 +33,7 @@ class AbstractChargeMedium(AbstractMedium):
     def charge(self):
         """
         This means that a charge medium has been defined inherently within this solver medium.
-        This provides interconnection with the `MultiPhysicsMedium` higher-dimensional classes.
+        This provides interconnection with the :class:`MultiPhysicsMedium` higher-dimensional classes.
         """
         return self
 
@@ -77,7 +77,7 @@ class ChargeConductorMedium(AbstractChargeMedium):
     conductivity: pd.PositiveFloat = pd.Field(
         ...,
         title="Electric conductivity",
-        description=f"Electric conductivity of material in units of {CONDUCTIVITY}.",
+        description="Electric conductivity of material.",
         units=CONDUCTIVITY,
     )
 
@@ -296,20 +296,24 @@ class SemiconductorMedium(AbstractChargeMedium):
 
     delta_E_g: BandGapNarrowingModelType = pd.Field(
         None,
-        title=r"$\Delta E_g$ Bandgap narrowing model.",
+        title=":math:`\\Delta E_g` Bandgap narrowing model.",
         description="Bandgap narrowing model.",
     )
 
     N_a: Union[pd.NonNegativeFloat, SpatialDataArray, tuple[DopingBoxType, ...]] = pd.Field(
         0,
         title="Doping: Acceptor concentration",
-        description="Units of 1/cm^3",
+        description="Concentration of acceptor impurities, which create mobile holes, resulting in p-type material. "
+        "Can be specified as a single float for uniform doping, a :class:`SpatialDataArray` for a custom profile, "
+        "or a tuple of geometric shapes to define specific doped regions.",
         units="1/cm^3",
     )
 
     N_d: Union[pd.NonNegativeFloat, SpatialDataArray, tuple[DopingBoxType, ...]] = pd.Field(
         0,
         title="Doping: Donor concentration",
-        description="Units of 1/cm^3",
+        description="Concentration of donor impurities, which create mobile electrons, resulting in n-type material. "
+        "Can be specified as a single float for uniform doping, a :class:`SpatialDataArray` for a custom profile, "
+        "or a tuple of geometric shapes to define specific doped regions.",
         units="1/cm^3",
     )
diff --git a/tidy3d/components/material/tcad/heat.py b/tidy3d/components/material/tcad/heat.py
@@ -47,26 +47,16 @@ def optical(self):
 
 class FluidMedium(AbstractHeatMedium):
     """Fluid medium. Heat simulations will not solve for temperature
-    in a structure that has a medium with this 'heat_spec'.
+    in a structure that has a medium with this ``heat_spec``.
 
+
+    Notes
+    --------
     The full set of parameters is primarily intended for calculations involving natural
     convection, where they are used to determine the heat transfer coefficient.
     In the current version, these specific properties may not be utilized for
     other boundary condition types.
 
-    Attributes
-    ----------
-    thermal_conductivity : float, optional
-        Thermal conductivity ($k$) of the fluid in $W/(\\mu m \\cdot K)$.
-    viscosity : float, optional
-        Dynamic viscosity ($\\mu$) of the fluid in $kg/(\\mu m \\cdot s)$.
-    specific_heat : float, optional
-        Specific heat ($c_p$) of the fluid in $\\mu m^2/(s^2 \\cdot K)$.
-    density : float, optional
-        Density ($\rho$) of the fluid in $kg/\\mu m^3$.
-    expansivity : float, optional
-        Thermal expansion coefficient ($\beta$) of the fluid in $1/K$.
-
     Examples
     --------
     >>> # If you are using a boundary condition without a natural convection model,
diff --git a/tidy3d/components/medium.py b/tidy3d/components/medium.py
@@ -862,10 +862,10 @@ def _validate_modulation_spec_post_init(self):
     heat_spec: Optional[ThermalSpecType] = pd.Field(
         None,
         title="Heat Specification",
-        description="DEPRECATED: Use `td.MultiPhysicsMedium`. Specification of the medium heat properties. They are "
-        "used for solving the heat equation via the ``HeatSimulation`` interface. Such simulations can be"
+        description="DEPRECATED: Use :class:`MultiPhysicsMedium`. Specification of the medium heat properties. They are "
+        "used for solving the heat equation via the :class:`HeatSimulation` interface. Such simulations can be"
         "used for investigating the influence of heat propagation on the properties of optical systems. "
-        "Once the temperature distribution in the system is found using ``HeatSimulation`` object, "
+        "Once the temperature distribution in the system is found using :class:`HeatSimulation` object, "
         "``Simulation.perturbed_mediums_copy()`` can be used to convert mediums with perturbation "
         "models defined into spatially dependent custom mediums. "
         "Otherwise, the ``heat_spec`` does not directly affect the running of an optical "
diff --git a/tidy3d/components/parameter_perturbation.py b/tidy3d/components/parameter_perturbation.py
@@ -605,8 +605,8 @@ class LinearChargePerturbation(ChargePerturbation):
 
         .. math::
 
-            \\Delta X (T) = \\text{electron\\_coeff} \\times (N_e - \\text{electron\\_ref})
-            + \\text{hole\\_coeff} \\times (N_h - \\text{hole\\_ref}),
+            \\Delta X (T) = \\text{electron_coeff} \\times (N_e - \\text{electron_ref})
+            + \\text{hole_coeff} \\times (N_h - \\text{hole_ref}),
 
         where ``electron_coeff`` and ``hole_coeff`` are the parameter's sensitivities to electron and
         hole densities, while ``electron_ref`` and ``hole_ref`` are reference electron and hole density
diff --git a/tidy3d/components/tcad/bandgap.py b/tidy3d/components/tcad/bandgap.py
@@ -60,6 +60,6 @@ class SlotboomBandGapNarrowing(Tidy3dBaseModel):
         ...,
         title="Minimum total doping",
         description="Bandgap narrowing is applied at location where total doping "
-        "is higher than 'min_N'.",
+        "is higher than ``min_N``.",
         units=PERCMCUBE,
     )
diff --git a/tidy3d/components/tcad/boundary/heat.py b/tidy3d/components/tcad/boundary/heat.py
@@ -30,7 +30,7 @@ class TemperatureBC(HeatChargeBC):
 
     temperature: pd.PositiveFloat = pd.Field(
         title="Temperature",
-        description=f"Temperature value in units of {KELVIN}.",
+        description="Temperature value.",
         units=KELVIN,
     )
 
@@ -46,7 +46,7 @@ class HeatFluxBC(HeatChargeBC):
 
     flux: float = pd.Field(
         title="Heat Flux",
-        description=f"Heat flux value in units of {HEAT_FLUX}.",
+        description="Heat flux value.",
         units=HEAT_FLUX,
     )
 
@@ -55,19 +55,26 @@ class VerticalNaturalConvectionCoeffModel(Tidy3dBaseModel):
     """
     Specification for natural convection from a vertical plate.
 
+    Notes
+    -----
+
     This class calculates the heat transfer coefficient (h) based on fluid
     properties and an expected temperature difference, then provides these
-    values as 'base' and 'exponent' for a generalized heat flux equation
-    q = base * (T_surf - T_fluid)^exponent + base * (T_surf - T_fluid).
+    values as  :math:`\\text{base_l}`,  :math:`\\text{base_nl}`, and  :math:`\\text{exponent}`  for a generalized heat flux equation
+
+    .. math::
+
+        q = \\text{base_nl} * (T_\\text{surf} - T_\\text{fluid})^\\text{exponent} + \\text{base}_{l} * (T_\\text{surf}- T_\\text{fluid}).
+
     """
 
     medium: FluidMedium = pd.Field(
         default=None,
         title="Interface medium",
         description=(
-            "The `FluidMedium` used for the heat transfer coefficient calculation. "
+            "The :class:`FluidMedium` used for the heat transfer coefficient calculation. "
             "If `None`, the fluid is automatically deduced from the interface, which can be defined"
-            "by either a `MediumMediumInterface` or a `StructureStructureInterface`."
+            "by either a :class:`MediumMediumInterface` or a :class:`StructureStructureInterface`."
         ),
     )
 
@@ -151,12 +158,12 @@ class ConvectionBC(HeatChargeBC):
 
     ambient_temperature: pd.PositiveFloat = pd.Field(
         title="Ambient Temperature",
-        description=f"Ambient temperature value in units of {KELVIN}.",
+        description="Ambient temperature.",
         units=KELVIN,
     )
 
     transfer_coeff: Union[pd.NonNegativeFloat, VerticalNaturalConvectionCoeffModel] = pd.Field(
         title="Heat Transfer Coefficient",
-        description=f"Heat flux value in units of {HEAT_TRANSFER_COEFF}.",
+        description="Heat transfer coefficient value.",
         units=HEAT_TRANSFER_COEFF,
     )
diff --git a/tidy3d/components/tcad/data/monitor_data/charge.py b/tidy3d/components/tcad/data/monitor_data/charge.py
@@ -77,15 +77,15 @@ class SteadyFreeCarrierData(HeatChargeMonitorData):
     electrons: UnstructuredFieldType = pd.Field(
         None,
         title="Electrons series",
-        description=r"Contains the computed electrons concentration $n$.",
+        description=r"Contains the computed electrons concentration :math:`n`.",
         discriminator=TYPE_TAG_STR,
     )
     # n = electrons
 
     holes: UnstructuredFieldType = pd.Field(
         None,
         title="Holes series",
-        description=r"Contains the computed holes concentration $p$.",
+        description=r"Contains the computed holes concentration :math:`p`.",
         discriminator=TYPE_TAG_STR,
     )
     # p = holes
@@ -120,13 +120,32 @@ class SteadyEnergyBandData(HeatChargeMonitorData):
     Notes
     -----
 
-        This data contains the energy bands data:
-        Ec -> Energy of the bottom of the conduction band, [eV]
-        Ev -> Energy of the top of the valence band, [eV]
-        Ei -> Intrinsic Fermi level, [eV]
-        Efn -> Quasi-Fermi level for electrons, [eV]
-        Efp -> Quasi-Fermi level for holes, [eV]
-        as defined in the  ``monitor``.
+    This data contains the energy bands data [eV]:
+
+     .. list-table::
+       :widths: 25 25 75
+       :header-rows: 1
+
+       * - Symbol
+         - Parameter Name
+         - Description
+       * - :math:`E_c`
+         - ``Ec``
+         - Energy of the bottom of the conduction band
+       * - :math:`E_v`
+         - ``Ev``
+         - Energy of the top of the valence band
+       * - :math:`E_i`
+         - ``Ei``
+         - Intrinsic Fermi level
+       * - :math:`E_{fn}`
+         - ``Efn``
+         - Quasi-Fermi level for electrons
+       * - :math:`E_{fp}`
+         - ``Efp``
+         - Quasi-Fermi level for holes
+
+    as defined in the  ``monitor``.
     """
 
     monitor: SteadyEnergyBandMonitor = pd.Field(
@@ -138,35 +157,35 @@ class SteadyEnergyBandData(HeatChargeMonitorData):
     Ec: UnstructuredFieldType = pd.Field(
         None,
         title="Conduction band series",
-        description=r"Contains the computed energy of the bottom of the conduction band $Ec$.",
+        description="Contains the computed energy of the bottom of the conduction band :math:`E_c`.",
         discriminator=TYPE_TAG_STR,
     )
 
     Ev: UnstructuredFieldType = pd.Field(
         None,
         title="Valence band series",
-        description=r"Contains the computed energy of the top of the valence band $Ec$.",
+        description="Contains the computed energy of the top of the valence band :math:`E_v`.",
         discriminator=TYPE_TAG_STR,
     )
 
     Ei: UnstructuredFieldType = pd.Field(
         None,
         title="Intrinsic Fermi level series",
-        description=r"Contains the computed intrinsic Fermi level for the material $Ei$.",
+        description="Contains the computed intrinsic Fermi level for the material :math:`E_i`.",
         discriminator=TYPE_TAG_STR,
     )
 
     Efn: UnstructuredFieldType = pd.Field(
         None,
         title="Electron's quasi-Fermi level series",
-        description=r"Contains the computed quasi-Fermi level for electrons $Efn$.",
+        description="Contains the computed quasi-Fermi level for electrons :math:`E_{fn}`.",
         discriminator=TYPE_TAG_STR,
     )
 
     Efp: UnstructuredFieldType = pd.Field(
         None,
         title="Hole's quasi-Fermi level series",
-        description=r"Contains the computed quasi-Fermi level for holes $Efp$.",
+        description="Contains the computed quasi-Fermi level for holes :math:`E_{fp}`.",
         discriminator=TYPE_TAG_STR,
     )
 
@@ -276,13 +295,13 @@ class SteadyCapacitanceData(HeatChargeMonitorData):
 
     Notes
     -----
-        The small signal-capacitance of electrons :math:`C_n` and holes  :math:`C_p`  is computed from the charge due to
-         electrons :math:`Q_n` and holes :math:`Q_p` at an applied voltage :math:`V` at a voltage difference
-        :math:`\\Delta V` between two simulations.
 
-        .. math::
+    The small signal-capacitance of electrons  :math:`C_n`  and holes  :math:`C_p`  is computed from the charge due to electrons :math:`Q_n` and holes :math:`Q_p` at an applied voltage :math:`V` at a voltage difference
+    :math:`\\Delta V` between two simulations.
 
-            C_{n,p} = \\frac{Q_{n,p}(V + \\Delta V) - Q_{n,p}(V)}{\\Delta V}
+    .. math::
+
+        C_{n,p} = \\frac{Q_{n,p}(V + \\Delta V) - Q_{n,p}(V)}{\\Delta V}
 
 
     This is only computed when a voltage source with more than two sources is included within the simulation and determines the :math:`\\Delta V`.
@@ -297,14 +316,14 @@ class SteadyCapacitanceData(HeatChargeMonitorData):
     hole_capacitance: SteadyVoltageDataArray = pd.Field(
         None,
         title="Hole capacitance",
-        description=r"Small signal capacitance ($\frac{dQ_p}{dV}$) associated to the monitor.",
+        description="Small signal capacitance :math:`(\\frac{dQ_p}{dV})` associated to the monitor.",
     )
     # C_p = hole_capacitance
 
     electron_capacitance: SteadyVoltageDataArray = pd.Field(
         None,
         title="Electron capacitance",
-        description=r"Small signal capacitance ($\frac{dQn}{dV}$) associated to the monitor.",
+        description="Small signal capacitance :math:`(\\frac{dQn}{dV})` associated to the monitor.",
     )
     # C_n = electron_capacitance
 
@@ -361,7 +380,7 @@ class SteadyElectricFieldData(HeatChargeMonitorData):
     E: UnstructuredFieldType = pd.Field(
         None,
         title="Electric field",
-        description=r"Contains the computed electric field in :math:`V/\\mu m`.",
+        description="Contains the computed electric field in :math:`V/\\mu m`.",
         discriminator=TYPE_TAG_STR,
     )
 
@@ -403,7 +422,7 @@ class SteadyCurrentDensityData(HeatChargeMonitorData):
     J: UnstructuredFieldType = pd.Field(
         None,
         title="Current density",
-        description=r"Contains the computed current density in :math:`A/\\mu m^2`.",
+        description="Contains the computed current density in :math:`A/\\mu m^2`.",
         discriminator=TYPE_TAG_STR,
     )
 
diff --git a/tidy3d/components/tcad/data/sim_data.py b/tidy3d/components/tcad/data/sim_data.py
diff --git a/tidy3d/components/tcad/doping.py b/tidy3d/components/tcad/doping.py
diff --git a/tidy3d/components/tcad/simulation/heat_charge.py b/tidy3d/components/tcad/simulation/heat_charge.py
diff --git a/tidy3d/components/tcad/source/coupled.py b/tidy3d/components/tcad/source/coupled.py
diff --git a/tidy3d/components/tcad/source/heat.py b/tidy3d/components/tcad/source/heat.py
