Testing endpoints

Author: daquinteroflex

tidy3d/plugins/smatrix/component_modelers/base.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import os
+import typing
 from abc import ABC, abstractmethod
 from typing import Optional, Union, get_args
 
@@ -22,7 +23,6 @@
 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.web.api.container import Batch, BatchData
 
 # fwidth of gaussian pulse in units of central frequency
 FWIDTH_FRAC = 1.0 / 10
@@ -35,6 +35,11 @@
 class AbstractComponentModeler(ABC, Tidy3dBaseModel):
     """Tool for modeling devices and computing port parameters."""
 
+    name: str = pd.Field(
+        "",
+        title="Simulation",
+        description="Simulation describing the device without any sources present.",
+    )
     simulation: Simulation = pd.Field(
         ...,
         title="Simulation",
@@ -99,7 +104,8 @@ class AbstractComponentModeler(ABC, Tidy3dBaseModel):
         "If not supplied, uses default for the current front end version.",
     )
 
-    batch_cached: Batch = pd.Field(
+    # TODO properly refactor, plugins should not have web methods.
+    batch_cached: typing.Any = pd.Field(
         None,
         title="Batch (Cached)",
         description="Optional field to specify ``batch``. Only used as a workaround internally "
@@ -176,8 +182,10 @@ def to_file(self, fname: str) -> None:
         super(AbstractComponentModeler, self).to_file(fname=fname)  # noqa: UP008
 
     @cached_property
-    def batch(self) -> Batch:
+    def batch(self):
         """:class:`.Batch` associated with this component modeler."""
+        # TODO properly refactor, plugins data types should not have web methods.
+        from tidy3d.web.api.container import Batch
 
         if self.batch_cached is not None:
             return self.batch_cached
@@ -202,7 +210,7 @@ def batch_path(self) -> str:
         return self.batch._batch_path(path_dir=self.path_dir)
 
     @cached_property
-    def batch_data(self) -> BatchData:
+    def batch_data(self):
         """The :class:`.BatchData` associated with the simulations run for this component modeler."""
         return self.batch.run(path_dir=self.path_dir)
 
@@ -224,7 +232,7 @@ def _batch_path(self) -> str:
         """Where we store the batch for this :class:`AbstractComponentModeler` instance after the run."""
         return os.path.join(self.path_dir, "batch" + str(hash(self)) + ".hdf5")
 
-    def _run_sims(self, path_dir: str = DEFAULT_DATA_DIR) -> BatchData:
+    def _run_sims(self, path_dir: str = DEFAULT_DATA_DIR):
         """Run :class:`.Simulation` for each port and return the batch after saving."""
         _ = self.get_path_dir(path_dir)
         self.batch.to_file(self._batch_path)
@@ -239,11 +247,11 @@ def get_port_by_name(self, port_name: str) -> Port:
         return ports[0]
 
     @abstractmethod
-    def _construct_smatrix(self, batch_data: BatchData) -> DataArray:
+    def _construct_smatrix(self, batch_data) -> DataArray:
         """Post process :class:`.BatchData` to generate scattering matrix."""
 
     @abstractmethod
-    def _internal_construct_smatrix(self, batch_data: BatchData) -> DataArray:
+    def _internal_construct_smatrix(self, batch_data) -> DataArray:
         """Post process :class:`.BatchData` to generate scattering matrix, for internal use only."""
 
     def run(self, path_dir: str = DEFAULT_DATA_DIR) -> DataArray:

tidy3d/plugins/smatrix/component_modelers/modal.py

@@ -19,7 +19,6 @@
 from tidy3d.components.viz import add_ax_if_none, equal_aspect
 from tidy3d.exceptions import SetupError
 from tidy3d.plugins.smatrix.ports.modal import ModalPortDataArray, Port
-from tidy3d.web.api.container import BatchData
 
 from .base import FWIDTH_FRAC, AbstractComponentModeler
 
@@ -277,7 +276,7 @@ def _construct_smatrix(self) -> ModalPortDataArray:
         """Post process :class:`.BatchData` to generate scattering matrix."""
         return self._internal_construct_smatrix(batch_data=self.batch_data)
 
-    def _internal_construct_smatrix(self, batch_data: BatchData) -> ModalPortDataArray:
+    def _internal_construct_smatrix(self, batch_data) -> ModalPortDataArray:
         """Post process :class:`.BatchData` to generate scattering matrix, for internal use only."""
 
         max_mode_index_out, max_mode_index_in = self.max_mode_index

tidy3d/plugins/smatrix/component_modelers/terminal.py

@@ -28,7 +28,6 @@
 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, Job
 
 from .base import AbstractComponentModeler, TerminalPortType
 
@@ -199,7 +198,7 @@ def _construct_smatrix(self) -> TerminalPortDataArray:
         """Post process :class:`.BatchData` to generate scattering matrix."""
         return self._internal_construct_smatrix(batch_data=self.batch_data)
 
-    def _internal_construct_smatrix(self, batch_data: BatchData) -> TerminalPortDataArray:
+    def _internal_construct_smatrix(self, batch_data) -> TerminalPortDataArray:
         """Post process :class:`.BatchData` to generate scattering matrix, for internal use only."""
 
         port_names = [port.name for port in self.ports]
@@ -464,10 +463,12 @@ def port_reference_impedances(self) -> PortDataArray:
         """The reference impedance used at each port for definining power wave amplitudes."""
         return self._port_reference_impedances(self.batch_data)
 
-    def _port_reference_impedances(self, batch_data: BatchData) -> PortDataArray:
+    def _port_reference_impedances(self, batch_data) -> PortDataArray:
         """Tabulates the reference impedance of each port at each frequency using the
         supplied :class:`.BatchData`.
         """
+        # TODO properly refactor, plugins data types should not have web methods.
+
         port_names = [port.name for port in self.ports]
 
         values = np.zeros(
@@ -671,7 +672,10 @@ 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:
+    def _upload_terminal_modeler(self):
+        # TODO properly refactor, plugins data types should not have web methods.
+        from tidy3d.web.api.container import Job
+
         # first try loading the terminal_component_modeler from file, if it exists
         terminal_modeler_path = self._terminal_modeler_path
 
@@ -680,6 +684,7 @@ def _upload_terminal_modeler(self) -> Job:
 
         return Job(
             simulation=self,
+            task_name=self.name,
             folder_name=self.folder_name,
             callback_url=self.callback_url,
             verbose=self.verbose,
@@ -688,8 +693,10 @@ def _upload_terminal_modeler(self) -> Job:
         )
 
     @cached_property
-    def batch(self) -> Batch:
+    def batch(self):
         """:class:`.Batch` associated with this component modeler."""
+        # TODO properly refactor, plugins data types should not have web methods.
+        from tidy3d.web.api.container import Batch
 
         if self.batch_cached is not None:
             return self.batch_cached