dev configured right web

Author: daquinteroflex

docs/notebooks

@@ -10,7 +10,7 @@
 from tidy3d.plugins.smatrix.data.modal import ComponentModelerData, PortSimulationData
 from tidy3d.plugins.smatrix.data.terminal import TerminalComponentModelerData
 from tidy3d.plugins.smatrix.data.types import ComponentModelerDataType
-from tidy3d.web import Batch, BatchData
+from tidy3d.plugins.smatrix.web import Batch, BatchData
 
 DEFAULT_DATA_DIR = "."
 

tidy3d/plugins/smatrix/run.py

@@ -5,7 +5,7 @@
 from typing import Literal, Optional, Union
 
 from tidy3d.log import log
-from tidy3d.web.core.types import PayType
+from tidy3d.plugins.smatrix.web.core.types import PayType
 
 from .container import DEFAULT_DATA_DIR, Batch, BatchData
 from .tidy3d_stub import SimulationType

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

@@ -23,13 +23,13 @@
 from tidy3d.components.autograd.derivative_utils import DerivativeInfo
 from tidy3d.components.data.data_array import DataArray
 from tidy3d.exceptions import AdjointError
-from tidy3d.web.api.asynchronous import DEFAULT_DATA_DIR
-from tidy3d.web.api.asynchronous import run_async as run_async_webapi
-from tidy3d.web.api.container import DEFAULT_DATA_PATH, Batch, BatchData, Job
-from tidy3d.web.api.tidy3d_stub import SimulationDataType, SimulationType
-from tidy3d.web.api.webapi import run as run_webapi
-from tidy3d.web.core.s3utils import download_file, upload_file
-from tidy3d.web.core.types import PayType
+from tidy3d.plugins.smatrix.web.api.asynchronous import DEFAULT_DATA_DIR
+from tidy3d.plugins.smatrix.web.api.asynchronous import run_async as run_async_webapi
+from tidy3d.plugins.smatrix.web.api.container import DEFAULT_DATA_PATH, Batch, BatchData, Job
+from tidy3d.plugins.smatrix.web.api.tidy3d_stub import SimulationDataType, SimulationType
+from tidy3d.plugins.smatrix.web.api.webapi import run as run_webapi
+from tidy3d.plugins.smatrix.web.core.s3utils import download_file, upload_file
+from tidy3d.plugins.smatrix.web.core.types import PayType
 
 from .utils import E_to_D, FieldMap, TracerKeys, get_derivative_maps
 
@@ -166,11 +166,11 @@ def run(
 
         .. code-block:: python
 
-            sim_data = tidy3d.web.api.webapi.run(simulation, task_name='my_task', path='out/data.hdf5')
+            sim_data = tidy3d.plugins.smatrix.web.api.webapi.run(simulation, task_name='my_task', path='out/data.hdf5')
 
-        The :meth:`tidy3d.web.api.webapi.run()` method shows the simulation progress by default.  When uploading a
-        simulation to the server without running it, you can use the :meth:`tidy3d.web.api.webapi.monitor`,
-        :meth:`tidy3d.web.api.container.Job.monitor`, or :meth:`tidy3d.web.api.container.Batch.monitor` methods to
+        The :meth:`tidy3d.plugins.smatrix.web.api.webapi.run()` method shows the simulation progress by default.  When uploading a
+        simulation to the server without running it, you can use the :meth:`tidy3d.plugins.smatrix.web.api.webapi.monitor`,
+        :meth:`tidy3d.plugins.smatrix.web.api.container.Job.monitor`, or :meth:`tidy3d.plugins.smatrix.web.api.container.Batch.monitor` methods to
         display the progress of your simulation(s).
 
     Examples
@@ -189,13 +189,13 @@ def run(
     See Also
     --------
 
-    :meth:`tidy3d.web.api.webapi.monitor`
+    :meth:`tidy3d.plugins.smatrix.web.api.webapi.monitor`
         Print the real time task progress until completion.
 
-    :meth:`tidy3d.web.api.container.Job.monitor`
+    :meth:`tidy3d.plugins.smatrix.web.api.container.Job.monitor`
         Monitor progress of running :class:`Job`.
 
-    :meth:`tidy3d.web.api.container.Batch.monitor`
+    :meth:`tidy3d.plugins.smatrix.web.api.container.Batch.monitor`
         Monitor progress of each of the running tasks.
     """
     if priority is not None and (priority < 1 or priority > 10):
@@ -945,7 +945,7 @@ def setup_adj(
 
         import matplotlib.pylab as plt
 
-        import tidy3d.web as web
+        import tidy3d.plugins.smatrix.web as web
 
         sim_data_new = web.run(
             sims_adj[0].updated_copy(monitors=[adj_fld_mnt]),

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

@@ -18,11 +18,11 @@
 from tidy3d.components.types import annotate_type
 from tidy3d.exceptions import DataError
 from tidy3d.log import get_logging_console, log
-from tidy3d.web.api import webapi as web
-from tidy3d.web.core.constants import TaskId, TaskName
-from tidy3d.web.core.task_core import Folder
-from tidy3d.web.core.task_info import RunInfo, TaskInfo
-from tidy3d.web.core.types import PayType
+from tidy3d.plugins.smatrix.web.api import webapi as web
+from tidy3d.plugins.smatrix.web.core.constants import TaskId, TaskName
+from tidy3d.plugins.smatrix.web.core.task_core import Folder
+from tidy3d.plugins.smatrix.web.core.task_info import RunInfo, TaskInfo
+from tidy3d.plugins.smatrix.web.core.types import PayType
 
 from .tidy3d_stub import SimulationDataType, SimulationType
 
@@ -80,29 +80,29 @@ class Job(WebContainer):
     Examples
     --------
 
-        Once you've created a ``job`` object using :class:`tidy3d.web.api.container.Job`, you can upload it to our servers with:
+        Once you've created a ``job`` object using :class:`tidy3d.plugins.smatrix.web.api.container.Job`, you can upload it to our servers with:
 
         .. code-block:: python
 
-            tidy3d.web.upload(simulation, task_name="task_name", verbose=verbose)`
+            tidy3d.plugins.smatrix.web.upload(simulation, task_name="task_name", verbose=verbose)`
 
         It will not run until you explicitly tell it to do so with:
 
         .. code-block:: python
 
-            tidy3d.web.api.webapi.start(job.task_id)
+            tidy3d.plugins.smatrix.web.api.webapi.start(job.task_id)
 
         To monitor the simulation's progress and wait for its completion, use
 
         .. code-block:: python
 
-            tidy3d.web.api.webapi.monitor(job.task_id, verbose=verbose)
+            tidy3d.plugins.smatrix.web.api.webapi.monitor(job.task_id, verbose=verbose)
 
         After running the simulation, you can load the results using for example:
 
         .. code-block:: python
 
-            sim_data = tidy3d.web.api.webapi.load(job.task_id, path="out/simulation.hdf5", verbose=verbose)
+            sim_data = tidy3d.plugins.smatrix.web.api.webapi.load(job.task_id, path="out/simulation.hdf5", verbose=verbose)
 
         The job container has a convenient method to save and load the results of a job that has already finished,
         without needing to know the task_id, as below:
@@ -115,7 +115,7 @@ class Job(WebContainer):
             # You can exit the session, break here, or continue in new session.
 
             # Load the job metadata from file.
-            job_loaded = tidy3d.web.api.container.Job.from_file("data/job.json")
+            job_loaded = tidy3d.plugins.smatrix.web.api.container.Job.from_file("data/job.json")
 
             # Download the data from the server and load it into a SimulationData object.
             sim_data = job_loaded.load(path="data/sim.hdf5")
@@ -124,7 +124,7 @@ class Job(WebContainer):
     See Also
     --------
 
-    :meth:`tidy3d.web.api.webapi.run_async`
+    :meth:`tidy3d.plugins.smatrix.web.api.webapi.run_async`
         Submits a set of :class:`.Simulation` objects to server, starts running, monitors progress,
         downloads, and loads results as a :class:`.BatchData` object.
 
@@ -494,7 +494,7 @@ class Batch(WebContainer):
     See Also
     --------
 
-    :meth:`tidy3d.web.api.webapi.run_async`
+    :meth:`tidy3d.plugins.smatrix.web.api.webapi.run_async`
         Submits a set of :class:`.Simulation` objects to server, starts running, monitors progress,
         downloads, and loads results as a :class:`.BatchData` object.
 
@@ -600,7 +600,7 @@ def run(self, path_dir: str = DEFAULT_DATA_DIR) -> BatchData:
         ----
         A typical usage might look like:
 
-        >>> from tidy3d.web.api.container import Batch
+        >>> from tidy3d.plugins.smatrix.web.api.container import Batch
         >>> custom_batch = Batch()
         >>> batch_data = custom_batch.run() # doctest: +SKIP
         >>> for task_name, sim_data in batch_data.items(): # doctest: +SKIP

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

@@ -13,8 +13,8 @@
 from pydantic.v1 import BaseModel, Field
 
 from tidy3d.plugins.dispersion import DispersionFitter
-from tidy3d.web.core.http_util import http
-from tidy3d.web.core.types import Submittable
+from tidy3d.plugins.smatrix.web.core.http_util import http
+from tidy3d.plugins.smatrix.web.core.types import Submittable
 
 
 class ConstraintEnum(str, Enum):

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

@@ -9,8 +9,8 @@
 from pydantic.v1 import Field, parse_obj_as, validator
 
 from tidy3d.components.medium import MediumType
-from tidy3d.web.core.http_util import http
-from tidy3d.web.core.types import Queryable
+from tidy3d.plugins.smatrix.web.core.http_util import http
+from tidy3d.plugins.smatrix.web.core.types import Queryable
 
 
 class MaterialLibray(Queryable, smart_union=True):

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

@@ -22,12 +22,12 @@
 from tidy3d.log import get_logging_console, log
 from tidy3d.plugins.mode.mode_solver import MODE_MONITOR_NAME, ModeSolver
 from tidy3d.version import __version__
-from tidy3d.web.core.core_config import get_logger_console
-from tidy3d.web.core.environment import Env
-from tidy3d.web.core.http_util import http
-from tidy3d.web.core.s3utils import download_file, download_gz_file, upload_file
-from tidy3d.web.core.task_core import Folder
-from tidy3d.web.core.types import PayType, ResourceLifecycle, Submittable
+from tidy3d.plugins.smatrix.web.core.core_config import get_logger_console
+from tidy3d.plugins.smatrix.web.core.environment import Env
+from tidy3d.plugins.smatrix.web.core.http_util import http
+from tidy3d.plugins.smatrix.web.core.s3utils import download_file, download_gz_file, upload_file
+from tidy3d.plugins.smatrix.web.core.task_core import Folder
+from tidy3d.plugins.smatrix.web.core.types import PayType, ResourceLifecycle, Submittable
 
 SIMULATION_JSON = "simulation.json"
 SIM_FILE_HDF5_GZ = "simulation.hdf5.gz"

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

@@ -32,13 +32,13 @@
     TerminalComponentModeler,
     TerminalComponentModelerData,
 )
-from tidy3d.web.core.file_util import (
+from tidy3d.plugins.smatrix.web.core.file_util import (
     read_simulation_from_hdf5,
     read_simulation_from_hdf5_gz,
     read_simulation_from_json,
 )
-from tidy3d.web.core.stub import TaskStub, TaskStubData
-from tidy3d.web.core.types import TaskType
+from tidy3d.plugins.smatrix.web.core.stub import TaskStub, TaskStubData
+from tidy3d.plugins.smatrix.web.core.types import TaskType
 
 SimulationType = Union[
     Simulation,

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

@@ -16,19 +16,19 @@
 from tidy3d.components.mode.simulation import ModeSimulation
 from tidy3d.exceptions import WebError
 from tidy3d.log import get_logging_console, log
-from tidy3d.web.core.account import Account
-from tidy3d.web.core.constants import (
+from tidy3d.plugins.smatrix.web.core.account import Account
+from tidy3d.plugins.smatrix.web.core.constants import (
     MODE_DATA_HDF5_GZ,
     MODE_FILE_HDF5_GZ,
     SIM_FILE_HDF5,
     SIM_FILE_HDF5_GZ,
     SIMULATION_DATA_HDF5_GZ,
     TaskId,
 )
-from tidy3d.web.core.environment import Env
-from tidy3d.web.core.task_core import Folder, SimulationTask
-from tidy3d.web.core.task_info import ChargeType, TaskInfo
-from tidy3d.web.core.types import PayType
+from tidy3d.plugins.smatrix.web.core.environment import Env
+from tidy3d.plugins.smatrix.web.core.task_core import Folder, SimulationTask
+from tidy3d.plugins.smatrix.web.core.task_info import ChargeType, TaskInfo
+from tidy3d.plugins.smatrix.web.core.types import PayType
 
 from .connect_util import REFRESH_TIME, get_grid_points_str, get_time_steps_str, wait_for_connection
 from .tidy3d_stub import SimulationDataType, SimulationType, Tidy3dStub, Tidy3dStubData
@@ -132,11 +132,11 @@ def run(
 
         .. code-block:: python
 
-            sim_data = tidy3d.web.api.webapi.run(simulation, task_name='my_task', path='out/data.hdf5')
+            sim_data = tidy3d.plugins.smatrix.web.api.webapi.run(simulation, task_name='my_task', path='out/data.hdf5')
 
-        The :meth:`tidy3d.web.api.webapi.run()` method shows the simulation progress by default.  When uploading a
-        simulation to the server without running it, you can use the :meth:`tidy3d.web.api.webapi.monitor`,
-        :meth:`tidy3d.web.api.container.Job.monitor`, or :meth:`tidy3d.web.api.container.Batch.monitor` methods to
+        The :meth:`tidy3d.plugins.smatrix.web.api.webapi.run()` method shows the simulation progress by default.  When uploading a
+        simulation to the server without running it, you can use the :meth:`tidy3d.plugins.smatrix.web.api.webapi.monitor`,
+        :meth:`tidy3d.plugins.smatrix.web.api.container.Job.monitor`, or :meth:`tidy3d.plugins.smatrix.web.api.container.Batch.monitor` methods to
         display the progress of your simulation(s).
 
     Examples
@@ -155,13 +155,13 @@ def run(
     See Also
     --------
 
-    :meth:`tidy3d.web.api.webapi.monitor`
+    :meth:`tidy3d.plugins.smatrix.web.api.webapi.monitor`
         Print the real time task progress until completion.
 
-    :meth:`tidy3d.web.api.container.Job.monitor`
+    :meth:`tidy3d.plugins.smatrix.web.api.container.Job.monitor`
         Monitor progress of running :class:`Job`.
 
-    :meth:`tidy3d.web.api.container.Batch.monitor`
+    :meth:`tidy3d.plugins.smatrix.web.api.container.Batch.monitor`
         Monitor progress of each of the running tasks.
     """
     task_id = upload(
@@ -244,13 +244,13 @@ def upload(
     Notes
     -----
 
-        Once you've created a ``job`` object using :class:`tidy3d.web.api.container.Job`, you can upload it to our servers with:
+        Once you've created a ``job`` object using :class:`tidy3d.plugins.smatrix.web.api.container.Job`, you can upload it to our servers with:
 
         .. code-block:: python
 
             web.upload(simulation, task_name="task_name", verbose=verbose)
 
-        It will not run until you explicitly tell it to do so with :meth:`tidy3d.web.api.webapi.start`.
+        It will not run until you explicitly tell it to do so with :meth:`tidy3d.plugins.smatrix.web.api.webapi.start`.
 
     """
 
@@ -473,7 +473,7 @@ def monitor(task_id: TaskId, verbose: bool = True) -> None:
 
         .. code-block:: python
 
-            tidy3d.web.api.webapi.monitor(job.task_id, verbose=verbose).
+            tidy3d.plugins.smatrix.web.api.webapi.monitor(job.task_id, verbose=verbose).
 
     Parameters
     ----------
@@ -797,7 +797,7 @@ def load(
 
             sim_data = web.load(task_id, path="outt/sim.hdf5", verbose=verbose)
 
-        The :meth:`tidy3d.web.api.webapi.load` method is very convenient to load and postprocess results from simulations
+        The :meth:`tidy3d.plugins.smatrix.web.api.webapi.load` method is very convenient to load and postprocess results from simulations
         created using Tidy3D GUI.
 
     Parameters
@@ -1043,7 +1043,7 @@ def real_cost(task_id: str, verbose=True) -> float:
     Examples
     --------
 
-    To obtain the cost of a simulation, you can use the function ``tidy3d.web.real_cost(task_id)``. In the example
+    To obtain the cost of a simulation, you can use the function ``tidy3d.plugins.smatrix.web.real_cost(task_id)``. In the example
     below, a job is created, and its cost is estimated. After running the simulation, the real cost can be obtained.
 
     .. code-block:: python