Add tasks to webapi

Author: daquinteroflex

Untitled.ipynb

@@ -0,0 +1,5 @@
+import tidy3d as td
+import tidy3d.web as web
+
+task = web.load("he-172a2b2e-f576-4a3e-a90b-06a64194ed51")
+print(task)

docs/faq

@@ -4,11 +4,13 @@
 
 import warnings
 
-from .component_modelers.modal import AbstractComponentModeler, ComponentModeler, ModalPortDataArray
+from tidy3d.plugins.smatrix.data.data import ComponentModelerData, TerminalComponentModelerData
+from .component_modelers.modal import AbstractComponentModeler, ComponentModeler
 from .component_modelers.terminal import TerminalComponentModeler
 from .data.data_array import PortDataArray, TerminalPortDataArray
+from tidy3d.plugins.smatrix.data.data import TerminalComponentModelerData, ComponentModelerData
 from .ports.coaxial_lumped import CoaxialLumpedPort
-from .ports.modal import Port
+from .ports.modal import ModalPortDataArray, Port
 from .ports.rectangular_lumped import LumpedPort
 from .ports.wave import WavePort
 
@@ -24,11 +26,13 @@
     "AbstractComponentModeler",
     "CoaxialLumpedPort",
     "ComponentModeler",
+    "ComponentModelerData"
     "LumpedPort",
     "ModalPortDataArray",
     "Port",
     "PortDataArray",
     "TerminalComponentModeler",
+    "TerminalComponentModelerData"
     "TerminalPortDataArray",
     "WavePort",
 ]

docs/notebooks

@@ -46,6 +46,9 @@ class MicrowaveSMatrixData(Tidy3dBaseModel):
         "by terminal ports, representing the scattering parameters between them.",
     )
 
+class ComponentModelerData(Tidy3dBaseModel):
+    pass
+
 
 class TerminalComponentModelerData(Tidy3dBaseModel):
     """

test_task.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 ComponentModeler, ComponentModelerData, TerminalComponentModeler, TerminalComponentModelerData
 from tidy3d.web.core.file_util import (
     read_simulation_from_hdf5,
     read_simulation_from_hdf5_gz,
@@ -42,6 +43,8 @@
     ModeSolver,
     ModeSimulation,
     VolumeMesher,
+    ComponentModeler,
+    TerminalComponentModeler,
 ]
 SimulationDataType = Union[
     SimulationData,
@@ -50,6 +53,8 @@
     EMESimulationData,
     ModeSolverData,
     ModeSimulationData,
+    ComponentModelerData,
+    TerminalComponentModelerData
 ]
 
 
@@ -100,6 +105,10 @@ 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_ == "ComponentModeler":
+            sim = ComponentModeler.from_file(file_path)
+        elif type_ == "TerminalComponentModeler":
+            sim = TerminalComponentModeler.from_file(file_path)
 
         return sim
 
@@ -162,6 +171,10 @@ def get_type(self) -> str:
             return TaskType.MODE.name
         elif isinstance(self.simulation, VolumeMesher):
             return TaskType.VOLUME_MESH.name
+        elif isinstance(self.simulation, ComponentModeler):
+            return TaskType.COMPONENT_MODELER.name
+        elif 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"""
@@ -216,6 +229,10 @@ def from_file(cls, file_path: str) -> SimulationDataType:
             sim_data = ModeSimulationData.from_file(file_path)
         elif type_ == "VolumeMesherData":
             sim_data = VolumeMesherData.from_file(file_path)
+        elif type_ == "ComponentModelerData":
+            sim_data = ComponentModelerData.from_file(file_path)
+        elif type_ == "TerminalComponentModelerData":
+            sim_data = TerminalComponentModelerData.from_file(file_path)
 
         return sim_data
 

tidy3d/plugins/smatrix/__init__.py

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