add doctests

Author: dmarek-flex

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - `LayerRefinementSpec` defaults to assuming structures made of different materials are interior-disjoint for more efficient mesh generation.
 -  Removal of the Adjoint plugin.
+-  All RF and microwave specific components now inherit from `MicrowaveBaseModel`.
 
 ### Fixed
 - Stricter validation for `bend_radius` in mode simulations, preventing the bend center from coinciding with the simulation boundary.

schemas/EMESimulation.json

@@ -2368,7 +2368,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -2391,6 +2390,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],
@@ -2404,7 +2404,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -2427,6 +2426,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],

schemas/ModeSimulation.json

@@ -2411,7 +2411,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -2434,6 +2433,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],
@@ -2447,7 +2447,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -2470,6 +2469,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],

schemas/Simulation.json

@@ -2788,7 +2788,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -2811,6 +2810,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],
@@ -2824,7 +2824,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -2847,6 +2846,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],

schemas/TerminalComponentModeler.json

@@ -3197,7 +3197,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -3220,6 +3219,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],
@@ -3233,7 +3233,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -3256,6 +3255,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],
@@ -3269,7 +3269,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -3292,6 +3291,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],
@@ -3305,7 +3305,6 @@
           "type": "object"
         },
         "axis": {
-          "default": 2,
           "enum": [
             0,
             1,
@@ -3328,6 +3327,7 @@
         }
       },
       "required": [
+        "axis",
         "position",
         "vertices"
       ],

tests/test_components/test_geometry.py

@@ -1202,10 +1202,10 @@ def test_snap_box_to_grid_strict_behaviors():
     expanded_box = snap_box_to_grid(grid, box_coincident, snap_spec_strict_expand)
 
     # StrictExpand should move bounds outwards even when already on grid
-    assert expanded_box.bounds[0][0] < 0.1  # Left bound moved left from 0.1
-    assert expanded_box.bounds[1][0] > 0.1  # Right bound moved right from 0.1
-    assert expanded_box.bounds[0][1] < 0.2  # Bottom bound moved down from 0.2
-    assert expanded_box.bounds[1][1] > 0.2  # Top bound moved up from 0.2
+    assert np.isclose(expanded_box.bounds[0][0], 0.0)  # Left bound moved left from 0.1
+    assert np.isclose(expanded_box.bounds[1][0], 0.2)  # Right bound moved right from 0.1
+    assert np.isclose(expanded_box.bounds[0][1], 0.1)  # Bottom bound moved down from 0.2
+    assert np.isclose(expanded_box.bounds[1][1], 0.3)  # Top bound moved up from 0.2
 
     # Test StrictContract: should always move endpoints inwards, even if coincident
     box_large = td.Box(center=(0.5, 0.5, 0.5), size=(0.4, 0.4, 0.4))  # Spans multiple grid cells

tidy3d/components/data/monitor_data.py

@@ -1655,7 +1655,7 @@ class ModeData(ModeSolverDataset, ElectromagneticFieldData):
         None,
         title="Microwave Mode Dataset",
         description="Additional data relevant to RF and microwave applications, like characteristic impedance. "
-        "This field is populated when a :class:`MicrowaveModeSpec` has been provided to the :class:`ModeSpec`.",
+        "This field is populated when a :class:`MicrowaveModeSpec` has been used to set up the monitor or mode solver.",
     )
 
     @pd.validator("eps_spec", always=True)
@@ -3556,9 +3556,9 @@ class DirectivityData(FieldProjectionAngleData):
     >>> values = (1+1j) * np.random.random((len(r), len(theta), len(phi), len(f)))
     >>> flux_data = FluxDataArray(np.random.random(len(f)), coords=coords_flux)
     >>> scalar_field = FieldProjectionAngleDataArray(values, coords=coords)
-    >>> monitor = DirectivityMonitor(center=(1,2,3), size=(2,2,2), freqs=f, name='n2f_monitor', phi=phi, theta=theta) # doctest: +SKIP
+    >>> monitor = DirectivityMonitor(center=(1,2,3), size=(2,2,2), freqs=f, name='n2f_monitor', phi=phi, theta=theta)
     >>> data = DirectivityData(monitor=monitor, flux=flux_data, Er=scalar_field, Etheta=scalar_field, Ephi=scalar_field,
-    ...     Hr=scalar_field, Htheta=scalar_field, Hphi=scalar_field, projection_surfaces=monitor.projection_surfaces) # doctest: +SKIP
+    ...     Hr=scalar_field, Htheta=scalar_field, Hphi=scalar_field, projection_surfaces=monitor.projection_surfaces)
     """
 
     monitor: DirectivityMonitor = pd.Field(

tidy3d/components/lumped_element.py

@@ -16,9 +16,8 @@
 from tidy3d.components.validators import assert_line_or_plane, assert_plane, validate_name_str
 from tidy3d.constants import EPSILON_0, FARAD, HENRY, MICROMETER, OHM, fp_eps
 from tidy3d.exceptions import ValidationError
-from tidy3d.log import log
 
-from .base import Tidy3dBaseModel, cached_property, skip_if_fields_missing
+from .base import cached_property, skip_if_fields_missing
 from .geometry.base import Box, ClipOperation, Geometry, GeometryGroup
 from .geometry.primitives import Cylinder
 from .geometry.utils import (
@@ -29,6 +28,7 @@
     snap_point_to_grid,
 )
 from .geometry.utils_2d import increment_float
+from .microwave.base import MicrowaveBaseModel
 from .microwave.formulas.circuit_parameters import (
     capacitance_colinear_cylindrical_wire_segments,
     capacitance_rectangular_sheets,
@@ -50,7 +50,7 @@
 LOSS_FACTOR_INDUCTOR = 1e6
 
 
-class LumpedElement(Tidy3dBaseModel, ABC):
+class LumpedElement(MicrowaveBaseModel, ABC):
     """Base class describing the interface all lumped elements obey."""
 
     name: str = pd.Field(
@@ -104,14 +104,6 @@ def to_structures(self, grid: Grid = None) -> list[Structure]:
         which are ready to be added to the :class:`.Simulation`"""
         return [self.to_structure(grid)]
 
-    @pd.root_validator(pre=False)
-    def _warn_rf_license(cls, values):
-        log.warning(
-            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You have instantiated at least one RF-specific component.",
-            log_once=True,
-        )
-        return values
-
 
 class RectangularLumpedElement(LumpedElement, Box):
     """Class representing a rectangular element with zero thickness. A :class:`RectangularLumpedElement`
@@ -464,7 +456,7 @@ def geometry(self) -> ClipOperation:
         return self.to_geometry()
 
 
-class NetworkConversions(Tidy3dBaseModel):
+class NetworkConversions(MicrowaveBaseModel):
     """Helper functionality for directly computing complex conductivity and permittivities using
     equations in _`[1]`. Useful for testing the direct translations of lumped network parameters into
     an equivalent PoleResidue medium.
@@ -546,16 +538,8 @@ def complex_permittivity(a: tuple[float, ...], b: tuple[float, ...], freqs: np.n
         sigma = NetworkConversions.complex_conductivity(a, b, freqs)
         return 1j * sigma / (2 * np.pi * freqs * EPSILON_0)
 
-    @pd.root_validator(pre=False)
-    def _warn_rf_license(cls, values):
-        log.warning(
-            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You have instantiated at least one RF-specific component.",
-            log_once=True,
-        )
-        return values
-
 
-class RLCNetwork(Tidy3dBaseModel):
+class RLCNetwork(MicrowaveBaseModel):
     """Class for representing a simple network consisting of a resistor, capacitor, and inductor.
     Provides additional functionality for representing the network as an equivalent medium.
 
@@ -575,7 +559,7 @@ class RLCNetwork(Tidy3dBaseModel):
     >>> RL_series = RLCNetwork(resistance=75,
     ...                        inductance=1e-9,
     ...                        network_topology="series"
-    ...                       ) # doctest: +SKIP
+    ...                       )
 
     """
 
@@ -804,16 +788,8 @@ def _validate_single_element(cls, val, values):
             raise ValueError("At least one element must be defined in the 'RLCNetwork'.")
         return val
 
-    @pd.root_validator(pre=False)
-    def _warn_rf_license(cls, values):
-        log.warning(
-            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You have instantiated at least one RF-specific component.",
-            log_once=True,
-        )
-        return values
-
 
-class AdmittanceNetwork(Tidy3dBaseModel):
+class AdmittanceNetwork(MicrowaveBaseModel):
     """Class for representing a network consisting of an arbitrary number of resistors,
     capacitors, and inductors. The network is represented in the Laplace domain
     as an admittance function. Provides additional functionality for representing the network
@@ -857,7 +833,7 @@ class AdmittanceNetwork(Tidy3dBaseModel):
     >>> b = (R, 0)
     >>> RC_parallel = AdmittanceNetwork(a=a,
     ...                                 b=b
-    ...               ) # doctest: +SKIP
+    ...               )
 
     """
 
@@ -889,14 +865,6 @@ def _as_admittance_function(self) -> tuple[tuple[float, ...], tuple[float, ...]]
         """
         return (self.a, self.b)
 
-    @pd.root_validator(pre=False)
-    def _warn_rf_license(cls, values):
-        log.warning(
-            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You have instantiated at least one RF-specific component.",
-            log_once=True,
-        )
-        return values
-
 
 class LinearLumpedElement(RectangularLumpedElement):
     """Lumped element representing a network consisting of resistors, capacitors, and inductors.
@@ -919,14 +887,14 @@ class LinearLumpedElement(RectangularLumpedElement):
     >>> RL_series = RLCNetwork(resistance=75,
     ...                        inductance=1e-9,
     ...                        network_topology="series"
-    ...             ) # doctest: +SKIP
+    ...             )
     >>> linear_element = LinearLumpedElement(
     ...                         center=[0, 0, 0],
     ...                         size=[2, 0, 3],
     ...                         voltage_axis=0,
     ...                         network=RL_series,
     ...                         name="LumpedRL"
-    ...                   ) # doctest: +SKIP
+    ...                   )
 
 
     See Also

tidy3d/components/microwave/base.py

@@ -0,0 +1,40 @@
+"""Mixin for RF license warning."""
+
+from __future__ import annotations
+
+import sys
+
+import pydantic.v1 as pd
+
+from tidy3d.components.base import Tidy3dBaseModel
+from tidy3d.log import log
+
+
+def is_running_doctest():
+    """Detect if we're in a doctest environment (works with pytest)."""
+    # Check for pytest's doctest plugin
+    if "_pytest.doctest" in sys.modules:
+        return True
+
+    # Check for standard doctest module execution
+    if "doctest" in sys.modules:
+        doctest_mod = sys.modules["doctest"]
+        # Check if doctest.master exists (indicates active doctest run)
+        if hasattr(doctest_mod, "master") and doctest_mod.master is not None:
+            return True
+
+    return False
+
+
+class MicrowaveBaseModel(Tidy3dBaseModel):
+    """Base model that all RF and microwave specific components inherit from."""
+
+    @pd.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        # Skip warning during doctest runs
+        if not is_running_doctest():
+            log.warning(
+                "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You have instantiated at least one RF-specific component.",
+                log_once=True,
+            )
+        return values