Just add port simulation map

Author: daquinteroflex

tidy3d/plugins/smatrix/data/modal.py

@@ -9,17 +9,7 @@
 from tidy3d.plugins.smatrix.component_modelers.modal import ComponentModeler
 from tidy3d.plugins.smatrix.ports.types import PortReferenceType
 
-
-class PortSimulationData(Tidy3dBaseModel):  # TODO Debate typing.TypedDict instead, I prefer
-    """Stores raw simulation data from each microwave port-specific simulation."""
-
-    data: dict[PortReferenceType, SimulationData] = pd.Field(
-        ...,
-        title="Port Simulation Data",
-        description="A dictionary mapping each port TerminalPortType to its corresponding raw SimulationData object. "
-        "This contains the raw field and mode data from the individual simulations "
-        "run for each port to compute the S-parameters.",
-    )
+PortSimulationMap = dict[PortReferenceType, SimulationData]  # TODO debate if class
 
 
 class ComponentModelerData(Tidy3dBaseModel):
@@ -30,7 +20,7 @@ class ComponentModelerData(Tidy3dBaseModel):
         "and from which this data was generated.",
     )
 
-    data: PortSimulationData = pd.Field(
+    data: PortSimulationMap = 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 PortSimulationMap
 from tidy3d.plugins.smatrix.ports.types import TerminalPortType
 from tidy3d.plugins.smatrix.utils import (
     ab_to_s,
@@ -62,7 +62,7 @@ class TerminalComponentModelerData(Tidy3dBaseModel):
         "and from which this data was generated.",
     )
 
-    data: PortSimulationData = pd.Field(
+    data: PortSimulationMap = pd.Field(
         ...,
         title="Port-Simulation Data",
         description="Stores raw simulation data from each microwave port-specific simulation.",

tidy3d/plugins/smatrix/run.py

@@ -5,7 +5,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, PortSimulationMap
 from tidy3d.plugins.smatrix.data.terminal import TerminalComponentModelerData
 from tidy3d.plugins.smatrix.data.types import ComponentModelerDataType
 from tidy3d.web import Batch, BatchData
@@ -28,7 +28,7 @@ def compose_terminal_modeler_data(
     port_to_sim_data_map = {
         port_i: batch_data[modeler.get_task_name(port=port_i)] for port_i in modeler.ports
     }
-    port_simulation_data = PortSimulationData(data=port_to_sim_data_map)
+    port_simulation_data = PortSimulationMap(data=port_to_sim_data_map)
     return TerminalComponentModelerData(modeler=modeler, data=port_simulation_data)
 
 
@@ -39,7 +39,7 @@ def compose_component_modeler_data(
     port_to_sim_data_map = {
         port_i: batch_data[modeler.get_task_name(port=port_i)] for port_i in modeler.ports
     }
-    port_simulation_data = PortSimulationData(data=port_to_sim_data_map)
+    port_simulation_data = PortSimulationMap(data=port_to_sim_data_map)
     return ComponentModelerData(modeler=modeler, data=port_simulation_data)