Custom web flow for now

Author: daquinteroflex

tidy3d/plugins/smatrix/web/__init__.py

@@ -0,0 +1,69 @@
+# ruff: noqa: E402
+"""imports interfaces for interacting with server"""
+
+from __future__ import annotations
+
+from tidy3d.log import get_logging_console, log
+from tidy3d.version import __version__
+
+from .core import core_config
+
+# set logger to tidy3d.log before it's invoked in other imports
+core_config.set_config(log, get_logging_console(), __version__)
+
+# from .api.asynchronous import run_async # NOTE: we use autograd one now (see below)
+# autograd compatible wrappers for run and run_async
+from .api.autograd.autograd import run, run_async
+from .api.container import Batch, BatchData, Job
+from .api.webapi import (
+    abort,
+    account,
+    delete,
+    delete_old,
+    download,
+    download_json,
+    download_log,
+    estimate_cost,
+    get_info,
+    get_tasks,
+    load,
+    load_simulation,
+    monitor,
+    real_cost,
+    start,
+    test,
+    # run, # NOTE: use autograd one now (see below)
+    upload,
+)
+from .cli import tidy3d_cli
+from .cli.app import configure_fn as configure
+from .cli.migrate import migrate
+
+migrate()
+
+__all__ = [
+    "Batch",
+    "BatchData",
+    "Job",
+    "abort",
+    "account",
+    "configure",
+    "delete",
+    "delete_old",
+    "download",
+    "download_json",
+    "download_log",
+    "estimate_cost",
+    "get_info",
+    "get_tasks",
+    "load",
+    "load_simulation",
+    "monitor",
+    "real_cost",
+    "run",
+    "run_async",
+    "start",
+    "test",
+    "tidy3d_cli",
+    "upload",
+]

tidy3d/plugins/smatrix/web/api/__init__.py

@@ -0,0 +1,88 @@
+"""Interface to run several jobs in batch using simplified syntax."""
+
+from __future__ import annotations
+
+from typing import Literal, Optional, Union
+
+from tidy3d.log import log
+from tidy3d.web.core.types import PayType
+
+from .container import DEFAULT_DATA_DIR, Batch, BatchData
+from .tidy3d_stub import SimulationType
+
+
+def run_async(
+    simulations: dict[str, SimulationType],
+    folder_name: str = "default",
+    path_dir: str = DEFAULT_DATA_DIR,
+    callback_url: Optional[str] = None,
+    num_workers: Optional[int] = None,
+    verbose: bool = True,
+    simulation_type: str = "tidy3d",
+    parent_tasks: Optional[dict[str, list[str]]] = None,
+    reduce_simulation: Literal["auto", True, False] = "auto",
+    pay_type: Union[PayType, str] = PayType.AUTO,
+) -> BatchData:
+    """Submits a set of Union[:class:`.Simulation`, :class:`.HeatSimulation`, :class:`.EMESimulation`] objects to server,
+    starts running, monitors progress, downloads, and loads results as a :class:`.BatchData` object.
+
+    .. TODO add example and see also reference.
+
+    Parameters
+    ----------
+    simulations : Dict[str, Union[:class:`.Simulation`, :class:`.HeatSimulation`, :class:`.EMESimulation`]]
+        Mapping of task name to simulation.
+    folder_name : str = "default"
+        Name of folder to store each task on web UI.
+    path_dir : str
+        Base directory where data will be downloaded, by default current working directory.
+    callback_url : str = None
+        Http PUT url to receive simulation finish event. The body content is a json file with
+        fields ``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.
+    num_workers: int = None
+        Number of tasks to submit at once in a batch, if None, will run all at the same time.
+    verbose : bool = True
+        If ``True``, will print progressbars and status, otherwise, will run silently.
+    reduce_simulation: Literal["auto", True, False] = "auto"
+        Whether to reduce structures in the simulation to the simulation domain only. Note: currently only implemented for the mode solver.
+    pay_type: Union[PayType, str] = PayType.AUTO
+        Specify the payment method.
+
+    Returns
+    ------
+    :class:`BatchData`
+        Contains the Union[:class:`.SimulationData`, :class:`.HeatSimulationData`, :class:`.EMESimulationData`] for each
+        Union[:class:`.Simulation`, :class:`.HeatSimulation`, :class:`.EMESimulation`] in :class:`Batch`.
+
+    See Also
+    --------
+
+    :class:`Job`:
+        Interface for managing the running of a Simulation on server.
+
+    :class:`Batch`
+        Interface for submitting several :class:`Simulation` objects to sever.
+    """
+    if simulation_type is None:
+        simulation_type = "tidy3d"
+
+    # if number of workers not specified, just use the number of simulations
+    if num_workers is not None:
+        log.warning(
+            "The 'num_workers' kwarg does not have an effect anymore as all "
+            "simulations will now be uploaded in a single batch."
+        )
+
+    batch = Batch(
+        simulations=simulations,
+        folder_name=folder_name,
+        callback_url=callback_url,
+        verbose=verbose,
+        simulation_type=simulation_type,
+        parent_tasks=parent_tasks,
+        reduce_simulation=reduce_simulation,
+        pay_type=pay_type,
+    )
+
+    batch_data = batch.run(path_dir=path_dir)
+    return batch_data