gplugins 2.1.3__tar.gz → 2.1.5__tar.gz

{gplugins-2.1.3 → gplugins-2.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: gplugins
-Version: 2.1.3
+Version: 2.1.5
 Summary: gdsfactory plugins
 Keywords: python
 Author-email: gdsfactory <contact@gdsfactory.com>
@@ -88,7 +88,7 @@ Provides-Extra: tidy3d
 Provides-Extra: vlsir
 Import-Name: gplugins
 
-# gplugins 2.1.3
+# gplugins 2.1.5
 
 [![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/)

{gplugins-2.1.3 → gplugins-2.1.5}/README.md

@@ -1,4 +1,4 @@
-# gplugins 2.1.3
+# gplugins 2.1.5
 
 [![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/)

{gplugins-2.1.3 → gplugins-2.1.5}/gplugins/__init__.py

@@ -1,6 +1,6 @@
 """gplugins - gdsfactory plugins."""
 
-__version__ = "2.1.3"
+__version__ = "2.1.5"
 
 import pathlib
 

gplugins-2.1.5/gplugins/lumerical/tests/test_background_layers.py

@@ -0,0 +1,36 @@
+from types import SimpleNamespace
+
+import gdsfactory as gf
+from kfactory import kdb
+
+from gplugins.lumerical.write_sparameters_lumerical import (
+    _get_component_with_background_layers,
+)
+
+
+class _LayerStack:
+    def __init__(self, level: SimpleNamespace) -> None:
+        self.layers = {"background": level}
+
+    def get_component_with_derived_layers(
+        self, component: gf.Component
+    ) -> gf.Component:
+        return component.copy()
+
+
+def test_materializes_background_layer_with_exclusions() -> None:
+    component = gf.Component()
+    component.add_polygon([(0, 0), (10, 0), (10, 10), (0, 10)], layer=(3, 0))
+    component.add_polygon([(2, 2), (8, 2), (8, 8), (2, 8)], layer=(2, 0))
+    layer_stack = _LayerStack(
+        SimpleNamespace(
+            background=True,
+            layer=(1, 0),
+            background_exclude_layers=((2, 0),),
+        )
+    )
+
+    result = _get_component_with_background_layers(component, layer_stack)
+    region = kdb.Region(result.kdb_cell.begin_shapes_rec(result.kcl.layer(1, 0)))
+
+    assert region.area() == 64_000_000

gplugins-2.1.5/gplugins/lumerical/tests/test_write_sparameters_lumerical.py

@@ -0,0 +1,78 @@
+import sys
+from types import ModuleType
+
+import gdsfactory as gf
+from gdsfactory.technology import LayerLevel, LayerStack
+
+from gplugins.lumerical.write_sparameters_lumerical import write_sparameters_lumerical
+
+
+class _Session:
+    def __init__(self) -> None:
+        self.ports = 0
+
+    def newproject(self) -> None:
+        pass
+
+    def selectall(self) -> None:
+        pass
+
+    def deleteall(self) -> None:
+        pass
+
+    def addrect(self, **kwargs: object) -> None:
+        pass
+
+    def setnamed(self, *args: object) -> None:
+        pass
+
+    def addfdtd(self, **kwargs: object) -> None:
+        pass
+
+    def gdsimport(self, *args: object) -> None:
+        pass
+
+    def addport(self) -> None:
+        self.ports += 1
+
+    def setglobalsource(self, *args: object) -> None:
+        pass
+
+
+def test_keeps_ports_on_layers_not_in_layer_stack(monkeypatch, tmp_path) -> None:
+    monkeypatch.setitem(sys.modules, "lumapi", ModuleType("lumapi"))
+    component = gf.Component()
+    component.add_polygon([(0, 0), (10, 0), (10, 1), (0, 1)], layer=(1, 0))
+    component.add_port(
+        name="known",
+        center=(0, 0.5),
+        width=1,
+        orientation=180,
+        layer=(1, 0),
+        port_type="optical",
+    )
+    component.add_port(
+        name="unknown",
+        center=(10, 0.5),
+        width=1,
+        orientation=0,
+        layer=(2, 0),
+        port_type="optical",
+    )
+    layer_stack = LayerStack(
+        layers={
+            "core": LayerLevel(layer=(1, 0), thickness=0.22, zmin=0, material="sio2")
+        }
+    )
+    session = _Session()
+
+    result = write_sparameters_lumerical(
+        component,
+        session=session,
+        run=False,
+        dirpath=tmp_path,
+        layer_stack=layer_stack,
+    )
+
+    assert result is session
+    assert session.ports == 2

{gplugins-2.1.3 → gplugins-2.1.5}/gplugins/lumerical/write_sparameters_lumerical.py

@@ -53,6 +53,56 @@ def _add_material_name_aliases(
             material_mapping[canonical_name] = material_mapping[legacy_name]
 
 
+def _get_component_with_background_layers(
+    component: gf.Component, layer_stack: LayerStack
+) -> gf.Component:
+    """Materialize LayerStack background layers for simulation export.
+
+    Background layers occupy the component bounding box minus their declared
+    source-layer exclusions. ``get_component_with_derived_layers`` evaluates
+    derived layers but does not apply this background-layer semantics.
+    """
+    component_with_derived_layers = layer_stack.get_component_with_derived_layers(
+        component
+    )
+    if not any(
+        getattr(level, "background", False) for level in layer_stack.layers.values()
+    ):
+        return component_with_derived_layers
+
+    from kfactory import kdb
+
+    for level in layer_stack.layers.values():
+        if not getattr(level, "background", False):
+            continue
+
+        layer = level.layer
+        if isinstance(layer, LogicalLayer):
+            target_layer = gf.get_layer_tuple(layer.layer)
+        elif isinstance(layer, DerivedLayer):
+            assert level.derived_layer is not None
+            target_layer = gf.get_layer_tuple(level.derived_layer.layer)
+        elif isinstance(layer, tuple):
+            target_layer = layer
+        else:
+            raise ValueError(
+                f"Layer {layer!r} is not a DerivedLayer, LogicalLayer, or tuple"
+            )
+
+        background = kdb.Region(component.kdb_cell.bbox())
+        for excluded_layer in getattr(level, "background_exclude_layers", ()):
+            excluded_layer_tuple = gf.get_layer_tuple(excluded_layer)
+            excluded_layer_index = component.kcl.layer(*excluded_layer_tuple)
+            background -= kdb.Region(
+                component.kdb_cell.begin_shapes_rec(excluded_layer_index)
+            )
+
+        component_with_derived_layers.remove_layers([target_layer])
+        component_with_derived_layers.add_polygon(background, layer=target_layer)
+
+    return component_with_derived_layers
+
+
 def set_material(session, structure: str, material: MaterialSpec) -> None:
     """Sets the material of a structure.
 
@@ -228,7 +278,6 @@ def write_sparameters_lumerical(
     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()
 
@@ -246,18 +295,11 @@ def write_sparameters_lumerical(
     sim_settings.update(**settings)
     ss = SimulationSettingsLumericalFdtd(**sim_settings)
 
-    component_with_booleans = layer_stack.get_component_with_derived_layers(component)
-    component_with_padding = gf.add_padding_container(
-        component_with_booleans,
-        default=0,
-        top=ymargin_top,
-        bottom=ymargin_bot,
-        left=xmargin_left,
-        right=xmargin_right,
+    component_with_booleans = _get_component_with_background_layers(
+        component, layer_stack
     )
-
     component_extended = gf.components.extend_ports(
-        component_with_padding, length=ss.distance_monitors_to_pml
+        component_with_booleans, length=ss.distance_monitors_to_pml
     )
 
     ports = component.ports.filter(port_type="optical")
@@ -292,10 +334,10 @@ def write_sparameters_lumerical(
         print(run_false_warning)
 
     logger.info(f"Writing Sparameters to {filepath_npz.absolute()!r}")
-    x_min = (component_extended.xmin - xmargin) * 1e-6
-    x_max = (component_extended.xmax + xmargin) * 1e-6
-    y_min = (component_extended.ymin - ymargin) * 1e-6
-    y_max = (component_extended.ymax + ymargin) * 1e-6
+    x_min = (component_extended.xmin - xmargin_left) * 1e-6
+    x_max = (component_extended.xmax + xmargin_right) * 1e-6
+    y_min = (component_extended.ymin - ymargin_bot) * 1e-6
+    y_max = (component_extended.ymax + ymargin_top) * 1e-6
 
     index_to_thickness = {}
     index_to_zmin = {}
@@ -470,8 +512,14 @@ def write_sparameters_lumerical(
 
     for i, port in enumerate(ports):
         port_layer_index = gf.get_layer(port.layer)
-        zmin = index_to_zmin[port_layer_index]
-        thickness = index_to_thickness[port_layer_index]
+        zmin = index_to_zmin.get(port_layer_index, component_zmin)
+        thickness = index_to_thickness.get(port_layer_index, component_thickness)
+        if port_layer_index not in index_to_thickness:
+            logger.warning(
+                "Port %r is on a layer not defined in the layer stack; using the "
+                "component vertical extent for its mode port",
+                port.name,
+            )
         z = (zmin + thickness) / 2
         zspan = 2 * ss.port_margin + thickness
 

{gplugins-2.1.3 → gplugins-2.1.5}/gplugins/tidy3d/modes.py

@@ -23,7 +23,6 @@ import tidy3d as td
 import xarray
 from gdsfactory import logger
 from gdsfactory.config import PATH
-from gdsfactory.typings import PathType
 from pydantic.v1 import BaseModel
 from tidy3d.plugins import waveguide
 from tqdm.auto import tqdm
@@ -155,7 +154,9 @@ class Waveguide(BaseModel, extra="forbid", arbitrary_types_allowed=True):
     precision: Precision = "double"
     grid_resolution: int = 20
     max_grid_scaling: float = 1.2
-    cache_path: PathType | None = PATH.modes
+    # PathType is a PEP 695 type alias, which pydantic v1 cannot introspect,
+    # so the union is spelled out here.
+    cache_path: str | pathlib.Path | None = PATH.modes
     overwrite: bool = False
 
     _cached_data = pydantic.PrivateAttr()

{gplugins-2.1.3 → gplugins-2.1.5}/pyproject.toml

@@ -25,7 +25,7 @@ license = {file = "LICENSE"}
 name = "gplugins"
 readme = "README.md"
 requires-python = ">=3.11"
-version = "2.1.3"
+version = "2.1.5"
 
 [project.optional-dependencies]
 dev = [
@@ -186,7 +186,7 @@ message_template = "Bump to {new_version}"
 tag_template = "v{new_version}"
 
 [tool.tbump.version]
-current = "2.1.3"
+current = "2.1.5"
 regex = '''
   (?P<major>\d+)
   \.