Maybe we just need to upload the terminal compontn modeler as a job

Author: daquinteroflex

tidy3d/plugins/smatrix/component_modelers/terminal.py

@@ -28,7 +28,7 @@
 from tidy3d.plugins.smatrix.ports.coaxial_lumped import CoaxialLumpedPort
 from tidy3d.plugins.smatrix.ports.rectangular_lumped import LumpedPort
 from tidy3d.plugins.smatrix.ports.wave import WavePort
-from tidy3d.web.api.container import Batch, BatchData
+from tidy3d.web.api.container import Batch, BatchData, Job
 
 from .base import AbstractComponentModeler, TerminalPortType
 
@@ -663,8 +663,30 @@ def get_antenna_metrics_data(
     def run(self, path_dir: str = DEFAULT_DATA_DIR) -> TerminalPortDataArray:
         """Solves for the scattering matrix of the system."""
         _ = self.get_path_dir(path_dir)
+        _ = self._upload_terminal_modeler()
         return self._construct_smatrix()
 
+    @cached_property
+    def _terminal_modeler_path(self) -> str:
+        """Where we store the  for this :class:`TerminalComponentModeler` instance after the run."""
+        return os.path.join(self.path_dir, "tcp_" + str(hash(self)) + ".hdf5")
+
+    def _upload_terminal_modeler(self) -> Job:
+        # first try loading the terminal_component_modeler from file, if it exists
+        terminal_modeler_path = self._terminal_modeler_path
+
+        if os.path.exists(terminal_modeler_path):
+            return Job.from_file(fname=terminal_modeler_path)
+
+        return Job(
+            simulation=self,
+            folder_name=self.folder_name,
+            callback_url=self.callback_url,
+            verbose=self.verbose,
+            solver_version=self.solver_version,
+            simulation_type="microwave",
+        )
+
     @cached_property
     def batch(self) -> Batch:
         """:class:`.Batch` associated with this component modeler."""

tidy3d/web/api/tidy3d_stub.py

@@ -26,6 +26,7 @@
 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.plugins.smatrix import TerminalComponentModeler
 from tidy3d.web.core.file_util import (
     read_simulation_from_hdf5,
     read_simulation_from_hdf5_gz,
@@ -42,6 +43,7 @@
     ModeSolver,
     ModeSimulation,
     VolumeMesher,
+    TerminalComponentModeler,
 ]
 SimulationDataType = Union[
     SimulationData,
@@ -100,6 +102,9 @@ def from_file(cls, file_path: str) -> SimulationType:
             sim = ModeSimulation.from_file(file_path)
         elif type_ == "VolumeMesher":
             sim = VolumeMesher.from_file(file_path)
+        elif type_ == "TerminalComponentModeler":
+            # TODO Remove: An aberration this is here, but alas necessity.
+            sim = TerminalComponentModeler.from_file(file_path)
 
         return sim
 
@@ -162,6 +167,8 @@ def get_type(self) -> str:
             return TaskType.MODE.name
         elif isinstance(self.simulation, VolumeMesher):
             return TaskType.VOLUME_MESH.name
+        if isinstance(self.simulation, TerminalComponentModeler):
+            return TaskType.TERMINAL_COMPONENT_MODELER.name
 
     def validate_pre_upload(self, source_required) -> None:
         """Perform some pre-checks on instances of component"""

tidy3d/web/core/types.py

@@ -55,6 +55,7 @@ class TaskType(str, Enum):
     EME = "EME"
     MODE = "MODE"
     VOLUME_MESH = "VOLUME_MESH"
+    TERMINAL_COMPONENT_MODELER = "TERMINAL_COMPONENT_MODELER"
 
 
 class PayType(str, Enum):