gplugins 1.3.6__tar.gz → 1.3.8__tar.gz

{gplugins-1.3.6 → gplugins-1.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gplugins
-Version: 1.3.6
+Version: 1.3.8
 Summary: gdsfactory plugins
 Keywords: python
 Author-email: gdsfactory <contact@gdsfactory.com>
@@ -82,7 +82,7 @@ Provides-Extra: schematic
 Provides-Extra: tidy3d
 Provides-Extra: vlsir
 
-# gplugins 1.3.6
+# gplugins 1.3.8
 
 [![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 +128,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.6 → gplugins-1.3.8}/README.md

@@ -1,4 +1,4 @@
-# gplugins 1.3.6
+# gplugins 1.3.8
 
 [![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.6 → gplugins-1.3.8}/gplugins/__init__.py

@@ -1,6 +1,6 @@
 """gplugins - gdsfactory plugins."""
 
-__version__ = "1.3.6"
+__version__ = "1.3.8"
 
 import pathlib
 

{gplugins-1.3.6 → gplugins-1.3.8}/gplugins/common/base_models/component.py

@@ -290,6 +290,9 @@ class LayeredComponentBase(BaseModel):
     def get_port_layers(self, port: gf.Port) -> tuple[str, ...]:
         layer_name = get_layer_name(port.layer)
 
+        if "_intent" in layer_name:
+            layer_name = layer_name.replace("_intent", "")
+
         derived_layers = []
         for l_name, level in self.layer_stack.layers.items():
             if layer_name in str(level.layer):

{gplugins-1.3.6 → gplugins-1.3.8}/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-1.3.6 → gplugins-1.3.8}/gplugins/gmeep/get_meep_geometry.py

@@ -58,14 +58,14 @@ 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)
+        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.6 → gplugins-1.3.8}/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 @@ settings_write_sparameters_meep = set(sig.parameters.keys()).union(
 )
 
 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 @@ if __name__ == "__main__":
     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-1.3.6 → gplugins-1.3.8}/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 @@ if __name__ == "__main__":
         temp_dir="./test/",
         filepath="instance_dict.csv",
         resolution=20,
+        is_3d=False,
     )
     sp = np.load(filepath)
     print(list(sp.keys()))

{gplugins-1.3.6 → gplugins-1.3.8}/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
 

{gplugins-1.3.6 → gplugins-1.3.8}/pyproject.toml

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