Bring back run

Author: daquinteroflex

docs/notebooks

@@ -20,6 +20,7 @@
 from tidy3d.plugins.smatrix.ports.modal import Port
 from tidy3d.plugins.smatrix.ports.rectangular_lumped import LumpedPort
 from tidy3d.plugins.smatrix.ports.wave import WavePort
+from tidy3d.plugins.smatrix.run import compose_modeler_data, create_batch, run
 
 # Instantiate on plugin import till we unite with toplevel
 warnings.filterwarnings(
@@ -45,4 +46,7 @@
     "TerminalComponentModelerData",
     "TerminalPortDataArray",
     "WavePort",
+    "compose_modeler_data",
+    "create_batch",
+    "run",
 ]

tidy3d/plugins/smatrix/__init__.py

@@ -1,65 +1,77 @@
-# from __future__ import annotations
-#
-# from tidy3d.plugins.smatrix.component_modelers.modal import ComponentModeler
-# from tidy3d.plugins.smatrix.component_modelers.terminal import TerminalComponentModeler
-# from tidy3d.plugins.smatrix.component_modelers.types import (
-#     ComponentModelerType,
-# )
-# 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
-#
-# DEFAULT_DATA_DIR = "."
-#
-#
-# def create_batch(
-#     modeler: ComponentModelerType,
-#     path_dir: str = DEFAULT_DATA_DIR,
-#     file_name: str = "batch.hdf5" ** kwargs,
-# ) -> Batch:
-#     batch = Batch(simulations=modeler.sim_dict, **kwargs)
-#     batch.to_file(file_name)
-#
-#     return batch
-#
-#
-# def compose_terminal_modeler_data(
-#     modeler: TerminalComponentModeler,
-#     batch_data: BatchData = None,
-# ) -> TerminalComponentModelerData:
-#     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 = PortSimulationMap(data=port_to_sim_data_map)
-#     return TerminalComponentModelerData(modeler=modeler, data=port_simulation_data)
-#
-#
-# def compose_component_modeler_data(
-#     modeler: ComponentModeler,
-#     batch_data: BatchData = None,
-# ) -> ComponentModelerData:
-#     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 = PortSimulationMap(data=port_to_sim_data_map)
-#     return ComponentModelerData(modeler=modeler, data=port_simulation_data)
-#
-#
-# def run(
-#     modeler: ComponentModelerType,
-#     path_dir: str = DEFAULT_DATA_DIR,
-# ) -> ComponentModelerDataType:
-#     """
-#     This method internally determines which functions to run to compose the corresponding ComponentModelerDataType.
-#     """
-#     batch_data = run_batch(modeler=modeler, path_dir=path_dir)
-#
-#     if isinstance(modeler, ComponentModeler):
-#         modeler_data = compose_component_modeler_data(modeler=modeler, batch_data=batch_data)
-#     elif isinstance(modeler, TerminalComponentModeler):
-#         modeler_data = compose_terminal_modeler_data(modeler=modeler, batch_data=batch_data)
-#     else:
-#         raise Exception("sasas")
-#
-#     return modeler_data
+from __future__ import annotations
+
+from tidy3d.plugins.smatrix.component_modelers.modal import ComponentModeler
+from tidy3d.plugins.smatrix.component_modelers.terminal import TerminalComponentModeler
+from tidy3d.plugins.smatrix.component_modelers.types import (
+    ComponentModelerType,
+)
+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
+
+DEFAULT_DATA_DIR = "."
+
+
+def create_batch(
+    modeler: ComponentModelerType,
+    path_dir: str = DEFAULT_DATA_DIR,
+    file_name: str = "batch.hdf5",
+    **kwargs,
+) -> Batch:
+    batch = Batch(simulations=modeler.sim_dict, **kwargs)
+    batch.to_file(file_name)
+
+    return batch
+
+
+def compose_terminal_modeler_data(
+    modeler: TerminalComponentModeler,
+    batch_data: BatchData = None,
+) -> TerminalComponentModelerData:
+    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 = PortSimulationMap(data=port_to_sim_data_map)
+    return TerminalComponentModelerData(modeler=modeler, data=port_simulation_data)
+
+
+def compose_component_modeler_data(
+    modeler: ComponentModeler,
+    batch_data: BatchData = None,
+) -> ComponentModelerData:
+    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 = PortSimulationMap(data=port_to_sim_data_map)
+    return ComponentModelerData(modeler=modeler, data=port_simulation_data)
+
+
+def compose_modeler_data(
+    modeler: ComponentModelerType,
+    batch_data: BatchData = None,
+) -> ComponentModelerDataType:
+    """
+    This method internally determines which functions to run to compose the corresponding ComponentModelerDataType.
+    """
+    if isinstance(modeler, ComponentModeler):
+        modeler_data = compose_component_modeler_data(modeler=modeler, batch_data=batch_data)
+    elif isinstance(modeler, TerminalComponentModeler):
+        modeler_data = compose_terminal_modeler_data(modeler=modeler, batch_data=batch_data)
+    else:
+        raise Exception("sasas")
+
+    return modeler_data
+
+
+def run(
+    modeler: ComponentModelerType,
+    path_dir: str = DEFAULT_DATA_DIR,
+) -> ComponentModelerDataType:
+    """
+    This method internally determines which functions to run to compose the corresponding ComponentModelerDataType.
+    """
+    batch = create_batch(modeler=modeler, path_dir=path_dir)
+    batch_data = batch.run()
+    modeler_data = compose_modeler_data(modeler=modeler, batch_data=batch_data)
+    return modeler_data