Merge pull request #592 from gdsfactory/improve_meep_plugin

improve meep plugin and add tests

Author: joamatab

.github/workflows/test_code.yml

@@ -47,6 +47,33 @@ jobs:
         run: |
           uv run pytest gplugins/${{ matrix.plugin }}
 
+  test_meep:
+    runs-on: ubuntu-latest
+    name: Test meep ubuntu-latest 3.11
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Miniconda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          python-version: 3.11
+      - name: Install libglu1-mesa
+        run: |
+          sudo apt-get install -y libglu1-mesa
+      - name: Install dependencies
+        shell: bash -l {0}
+        run: |
+          conda create -n mp python=3.11 -y
+          conda activate mp
+          conda install -c conda-forge pymeep pymeep-extras gdsfactory -y
+          pip install .[meep,dev] setuptools
+          make test-data
+      - name: Test with pytest
+        shell: bash -l {0}
+        run: |
+          conda activate mp
+          pytest gplugins/gmeep
+
   test_code_coverage:
     runs-on: ubuntu-latest
     steps:

gplugins/common/utils/get_sparameters_path.py

@@ -31,8 +31,7 @@ def _get_sparameters_path(
     dirpath: PathType | None = PATH.sparameters,
     **kwargs,
 ) -> Path:
-    """Return Sparameters npz filepath hashing simulation settings for \
-            a consistent unique name.
+    """Return Sparameters npz filepath hashing simulation settings for a consistent unique name.
 
     Args:
         component: component or component factory.
@@ -47,7 +46,7 @@ def _get_sparameters_path(
 
     dirpath = pathlib.Path(dirpath)
     dirpath = (
-        dirpath / component.function_name
+        dirpath / component.name
         if hasattr(component, "function_name")
         else dirpath
     )

gplugins/gmeep/get_meep_geometry.py

@@ -58,12 +58,9 @@ def get_meep_geometry_from_component(
         layer = level.layer
 
         if isinstance(layer, LogicalLayer):
-            assert isinstance(layer.layer, tuple | LayerEnum)
-            layer_tuple = cast(tuple[int, int], tuple(layer.layer))
+            layer_tuple = gf.get_layer_tuple(layer.layer)
         elif isinstance(layer, DerivedLayer):
-            assert level.derived_layer is not None
-            assert isinstance(level.derived_layer.layer, tuple | LayerEnum)
-            layer_tuple = cast(tuple[int, int], tuple(level.derived_layer.layer))
+            layer_tuple = gf.get_layer_tuple(level.derived_layer.layer)
         else:
             raise ValueError(f"Layer {layer!r} is not a DerivedLayer or LogicalLayer")
 

gplugins/gmeep/write_sparameters_meep.py

@@ -54,8 +54,7 @@ def remove_simulation_kwargs(d: dict[str, Any]) -> dict[str, Any]:
 def parse_port_eigenmode_coeff(
     port_name: str, ports: dict[str, Port], sim_dict: dict, port_mode: int = 0
 ):
-    """Returns the coefficients relative to whether the wavevector is entering or \
-            exiting simulation.
+    """Returns the coefficients relative to whether the wavevector is entering or exiting simulation.
 
     Args:
         port_index: index of port.
@@ -320,7 +319,7 @@ def write_sparameters_meep(
     filepath = filepath or get_sparameters_path(
         component=component,
         dirpath=dirpath,
-        layer_stack=layer_stack,
+        layer_stack=layer_stack.to_dict(),
         **sim_settings,
     )
 
@@ -605,8 +604,8 @@ def sparameter_calculation(
 )
 
 if __name__ == "__main__":
-    wavelength_start = 1.26
-    wavelength_stop = 1.36
+    wavelength_start = 1.5
+    wavelength_stop = 1.6
     sim_settings = dict(
         wavelength_start=wavelength_start, wavelength_stop=wavelength_stop
     )
@@ -621,8 +620,9 @@ def func(x):
     sp = write_sparameters_meep(
         c,
         run=True,
-        animate=True,
+        #animate=True,
         is_3d=False,
+        ymargin=3,
         plot_args={
             "eps_parameters": {"contour": True},
             "field_parameters": {

gplugins/gmeep/write_sparameters_meep_mpi.py

@@ -45,7 +45,7 @@ def write_sparameters_meep_mpi(
     cores: int = core_materials,
     filepath: PathType | None = None,
     dirpath: PathType | None = None,
-    temp_dir: Path = temp_dir_default,
+    temp_dir: Path|str = temp_dir_default,
     temp_file_str: str = "write_sparameters_meep_mpi",
     live_output: bool = False,
     overwrite: bool = False,
@@ -152,6 +152,7 @@ def write_sparameters_meep_mpi(
         filepath.unlink()
 
     # Save all the simulation arguments for later retrieval
+    temp_dir = Path(temp_dir)
     temp_dir.mkdir(exist_ok=True, parents=True)
     tempfile = temp_dir / temp_file_str
     filepath_json = tempfile.with_suffix(".json")
@@ -178,7 +179,7 @@ def write_sparameters_meep_mpi(
         "if __name__ == '__main__':\n",
         f"\twith open(\"{parameters_file}\", 'rb') as inp:\n",
         "\t\tparameters_dict = pickle.load(inp)\n\n",
-        f"\tcomponent = import_gds({str(component_file)!r}, read_metadata=True)\n",
+        f"\tcomponent = import_gds({str(component_file)!r})\n",
         f"\tfilepath_json = pathlib.Path({str(filepath_json)!r})\n",
         "\tlayer_stack = LayerStack.parse_raw(filepath_json.read_text())\n",
         f"\twrite_sparameters_meep(component=component, overwrite={overwrite}, "
@@ -254,6 +255,7 @@ def write_sparameters_meep_mpi(
         temp_dir="./test/",
         filepath="instance_dict.csv",
         resolution=20,
+        is_3d=False,
     )
     sp = np.load(filepath)
     print(list(sp.keys()))

notebooks/meep_02_gratings.ipynb

@@ -154,16 +154,6 @@
     "\n",
     "You can also run a batch of multicore simulations"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "11",
-   "metadata": {},
-   "source": [
-    "## Far field\n",
-    "\n",
-    "TODO"
-   ]
   }
  ],
  "metadata": {
@@ -172,9 +162,21 @@
    "custom_cell_magics": "kql"
   },
   "kernelspec": {
-   "display_name": "base",
+   "display_name": "mp311",
    "language": "python",
    "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.9"
   }
  },
  "nbformat": 4,