Passing taskType, cleanup and using MODAL_CM and TERMINAL_CM

Author: momchil-flex

tidy3d/config/profiles.py

@@ -21,8 +21,8 @@
     },
     "dev": {
         "web": {
-            "api_endpoint": "https://tidy3d-api.dev-simulation.cloud",
-            "website_endpoint": "https://tidy3d.dev-simulation.cloud",
+            "api_endpoint": "https://tidy3d2-api.dev-simulation.cloud",
+            "website_endpoint": "https://tidy3d2.dev-simulation.cloud",
             "s3_region": "us-east-1",
         }
     },

tidy3d/web/api/tidy3d_stub.py

@@ -46,8 +46,8 @@
     EMESimulation: TaskType.EME,
     ModeSimulation: TaskType.MODE,
     VolumeMesher: TaskType.VOLUME_MESH,
-    ModalComponentModeler: TaskType.COMPONENT_MODELER,
-    TerminalComponentModeler: TaskType.TERMINAL_COMPONENT_MODELER,
+    ModalComponentModeler: TaskType.MODAL_CM,
+    TerminalComponentModeler: TaskType.TERMINAL_CM,
 }
 
 

tidy3d/web/api/webapi.py

@@ -19,7 +19,6 @@
 from tidy3d.config import config
 from tidy3d.exceptions import WebError
 from tidy3d.log import get_logging_console, log
-from tidy3d.plugins.smatrix.component_modelers.terminal import TerminalComponentModeler
 from tidy3d.web.api.states import (
     ALL_POST_VALIDATE_STATES,
     END_STATES,
@@ -59,7 +58,7 @@
 SIM_FILE_JSON = "simulation.json"
 
 # not all solvers are supported yet in GUI
-GUI_SUPPORTED_TASK_TYPES = ["FDTD", "MODE_SOLVER", "HEAT", "RF"]
+GUI_SUPPORTED_TASK_TYPES = ["FDTD", "MODE_SOLVER", "HEAT", "TERMINAL_CM"]
 
 # if a solver is in beta stage, cost is subject to change
 BETA_TASK_TYPES = ["HEAT", "EME", "HEAT_CHARGE", "VOLUME_MESH"]
@@ -228,7 +227,7 @@ def restore_simulation_if_cached(
             cached_workflow_type = entry.metadata.get("workflow_type")
             if cached_task_id is not None and cached_workflow_type is not None and verbose:
                 console = get_logging_console()
-                url, _ = _get_task_urls(cached_workflow_type, simulation, cached_task_id)
+                url, _ = _get_task_urls(cached_workflow_type, cached_task_id)
                 console.log(
                     f"Loading simulation from local cache. View cached task using web UI at [link={url}]'{url}'[/link]."
                 )
@@ -429,15 +428,12 @@ def run(
 
 def _get_task_urls(
     task_type: str,
-    simulation: WorkflowType,
     resource_id: str,
     folder_id: Optional[str] = None,
     group_id: Optional[str] = None,
 ) -> tuple[str, Optional[str]]:
     """Log task and folder links to the web UI."""
-    if (task_type in ["RF", "COMPONENT_MODELER", "TERMINAL_COMPONENT_MODELER"]) and isinstance(
-        simulation, TerminalComponentModeler
-    ):
+    if task_type in ["RF", "TERMINAL_CM", "MODAL_CM"]:
         url = _get_url_rf(group_id or resource_id)
     else:
         url = _get_url(resource_id)
@@ -523,9 +519,6 @@ def upload(
         task_name = stub.get_default_task_name()
 
     task_type = stub.get_type()
-    # Component modeler compatibility: map to RF task type
-    if task_type in ("COMPONENT_MODELER", "TERMINAL_COMPONENT_MODELER"):
-        task_type = "RF"
 
     task = WebTask.create(
         task_type,
@@ -537,23 +530,8 @@ def upload(
         "Gz",
     )
 
-    if task_type == "RF":
-        # Prefer the group id if present in the creation response; avoid extra GET.
-        group_id = getattr(task, "groupId", None) or getattr(task, "group_id", None)
-        if not group_id:
-            try:
-                detail_task = SimulationTask.get(task.task_id, verbose=False)
-                group_id = getattr(detail_task, "groupId", None) or getattr(
-                    detail_task, "group_id", None
-                )
-            except Exception:
-                group_id = None
-        # Prefer returning batch/group id for downstream batch endpoints
-        task_id = getattr(task, "batchId", None) or getattr(task, "batch_id", None)
-        resource_id = task_id or task.task_id
-    else:
-        group_id = None
-        resource_id = task.task_id
+    group_id = getattr(task, "groupId", None)
+    resource_id = task.task_id
 
     if verbose:
         console.log(
@@ -566,16 +544,14 @@ def upload(
                 f"Cost of {solver_name} simulations is subject to change in the future."
             )
         if task_type in GUI_SUPPORTED_TASK_TYPES:
-            url, folder_url = _get_task_urls(
-                task_type, simulation, resource_id, task.folder_id, group_id
-            )
+            url, folder_url = _get_task_urls(task_type, resource_id, task.folder_id, group_id)
             console.log(f"View task using web UI at [link={url}]'{url}'[/link].")
             console.log(f"Task folder: [link={folder_url}]'{task.folder_name}'[/link].")
 
     remote_sim_file = SIM_FILE_HDF5_GZ
     if task_type == "MODE_SOLVER":
         remote_sim_file = MODE_FILE_HDF5_GZ
-    elif task_type == "RF":
+    elif task_type in ["RF", "TERMINAL_CM", "MODAL_CM"]:
         remote_sim_file = MODELER_FILE_HDF5_GZ
 
     task.upload_simulation(
@@ -981,9 +957,6 @@ def abort(task_id: TaskId) -> Optional[TaskInfo]:
     console.log(
         f"Task is aborting. View task using web UI at [link={url}]'{url}'[/link] to check the result."
     )
-    if isinstance(task, BatchTask):
-        detail = task.detail()
-        return TaskInfo(**{"taskId": task_id, "taskType": "RF", **detail.dict()})
     return TaskInfo(
         **{"taskId": task_id, "taskType": getattr(task, "task_type", None), **task.dict()}
     )

tidy3d/web/core/task_core.py

@@ -199,7 +199,7 @@ def create(
 
         folder = Folder.get(folder_name, create=True)
 
-        if task_type == "RF":
+        if task_type in ["RF", "TERMINAL_CM", "MODAL_CM"]:
             payload = {
                 "groupName": task_name,
                 "folderId": folder.folder_id,
@@ -217,16 +217,7 @@ def create(
                 "fileType": file_type,
             }
             resp = http.post(f"{projects_endpoint}/{folder.folder_id}/tasks", payload)
-        # RF group creation may return group-level info without 'taskId'.
-        # Use 'groupId' (or 'batchId' as fallback) as the resource id for subsequent uploads.
-        if "taskId" not in resp and task_type == "RF":
-            # Prefer using 'batchId' as the resource id for uploads (S3 STS expects a task-like id).
-            if "batchId" in resp:
-                resp["taskId"] = resp["batchId"]
-            elif "groupId" in resp:
-                resp["taskId"] = resp["groupId"]
-            else:
-                raise WebError("Missing resource ID for task creation. Contact customer support.")
+
         return SimulationTask(**resp, taskType=task_type, folder_name=folder_name)
 
     def get_url(self) -> str:
@@ -376,7 +367,7 @@ def delete(self, versions: bool = False) -> None:
         if not self.task_id:
             raise ValueError("Task id not found.")
 
-        task_details = self.detail()
+        task_details = self.detail().dict()
 
         if task_details and "groupId" in task_details:
             group_id = task_details["groupId"]

tidy3d/web/core/task_info.py

@@ -128,6 +128,9 @@ class TaskInfo(TaskBase):
     taskBlockInfo: TaskBlockInfo = None
     """Blocking information for the task."""
 
+    version: str = None
+    """Version of the task."""
+
 
 class RunInfo(TaskBase):
     """Information about the run of a task."""
@@ -257,6 +260,7 @@ class BatchDetail(TaskBase):
     tasks: list[BatchMember] = []
     validateErrors: dict = None
     taskType: str = "RF"
+    version: str = None
 
 
 class AsyncJobDetail(TaskBase):

tidy3d/web/core/types.py

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