gplugins 1.3.7__tar.gz → 1.4.0__tar.gz

{gplugins-1.3.7 → gplugins-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gplugins
-Version: 1.3.7
+Version: 1.4.0
 Summary: gdsfactory plugins
 Keywords: python
 Author-email: gdsfactory <contact@gdsfactory.com>
@@ -14,13 +14,15 @@ License-File: LICENSE
 Requires-Dist: gdsfactory>=9.3.5
 Requires-Dist: pint
 Requires-Dist: tqdm
-Requires-Dist: numpy
+Requires-Dist: numpy==2.2
 Requires-Dist: xarray==2025.1.2
+Requires-Dist: hypothesis ; extra == "dev"
+Requires-Dist: numba ; extra == "dev"
 Requires-Dist: pre-commit ; extra == "dev"
+Requires-Dist: pyswarms ; extra == "dev"
 Requires-Dist: pytest ; extra == "dev"
 Requires-Dist: pytest-cov ; extra == "dev"
 Requires-Dist: pytest_regressions ; extra == "dev"
-Requires-Dist: pyswarms ; extra == "dev"
 Requires-Dist: devsim ; extra == "devsim"
 Requires-Dist: pyvista<=0.43.8 ; extra == "devsim"
 Requires-Dist: tidy3d>=2.8.2,<2.9 ; extra == "devsim"
@@ -54,12 +56,13 @@ Requires-Dist: sortedcontainers ; extra == "luminescent"
 Requires-Dist: mypy ; extra == "maintainer"
 Requires-Dist: tbump ; extra == "maintainer"
 Requires-Dist: towncrier ; extra == "maintainer"
-Requires-Dist: jax>=0.4.26 ; extra == "meow"
-Requires-Dist: jaxlib>=0.4.26 ; extra == "meow"
-Requires-Dist: flax>=0.8.2 ; extra == "meow"
-Requires-Dist: meow-sim>=0.13,<0.14 ; extra == "meow"
+Requires-Dist: meow-sim>=0.14.1,<0.15 ; extra == "meow"
+Requires-Dist: sax>=0.15.6,<0.16.0 ; extra == "meow"
 Requires-Dist: tidy3d>=2.8.2,<2.9 ; extra == "meow"
-Requires-Dist: sax>=0.13.1,<0.15.0 ; extra == "sax"
+Requires-Dist: bokeh ; extra == "path-length-analysis"
+Requires-Dist: numba ; extra == "path-length-analysis"
+Requires-Dist: shapely ; extra == "path-length-analysis"
+Requires-Dist: sax>=0.15.6,<0.16.0 ; extra == "sax"
 Requires-Dist: bokeh ; extra == "schematic"
 Requires-Dist: ipywidgets ; extra == "schematic"
 Requires-Dist: natsort ; extra == "schematic"
@@ -77,12 +80,13 @@ Provides-Extra: klayout
 Provides-Extra: luminescent
 Provides-Extra: maintainer
 Provides-Extra: meow
+Provides-Extra: path-length-analysis
 Provides-Extra: sax
 Provides-Extra: schematic
 Provides-Extra: tidy3d
 Provides-Extra: vlsir
 
-# gplugins 1.3.7
+# gplugins 1.4.0
 
 [![docs](https://github.com/gdsfactory/gplugins/actions/workflows/pages.yml/badge.svg)](https://gdsfactory.github.io/gplugins/)
 [![PyPI](https://img.shields.io/pypi/v/gplugins)](https://pypi.org/project/gplugins/)
@@ -128,7 +132,7 @@ pip install "gdsfactory[full]" --upgrade
 or
 
 ```bash
-pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,ray,sax,tidy3d]" --upgrade
+pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,sax,tidy3d]" --upgrade
 ```
 
 Or install only the plugins you need. For example:

{gplugins-1.3.7 → gplugins-1.4.0}/README.md

@@ -1,4 +1,4 @@
-# gplugins 1.3.7
+# gplugins 1.4.0
 
 [![docs](https://github.com/gdsfactory/gplugins/actions/workflows/pages.yml/badge.svg)](https://gdsfactory.github.io/gplugins/)
 [![PyPI](https://img.shields.io/pypi/v/gplugins)](https://pypi.org/project/gplugins/)
@@ -44,7 +44,7 @@ pip install "gdsfactory[full]" --upgrade
 or
 
 ```bash
-pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,ray,sax,tidy3d]" --upgrade
+pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,sax,tidy3d]" --upgrade
 ```
 
 Or install only the plugins you need. For example:

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/__init__.py

@@ -1,6 +1,6 @@
 """gplugins - gdsfactory plugins."""
 
-__version__ = "1.3.7"
+__version__ = "1.4.0"
 
 import pathlib
 

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/common/config.py

@@ -25,6 +25,8 @@ class Path:
     klayout_tech = klayout / "tech.lyt"
     extra = repo / "extra"
     cwd = pathlib.Path.cwd()
+    notebooks = repo / "notebooks"
+    notebooks_data = notebooks / "data"
 
 
 PATH = Path()

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/common/utils/get_sparameters_path.py

@@ -4,6 +4,7 @@ import hashlib
 import pathlib
 from functools import partial
 from pathlib import Path
+from typing import Any
 
 import gdsfactory as gf
 import numpy as np
@@ -12,7 +13,7 @@ from gdsfactory.name import clean_value
 from gdsfactory.typings import ComponentSpec, PathType
 
 
-def get_kwargs_hash(**kwargs) -> str:
+def get_kwargs_hash(**kwargs: Any) -> str:
     """Returns kwargs parameters hash."""
     kwargs_list = [f"{key}={clean_value(kwargs[key])}" for key in sorted(kwargs.keys())]
     kwargs_string = "_".join(kwargs_list)
@@ -29,7 +30,7 @@ def get_component_hash(component: gf.Component) -> str:
 def _get_sparameters_path(
     component: ComponentSpec,
     dirpath: PathType | None = PATH.sparameters,
-    **kwargs,
+    **kwargs: Any,
 ) -> Path:
     """Return Sparameters npz filepath hashing simulation settings for a consistent unique name.
 
@@ -59,7 +60,7 @@ def _get_sparameters_path(
     return dirpath / f"{component.name}_{simulation_hash}.npz"
 
 
-def _get_sparameters_data(**kwargs) -> np.ndarray:
+def _get_sparameters_data(**kwargs: Any) -> np.ndarray[Any, Any]:
     """Returns Sparameters data in a pandas DataFrame.
 
     Keyword Args:
@@ -69,7 +70,8 @@ def _get_sparameters_data(**kwargs) -> np.ndarray:
 
     """
     filepath = _get_sparameters_path(**kwargs)
-    return np.load(filepath)
+    data = np.load(filepath)
+    return np.array(data)
 
 
 get_sparameters_path_meow = partial(_get_sparameters_path, tool="meow")

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/gmeep/get_meep_geometry.py

@@ -61,8 +61,11 @@ def get_meep_geometry_from_component(
             layer_tuple = gf.get_layer_tuple(layer.layer)
         elif isinstance(layer, DerivedLayer):
             layer_tuple = gf.get_layer_tuple(level.derived_layer.layer)
+        elif isinstance(layer, tuple):
+            # Handle plain tuple layers directly
+            layer_tuple = layer
         else:
-            raise ValueError(f"Layer {layer!r} is not a DerivedLayer or LogicalLayer")
+            raise ValueError(f"Layer {layer!r} is not a DerivedLayer, LogicalLayer, or tuple")
 
         layer_index = int(get_layer(layer_tuple))
 

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/klayout/dataprep/regions.py

@@ -1,14 +1,16 @@
+from __future__ import annotations
+
 import uuid
 from typing import Any
 
 import gdsfactory as gf
 import kfactory as kf
+import klayout.db as kdb
 from gdsfactory.component import GDSDIR_TEMP
 from gdsfactory.typings import PathType
-from kfactory import kdb
 
 
-def size(region: kdb.Region, offset: float, dbu=1e3) -> kdb.Region:
+def size(region: kdb.Region, offset: float, dbu: float = 1e3) -> kdb.Region:
     return region.dup().size(int(offset * dbu))
 
 
@@ -24,7 +26,7 @@ def copy(region: kdb.Region) -> kdb.Region:
     return region.dup()
 
 
-def _is_layer(value: any) -> bool:
+def _is_layer(value: Any) -> bool:
     try:
         layer, datatype = value
     except Exception:
@@ -32,21 +34,21 @@ def _is_layer(value: any) -> bool:
     return isinstance(layer, int) and isinstance(datatype, int)
 
 
-def _assert_is_layer(value: any) -> None:
+def _assert_is_layer(value: Any) -> None:
     if not _is_layer(value):
         raise ValueError(f"Layer must be a tuple of two integers. Got {value!r}")
 
 
 class Region(kdb.Region):
-    def __iadd__(self, offset) -> kdb.Region:
+    def __iadd__(self, offset: float | int) -> Region:
         """Adds an offset to the layer."""
         return size(self, offset)
 
-    def __isub__(self, offset) -> kdb.Region:
+    def __isub__(self, offset: float | int) -> Region:
         """Adds an offset to the layer."""
         return size(self, -offset)
 
-    def __add__(self, element) -> kdb.Region:
+    def __add__(self, element: float | int | kdb.Region) -> Region:
         """Adds an element to the region."""
         if isinstance(element, float | int):
             return size(self, element)
@@ -56,15 +58,17 @@ class Region(kdb.Region):
         else:
             raise ValueError(f"Cannot add type {type(element)} to region")
 
-    def __sub__(self, element: float | int | kdb.Region) -> kdb.Region | None:
+    def __sub__(self, element: float | int | kdb.Region) -> Region:
         """Subtracts an element from the region."""
         if isinstance(element, float | int):
             return size(self, -element)
 
         elif isinstance(element, kdb.Region):
             return boolean_not(self, element)
+        else:
+            raise ValueError(f"Cannot subtract type {type(element)} from region")
 
-    def copy(self) -> kdb.Region:
+    def copy(self) -> Region:
         return self.dup()
 
 

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/klayout/drc/count_drc.py

@@ -19,7 +19,7 @@ def count_drc(rdb_path: PathType, threshold: int = 0) -> dict[str, int]:
         threshold: Minimum number of errors to be included in the output.
     """
     rdb_path = pathlib.Path(rdb_path)
-    errors_dict = {}
+    errors_dict: dict[str, int] = {}
 
     if not rdb_path.exists():
         raise FileNotFoundError(f"Cannot find {rdb_path}")
@@ -27,14 +27,17 @@ def count_drc(rdb_path: PathType, threshold: int = 0) -> dict[str, int]:
     if not rdb_path.is_dir():
         return _get_errors(rdb_path, threshold, errors_dict)
     for rdb_file in rdb_path.glob("*.rdb"):
-        errors_dict[rdb_file.stem] = count_drc(rdb_file)
+        sub_result = count_drc(rdb_file, threshold)
+        errors_dict.update(sub_result)
 
     return errors_dict
 
 
-def _get_errors(rdb_path, threshold, errors_dict):
-    r = rdb.ReportDatabase()
-    r.load(rdb_path)
+def _get_errors(
+    rdb_path: PathType, threshold: int, errors_dict: dict[str, int]
+) -> dict[str, int]:
+    r = rdb.ReportDatabase("name")
+    r.load(str(rdb_path))
 
     categories = {cat.rdb_id(): cat for cat in r.each_category()}
 
@@ -72,7 +75,7 @@ def plot_drc(errors: dict[str, int]) -> None:
     Args:
         errors: Dict of error names to number of errors.
     """
-    plt.bar(errors.keys(), errors.values())
+    plt.bar(list(errors.keys()), list(errors.values()))
     plt.title("DRC Errors")
     plt.xlabel("Categories")
     plt.ylabel("Error count")

{gplugins-1.3.7 → gplugins-1.4.0}/gplugins/lumerical/write_sparameters_lumerical.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import shutil
 import time
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 import gdsfactory as gf
 import numpy as np
@@ -17,6 +17,8 @@ from gdsfactory.generic_tech.simulation_settings import (
 )
 from gdsfactory.pdk import get_layer_stack
 from gdsfactory.technology import LayerStack
+from gdsfactory.technology.layer_stack import DerivedLayer, LogicalLayer
+from gdsfactory.typings import LayerEnum
 
 from gplugins.common.utils.get_sparameters_path import (
     get_sparameters_path_lumerical as get_sparameters_path,
@@ -84,12 +86,13 @@ def write_sparameters_lumerical(
     material_name_to_lumerical: dict[str, MaterialSpec] | None = None,
     delete_fsp_files: bool = True,
     xmargin: float = 0,
-    ymargin: float = 0,
-    xmargin_left: float = 0,
-    xmargin_right: float = 0,
-    ymargin_top: float = 0,
-    ymargin_bot: float = 0,
+    ymargin: float = 3,
+    xmargin_left: float | None = None,
+    xmargin_right: float | None = None,
+    ymargin_top: float | None = None,
+    ymargin_bot: float | None = None,
     zmargin: float = 1.0,
+    exclude_layers: list[int] | None = None,
     **settings,
 ) -> np.ndarray:
     r"""Returns and writes component Sparameters using Lumerical FDTD.
@@ -140,6 +143,8 @@ def write_sparameters_lumerical(
         ymargin_top: top distance from component to PML.
         ymargin_bot: bottom distance from component to PML.
         zmargin: thickness for cladding above and below core.
+        exclude_layers: list of layer indices to exclude from simulation.
+        settings: additional simulation settings to overwrite
 
     Keyword Args:
         background_material: for the background.
@@ -201,6 +206,12 @@ def write_sparameters_lumerical(
     component = component
     sim_settings = dict(simulation_settings)
 
+
+    xmargin_left = xmargin_left or xmargin
+    xmargin_right = xmargin_right or xmargin
+    ymargin_top = ymargin_top or ymargin
+    ymargin_bot = ymargin_bot or ymargin
+
     layer_to_thickness = layer_stack.get_layer_to_thickness()
     layer_to_zmin = layer_stack.get_layer_to_zmin()
     layer_to_material = layer_stack.get_layer_to_material()
@@ -223,10 +234,10 @@ def write_sparameters_lumerical(
     component_with_padding = gf.add_padding_container(
         component_with_booleans,
         default=0,
-        top=ymargin or ymargin_top,
-        bottom=ymargin or ymargin_bot,
-        left=xmargin or xmargin_left,
-        right=xmargin or xmargin_right,
+        top=ymargin_top,
+        bottom=ymargin_bot,
+        left=xmargin_left,
+        right=xmargin_right,
     )
 
     component_extended = gf.components.extend_ports(
@@ -240,6 +251,10 @@ def write_sparameters_lumerical(
     component_extended_beyond_pml = gf.components.extension.extend_ports(
         component=component_extended, length=ss.port_extension
     )
+    component_extended_beyond_pml = component_extended_beyond_pml.copy()
+    component_extended_beyond_pml.flatten()
+    component_extended_beyond_pml.name = "top"
+
     gdspath = component_extended_beyond_pml.write_gds()
 
     filepath_npz = get_sparameters_path(
@@ -269,12 +284,27 @@ def write_sparameters_lumerical(
     index_to_thickness = {}
     index_to_zmin = {}
     for level in layer_stack.layers.values():
-        if level.derived_layer is None:
-            index_to_thickness[level.layer.layer] = level.thickness
-            index_to_zmin[level.layer.layer] = level.thickness
+        layer = level.layer
+
+        if isinstance(layer, LogicalLayer):
+            assert isinstance(layer.layer, tuple | LayerEnum)
+            layer_tuple = cast(tuple[int, int], 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))
+        elif isinstance(layer, tuple):
+            # Handle plain tuple layers directly
+            layer_tuple = cast(tuple[int, int], layer)
         else:
-            index_to_thickness[level.derived_layer.layer] = level.zmin
-            index_to_zmin[level.derived_layer.layer] = level.zmin
+            raise ValueError(
+                f"Layer {layer!r} is not a DerivedLayer, LogicalLayer, or tuple"
+            )
+
+        layer_index = int(gf.get_layer(layer_tuple))
+
+        index_to_thickness[layer_index] = level.thickness
+        index_to_zmin[layer_index] = level.zmin
 
     layers_thickness = [
         index_to_thickness[gf.get_layer(layer)]
@@ -344,6 +374,9 @@ def write_sparameters_lumerical(
         name="clad",
     )
 
+    # Set cladding opacity
+    s.setnamed("clad", "alpha", 0.1)
+
     material_name_to_lumerical_new = material_name_to_lumerical or {}
     material_name_to_lumerical = ss.material_name_to_lumerical.copy()
     material_name_to_lumerical.update(**material_name_to_lumerical_new)
@@ -364,39 +397,64 @@ def write_sparameters_lumerical(
         simulation_time=ss.simulation_time,
         simulation_temperature=ss.simulation_temperature,
     )
-    component_layers = component_with_booleans.layers
 
-    for layer, thickness in layer_to_thickness.items():
-        if layer not in component_layers:
-            continue
+    exclude_layers = exclude_layers or []
+    polygons_per_layer = component_extended_beyond_pml.get_polygons_points(merge=True)
 
-        if layer not in layer_to_material:
-            raise ValueError(f"{layer} not in {layer_to_material.keys()}")
-
-        material_name = layer_to_material[layer]
-        if material_name not in material_name_to_lumerical:
+    for level in layer_stack.layers.values():
+        layer = level.layer
+
+        if isinstance(layer, LogicalLayer):
+            layer_tuple = gf.get_layer_tuple(layer.layer)
+        elif isinstance(layer, DerivedLayer):
+            layer_tuple = gf.get_layer_tuple(level.derived_layer.layer)
+        elif isinstance(layer, tuple):
+            # Handle plain tuple layers directly
+            layer_tuple = layer
+        else:
             raise ValueError(
-                f"{material_name!r} not in {list(material_name_to_lumerical.keys())}"
+                f"Layer {layer!r} is not a DerivedLayer, LogicalLayer, or tuple"
             )
-        material = material_name_to_lumerical[material_name]
 
-        if layer not in layer_to_zmin:
-            raise ValueError(f"{layer} not in {list(layer_to_zmin.keys())}")
+        layer_index = int(gf.get_layer(layer_tuple))
+
+        if layer_index in exclude_layers:
+            continue
 
-        zmin = layer_to_zmin[layer]
-        zmax = zmin + thickness
-        z = (zmax + zmin) / 2
+        if layer_index not in polygons_per_layer:
+            continue
 
-        s.gdsimport(str(gdspath), "top", f"{layer[0]}:{layer[1]}")
-        layername = f"GDS_LAYER_{layer[0]}:{layer[1]}"
-        s.setnamed(layername, "z", z * 1e-6)
-        s.setnamed(layername, "z span", thickness * 1e-6)
-        set_material(session=s, structure=layername, material=material)
-        logger.info(f"adding {layer}, thickness = {thickness} um, zmin = {zmin} um ")
+        zmin = level.zmin
+
+        if zmin is not None:
+            thickness = level.thickness
+            material_name = layer_to_material[layer]
+            if material_name not in material_name_to_lumerical:
+                raise ValueError(
+                    f"{material_name!r} not in {list(material_name_to_lumerical.keys())}"
+                )
+            material = material_name_to_lumerical[material_name]
+
+            if layer not in layer_to_zmin:
+                raise ValueError(f"{layer} not in {list(layer_to_zmin.keys())}")
+
+            zmin = layer_to_zmin[layer]
+            zmax = zmin + thickness
+            z = (zmax + zmin) / 2
+
+            s.gdsimport(str(gdspath), "top", f"{layer_tuple[0]}:{layer_tuple[1]}")
+            layername = f"GDS_LAYER_{layer_tuple[0]}:{layer_tuple[1]}"
+            s.setnamed(layername, "z", z * 1e-6)
+            s.setnamed(layername, "z span", thickness * 1e-6)
+            set_material(session=s, structure=layername, material=material)
+            logger.info(
+                f"adding {layer_tuple}, thickness = {thickness} um, zmin = {zmin} um "
+            )
 
     for i, port in enumerate(ports):
-        zmin = layer_to_zmin[port.layer]
-        thickness = layer_to_thickness[port.layer]
+        port_layer_index = gf.get_layer(port.layer)
+        zmin = index_to_zmin[port_layer_index]
+        thickness = index_to_thickness[port_layer_index]
         z = (zmin + thickness) / 2
         zspan = 2 * ss.port_margin + thickness