cleanup

Author: daquinteroflex

tests/test_plugins/smatrix/test_component_modeler.py

@@ -8,7 +8,7 @@
 
 import tidy3d as td
 from tidy3d.exceptions import SetupError, Tidy3dKeyError
-from tidy3d.plugins.smatrix import ComponentModeler, ComponentModelerData, Port, PortSimulationData
+from tidy3d.plugins.smatrix import ComponentModeler, ComponentModelerData, Port, IndexSimulationData
 from tidy3d.web.api.container import Batch
 
 from ...utils import run_emulated
@@ -193,8 +193,8 @@ def make_component_modeler(**kwargs):
 def run_component_modeler(monkeypatch, modeler: ComponentModeler) -> ComponentModelerData:
     sim_dict = modeler.sim_dict
     batch_data = {task_name: run_emulated(sim) for task_name, sim in sim_dict.items()}
-    port_data = PortSimulationData(
-        ports=list(batch_data.keys()),
+    port_data = IndexSimulationData(
+        index=list(batch_data.keys()),
         data=list(batch_data.values()),
     )
     modeler_data = ComponentModelerData(modeler=modeler, data=port_data)

tests/test_plugins/smatrix/test_terminal_component_modeler.py

@@ -20,7 +20,7 @@
     CoaxialLumpedPort,
     LumpedPort,
     PortDataArray,
-    PortSimulationData,
+    IndexSimulationData,
     TerminalComponentModeler,
     TerminalComponentModelerData,
     TerminalPortDataArray,
@@ -39,8 +39,8 @@ def run_component_modeler(
 ) -> TerminalComponentModelerData:
     sim_dict = modeler.sim_dict
     batch_data = {task_name: run_emulated(sim) for task_name, sim in sim_dict.items()}
-    port_data = PortSimulationData(
-        ports=list(batch_data.keys()),
+    port_data = IndexSimulationData(
+        index=list(batch_data.keys()),
         data=list(batch_data.values()),
     )
     modeler_data = TerminalComponentModelerData(modeler=modeler, data=port_data)

tidy3d/components/data/index.py

@@ -0,0 +1,24 @@
+from tidy3d.components.simulaton_types import SimulationDataType
+from tidy3d.components.base import Tidy3dBaseModel
+
+class IndexSimulationData(Tidy3dBaseModel):
+    index: tuple[str, ...]
+    data: tuple[SimulationDataType, ...]
+
+    def __getitem__(self, index: str) -> SimulationDataType:
+        """
+        Allows retrieving simulation data by the port name.
+
+        Args:
+            port_name: The string name of the port to look up.
+
+        Returns:
+            The SimulationData object corresponding to the given port name.
+
+        Raises:
+            KeyError: If no port with the given name is found.
+        """
+        for i, index_i in enumerate(self.index):
+            if index_i == index:
+                return self.data[i]
+        raise KeyError(f"Index '{index}' not found.")

tidy3d/components/index.py

@@ -0,0 +1,26 @@
+from tidy3d.components.simulaton_types import SimulationType
+from tidy3d.components.base import Tidy3dBaseModel
+
+class IndexSimulation(Tidy3dBaseModel):
+    index: tuple[str, ...]
+    simulation: tuple[SimulationType, ...]
+
+    def __getitem__(self, index: str) -> SimulationType:
+        """
+        Allows retrieving simulation data by the port name.
+
+        Args:
+            port_name: The string name of the port to look up.
+
+        Returns:
+            The SimulationData object corresponding to the given port name.
+
+        Raises:
+            KeyError: If no port with the given name is found.
+        """
+        for i, index_i in enumerate(self.index):
+            if index_i == index:
+                return self.simulation[i]
+        raise KeyError(f"Index '{index}' not found.")
+
+

tidy3d/components/simulaton_types.py

@@ -0,0 +1,53 @@
+
+from __future__ import annotations
+
+import json
+from typing import Callable, Optional, Union
+
+import pydantic.v1 as pd
+from pydantic.v1 import BaseModel
+
+from tidy3d import log
+from tidy3d.components.base import _get_valid_extension
+from tidy3d.components.data.monitor_data import ModeSolverData
+from tidy3d.components.data.sim_data import SimulationData
+from tidy3d.components.eme.data.sim_data import EMESimulationData
+from tidy3d.components.eme.simulation import EMESimulation
+from tidy3d.components.mode.data.sim_data import ModeSimulationData
+from tidy3d.components.mode.simulation import ModeSimulation
+from tidy3d.components.simulation import Simulation
+from tidy3d.components.tcad.data.sim_data import (
+    HeatChargeSimulationData,
+    HeatSimulationData,
+    VolumeMesherData,
+)
+from tidy3d.components.tcad.mesher import VolumeMesher
+from tidy3d.components.tcad.simulation.heat import HeatSimulation
+from tidy3d.components.tcad.simulation.heat_charge import HeatChargeSimulation
+from tidy3d.plugins.mode.mode_solver import ModeSolver
+from tidy3d.web.core.file_util import (
+    read_simulation_from_hdf5,
+    read_simulation_from_hdf5_gz,
+    read_simulation_from_json,
+)
+from tidy3d.web.core.stub import TaskStub, TaskStubData
+from tidy3d.web.core.types import TaskType
+
+SimulationType = Union[
+    Simulation,
+    HeatChargeSimulation,
+    HeatSimulation,
+    EMESimulation,
+    ModeSolver,
+    ModeSimulation,
+    VolumeMesher,
+]
+SimulationDataType = Union[
+    SimulationData,
+    HeatChargeSimulationData,
+    HeatSimulationData,
+    EMESimulationData,
+    ModeSolverData,
+    ModeSimulationData,
+]
+

tidy3d/plugins/smatrix/__init__.py

@@ -15,7 +15,7 @@
     PortDataArray,
     TerminalPortDataArray,
 )
-from tidy3d.plugins.smatrix.data.modal import ComponentModelerData, PortSimulationData
+from tidy3d.plugins.smatrix.data.modal import ComponentModelerData
 from tidy3d.plugins.smatrix.data.terminal import MicrowaveSMatrixData, TerminalComponentModelerData
 from tidy3d.plugins.smatrix.data.types import ComponentModelerDataType
 from tidy3d.plugins.smatrix.ports.coaxial_lumped import CoaxialLumpedPort
@@ -45,7 +45,6 @@
     "ModalPortDataArray",
     "Port",
     "PortDataArray",
-    "PortSimulationData",
     "TerminalComponentModeler",
     "TerminalComponentModelerData",
     "TerminalPortDataArray",

tidy3d/plugins/smatrix/data/modal.py

@@ -6,33 +6,12 @@
 
 from tidy3d.components.base import Tidy3dBaseModel, cached_property
 from tidy3d.components.data.sim_data import SimulationData
+from tidy3d.components.data.index import IndexSimulationData
 from tidy3d.plugins.smatrix.component_modelers.modal import ComponentModeler
 from tidy3d.plugins.smatrix.data.data_array import ModalPortDataArray
 from tidy3d.plugins.smatrix.ports.types import PortReferenceType
 
 
-class PortSimulationData(Tidy3dBaseModel):
-    ports: tuple[PortReferenceType, ...]
-    data: tuple[SimulationData, ...]
-
-    def __getitem__(self, port_name: str) -> SimulationData:
-        """
-        Allows retrieving simulation data by the port name.
-
-        Args:
-            port_name: The string name of the port to look up.
-
-        Returns:
-            The SimulationData object corresponding to the given port name.
-
-        Raises:
-            KeyError: If no port with the given name is found.
-        """
-        for i, port_i in enumerate(self.ports):
-            if port_i == port_name:
-                return self.data[i]
-        raise KeyError(f"Port '{port_name}' not found.")
-
 
 class ComponentModelerData(Tidy3dBaseModel):
     modeler: ComponentModeler = pd.Field(
@@ -42,7 +21,7 @@ class ComponentModelerData(Tidy3dBaseModel):
         "and from which this data was generated.",
     )
 
-    data: PortSimulationData = pd.Field(
+    data: IndexSimulationData = pd.Field(
         ...,
         title="ComponentModeler",
         description="The original :class:`ComponentModeler` object that defines the simulation setup "

tidy3d/plugins/smatrix/data/terminal.py

@@ -15,7 +15,7 @@
 from tidy3d.log import log
 from tidy3d.plugins.smatrix.component_modelers.terminal import TerminalComponentModeler
 from tidy3d.plugins.smatrix.data.data_array import PortDataArray, TerminalPortDataArray
-from tidy3d.plugins.smatrix.data.modal import PortSimulationData
+from tidy3d.plugins.smatrix.data.modal import IndexSimulationData
 from tidy3d.plugins.smatrix.ports.types import TerminalPortType
 from tidy3d.plugins.smatrix.utils import (
     ab_to_s,
@@ -69,7 +69,7 @@ class TerminalComponentModelerData(Tidy3dBaseModel):
         "and from which this data was generated.",
     )
 
-    data: PortSimulationData = pd.Field(
+    data: IndexSimulationData = pd.Field(
         ...,
         title="Port-Simulation Data",
         description="Stores raw simulation data from each microwave port-specific simulation.",

tidy3d/plugins/smatrix/run.py

@@ -7,7 +7,7 @@
 from tidy3d.plugins.smatrix.component_modelers.types import (
     ComponentModelerType,
 )
-from tidy3d.plugins.smatrix.data.modal import ComponentModelerData, PortSimulationData
+from tidy3d.plugins.smatrix.data.modal import ComponentModelerData, IndexSimulationData
 from tidy3d.plugins.smatrix.data.terminal import TerminalComponentModelerData
 from tidy3d.plugins.smatrix.data.types import ComponentModelerDataType
 from tidy3d.plugins.smatrix.web import Batch, BatchData
@@ -74,7 +74,7 @@ def compose_terminal_modeler_data(
     """
     ports = [modeler.get_task_name(port=port_i) for port_i in modeler.ports]
     data = [batch_data[modeler.get_task_name(port=port_i)] for port_i in modeler.ports]
-    port_simulation_data = PortSimulationData(ports=ports, data=data)
+    port_simulation_data = IndexSimulationData(ports=ports, data=data)
     return TerminalComponentModelerData(modeler=modeler, data=port_simulation_data)
 
 
@@ -97,7 +97,7 @@ def compose_component_modeler_data(
     """
     ports = [modeler.get_task_name(port=port_i) for port_i in modeler.ports]
     data = [batch_data[modeler.get_task_name(port=port_i)] for port_i in modeler.ports]
-    port_simulation_data = PortSimulationData(ports=ports, data=data)
+    port_simulation_data = IndexSimulationData(ports=ports, data=data)
     return ComponentModelerData(modeler=modeler, data=port_simulation_data)