Merge pull request #685 from David-GERARD/fix/cascaded-mzi-notebook

Fix: cascaded mzi notebook + tidy3d pluggin bug fixes

Author: joamatab

gplugins/tidy3d/component.py

@@ -523,8 +523,8 @@ def write_sparameters(
         symmetry=symmetry,
         **kwargs,
     )
-
-    path_dir = pathlib.Path(dirpath) / modeler._hash_self()
+    task_name = modeler._hash_self()
+    path_dir = pathlib.Path(dirpath) / task_name
     modeler = modeler.updated_copy()
 
     sp = {}
@@ -587,7 +587,12 @@ def write_sparameters(
         return dict(np.load(filepath))
     else:
         time.sleep(0.2)
-        modeler_data = web.run(modeler, verbose=verbose, path=dirpath / "simulation.hdf5")
+        modeler_data = web.run(
+            modeler,  # TODO: web.run does not currently support ComponentModeler, need to convert to tidy3d_stub.SimulationType
+            task_name=task_name,
+            verbose=verbose,
+            path=path_dir / "simulation.hdf5",
+        )
         s = modeler_data.smatrix()
         for port_in in s.port_in.values:
             for port_out in s.port_out.values:

notebooks/workflow_3_cascaded_mzi.ipynb

@@ -157,16 +157,6 @@
    "id": "9",
    "metadata": {},
    "outputs": [],
-   "source": [
-    "# s_params_list = [dict(np.load(PATH.sparameters_repo / f\"dc_{length}.npz\")) for length in sim_lengths]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "10",
-   "metadata": {},
-   "outputs": [],
    "source": [
     "wavelengths = s_params_list[0][\"wavelengths\"]\n",
     "drop = np.array([np.abs(s[\"o3@0,o1@0\"]) ** 2 for s in s_params_list])\n",
@@ -200,7 +190,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "11",
+   "id": "10",
    "metadata": {
     "lines_to_next_cell": 2
    },
@@ -213,7 +203,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "12",
+   "id": "11",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -246,7 +236,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "13",
+   "id": "12",
    "metadata": {},
    "source": [
     "Finally, we simulate the couplers with the calculated lengths to guarantee the fitting error is within tolerance.\n",
@@ -256,21 +246,19 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "14",
+   "id": "13",
    "metadata": {},
    "outputs": [],
    "source": [
-    "sims = gt.write_sparameters_batch(\n",
-    "    [\n",
-    "        {\n",
-    "            \"component\": coupler_sc(gap=gap, length=length),\n",
-    "            \"filepath\": PATH.sparameters_repo / f\"dc_{length}.npz\",\n",
-    "        }\n",
-    "        for length in lengths\n",
-    "    ],\n",
-    "    layer_stack=layer_stack,\n",
-    "    # overwrite=True,\n",
-    ")\n",
+    "jobs = [\n",
+    "    dict(\n",
+    "        component=coupler_sc(gap=gap, length=length),\n",
+    "        filepath=PATH.sparameters_repo / f\"dc_{length}.npz\",\n",
+    "        layer_stack=layer_stack,\n",
+    "    )\n",
+    "    for length in sim_lengths\n",
+    "]\n",
+    "sims = gt.write_sparameters_batch(jobs)\n",
     "s_params_list = [sim.result() for sim in sims]\n",
     "fig, ax = plt.subplots(1, 3, figsize=(12, 3))\n",
     "errors = []\n",
@@ -300,7 +288,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "15",
+   "id": "14",
    "metadata": {
     "lines_to_next_cell": 2
    },
@@ -317,7 +305,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "16",
+   "id": "15",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -362,7 +350,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "17",
+   "id": "16",
    "metadata": {
     "lines_to_next_cell": 2
    },
@@ -373,7 +361,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "18",
+   "id": "17",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -388,7 +376,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "19",
+   "id": "18",
    "metadata": {},
    "source": [
     "Finally, we want to build a complete simulation of the filter based on individual models for its components.\n",
@@ -399,7 +387,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "20",
+   "id": "19",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -409,7 +397,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "21",
+   "id": "20",
    "metadata": {},
    "source": [
     "The model for the straight sections is based directly on the waveguide mode, including dispersion effects."
@@ -418,7 +406,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "22",
+   "id": "21",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -438,7 +426,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "23",
+   "id": "22",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -467,7 +455,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "24",
+   "id": "23",
    "metadata": {
     "lines_to_next_cell": 2
    },
@@ -480,7 +468,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "25",
+   "id": "24",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -513,7 +501,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "26",
+   "id": "25",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -533,7 +521,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "27",
+   "id": "26",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -596,7 +584,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "28",
+   "id": "27",
    "metadata": {
     "lines_to_next_cell": 2
    },
@@ -607,7 +595,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "29",
+   "id": "28",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -704,7 +692,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "30",
+   "id": "29",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -714,7 +702,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "31",
+   "id": "30",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -724,7 +712,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "32",
+   "id": "31",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -734,7 +722,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "33",
+   "id": "32",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -743,7 +731,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "34",
+   "id": "33",
    "metadata": {},
    "source": [
     "Finally, we can simulate the complete filter response around the central wavelength and get the desired FSR and box-like shape."
@@ -752,7 +740,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "35",
+   "id": "34",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -780,7 +768,7 @@
    "custom_cell_magics": "kql"
   },
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "gplugins (3.11.14)",
    "language": "python",
    "name": "python3"
   },
@@ -794,7 +782,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.8"
+   "version": "3.11.14"
   }
  },
  "nbformat": 4,

pyproject.toml

@@ -13,7 +13,7 @@ classifiers = [
   "Operating System :: OS Independent"
 ]
 dependencies = [
-  "gdsfactory>=9.15.1",
+  "gdsfactory>=9.29.1",
   "pint",
   "tqdm",
   "numpy>=2.0,<3",