gplugins 1.2.4__tar.gz → 1.3.0__tar.gz

{gplugins-1.2.4 → gplugins-1.3.0}/PKG-INFO

@@ -1,28 +1,26 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: gplugins
-Version: 1.2.4
+Version: 1.3.0
 Summary: gdsfactory plugins
 Keywords: python
 Author-email: gdsfactory <contact@gdsfactory.com>
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: OS Independent
-Requires-Dist: gdsfactory>=8.5.3
+License-File: LICENSE
+Requires-Dist: gdsfactory>=9.0.0
 Requires-Dist: pint
 Requires-Dist: gdstk
 Requires-Dist: tqdm
 Requires-Dist: numpy
-Requires-Dist: dagster ; extra == "dagster"
-Requires-Dist: dagit ; extra == "dagster"
 Requires-Dist: pre-commit ; 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: ray ; extra == "dev"
 Requires-Dist: autograd ; extra == "dev"
 Requires-Dist: devsim ; extra == "devsim"
 Requires-Dist: pyvista<=0.43.8 ; extra == "devsim"
@@ -58,14 +56,16 @@ 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.11.0 ; extra == "meow"
+Requires-Dist: meow-sim>=0.11,<0.13 ; extra == "meow"
 Requires-Dist: tidy3d>=2.7.8,<2.8 ; extra == "meow"
+Requires-Dist: scipy<=1.14.1 ; extra == "meow"
 Requires-Dist: jax>=0.4.26 ; extra == "sax"
 Requires-Dist: jaxlib>=0.4.26 ; extra == "sax"
 Requires-Dist: flax>=0.8.2 ; extra == "sax"
 Requires-Dist: sax>=0.13.1,<0.15.0 ; extra == "sax"
 Requires-Dist: scikit-learn ; extra == "sax"
 Requires-Dist: pyvis<=0.3.1 ; extra == "sax"
+Requires-Dist: ray ; extra == "sax"
 Requires-Dist: bokeh ; extra == "schematic"
 Requires-Dist: ipywidgets ; extra == "schematic"
 Requires-Dist: natsort ; extra == "schematic"
@@ -75,7 +75,6 @@ Requires-Dist: numpy ; extra == "tidy3d"
 Requires-Dist: meshwell~=1.0.7 ; extra == "tidy3d"
 Requires-Dist: vlsir ; extra == "vlsir"
 Requires-Dist: vlsirtools ; extra == "vlsir"
-Provides-Extra: dagster
 Provides-Extra: dev
 Provides-Extra: devsim
 Provides-Extra: docs
@@ -91,7 +90,7 @@ Provides-Extra: schematic
 Provides-Extra: tidy3d
 Provides-Extra: vlsir
 
-# gplugins 1.2.4
+# gplugins 1.3.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/)

{gplugins-1.2.4 → gplugins-1.3.0}/README.md

@@ -1,4 +1,4 @@
-# gplugins 1.2.4
+# gplugins 1.3.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/)

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/__init__.py

@@ -1,6 +1,6 @@
 """gplugins - gdsfactory plugins."""
 
-__version__ = "1.2.4"
+__version__ = "1.3.0"
 
 import pathlib
 

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/common/base_models/component.py

@@ -108,8 +108,8 @@ class LayeredComponentBase(BaseModel):
     def ports(self) -> tuple[gf.Port, ...]:
         p = tuple(
             p.copy_polar(
-                p.kcl.to_dbu(self.extend_ports + self.pad_xy_inner - self.port_offset),
-                angle=p.angle,
+                self.extend_ports + self.pad_xy_inner - self.port_offset,
+                orientation=p.orientation,
             )
             for p in self.component.ports
         )

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/common/utils/add_simulation_markers.py

@@ -91,9 +91,9 @@ def add_simulation_markers(
         port_source_name = port_source.name
         warnings.warn(f"Selecting port_source_name={port_source_name!r} instead.")
 
-    assert isinstance(
-        component, Component
-    ), f"component needs to be a gf.Component, got Type {type(component)}"
+    assert isinstance(component, Component), (
+        f"component needs to be a gf.Component, got Type {type(component)}"
+    )
 
     # Add port monitors
     for port_name in port_names:
@@ -105,7 +105,9 @@ def add_simulation_markers(
 
     # Add source
     port = ref.ports[port_source_name]
-    port = port.copy_polar(d=port_source_offset / c.kcl.dbu, angle=port.angle)
+    port = port.copy_polar(
+        d=port_source_offset / c.kcl.dbu, orientation=port.orientation
+    )
     add_pin_rectangle(c, port=port, port_margin=port_margin, layer=layer_source)
 
     layer_stack.layers["source"] = LayerLevel(

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/common/utils/convert_sparameters.py

@@ -46,9 +46,9 @@ def pandas_to_numpy(df: pd.DataFrame, port_map=None) -> np.ndarray:
     if port_map is None:
         port_map = {f"o{i}@0": i for i in idxs}
     rev_port_map = {i: p for p, i in port_map.items()}
-    assert len(rev_port_map) == len(
-        port_map
-    ), "Duplicate port indices found in port_map"
+    assert len(rev_port_map) == len(port_map), (
+        "Duplicate port indices found in port_map"
+    )
 
     s_map = {
         s: tuple(rev_port_map[i] for i in _s_header_to_port_idxs(s)) for s in s_headers

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/common/utils/tests/test_get_component_with_new_port_layers.py

@@ -21,9 +21,9 @@ def test_component_with_new_port_layers() -> None:
     layernames_after = set(layer_stack.layers.keys())
 
     # Check we have two new layers in the LayerStack
-    assert (
-        len(layernames_after - layernames_before) == 2
-    ), "Two new layers should be added to the LayerStack"
+    assert len(layernames_after - layernames_before) == 2, (
+        "Two new layers should be added to the LayerStack"
+    )
 
     # Check we have one new layer in Component (all metal3 is removed by these operations)
     # assert len(new_component.get_layers()) == len(original_component.get_layers()) + 1

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/devsim/get_simulation_xsection.py

@@ -306,7 +306,7 @@ class PINWaveguide(BaseModel):
             device,
             "slab",
             "Acceptors",
-            f"{self.p_conc:1.3e}*step({-1*self.p_offset / cm:1.3e}-x) + {self.ppp_conc:1.3e}*step({self.xppp / cm:1.3e}-x)",
+            f"{self.p_conc:1.3e}*step({-1 * self.p_offset / cm:1.3e}-x) + {self.ppp_conc:1.3e}*step({self.xppp / cm:1.3e}-x)",
         )
         model_create.CreateNodeModel(
             device,
@@ -319,7 +319,7 @@ class PINWaveguide(BaseModel):
             device,
             "core",
             "Acceptors",
-            f"{self.p_conc:1.1e}*step({-1*self.p_offset / cm:1.6e}-x)",
+            f"{self.p_conc:1.1e}*step({-1 * self.p_offset / cm:1.6e}-x)",
         )
         model_create.CreateNodeModel(
             device,

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/elmer/get_capacitance.py

@@ -153,7 +153,7 @@ def _read_elmer_results(
                 field_file_location=simulation_folder
                 / raw_name
                 / "results"
-                / f'{raw_name}_t0001.{"pvtu" if n_processes > 1 else "vtu"}',
+                / f"{raw_name}_t0001.{'pvtu' if n_processes > 1 else 'vtu'}",
             )
         ),
     )

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/fdtdz/get_sparameters_fdtdz.py

@@ -98,9 +98,9 @@ def get_sparameters_fdtdz(
 
     optical_port_names = list(component_ref.get_ports_dict(port_type="optical").keys())
 
-    assert isinstance(
-        component, Component
-    ), f"component needs to be a gf.Component, got Type {type(component)}"
+    assert isinstance(component, Component), (
+        f"component needs to be a gf.Component, got Type {type(component)}"
+    )
 
     component_extended = (
         gf.components.extension.extend_ports(

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/femwell/mode_solver.py

@@ -1,4 +1,5 @@
 import time
+from typing import Any
 
 import gdsfactory as gf
 import numpy as np
@@ -34,20 +35,21 @@ def compute_cross_section_modes(
     order: int = 1,
     radius: float = np.inf,
     wafer_padding: float = 2.0,
-    **kwargs,
+    **kwargs: Any,
 ) -> Modes:
     """Calculate effective index of a cross-section.
 
     Defines a "straight" component of the cross_section, and calls compute_component_slice_modes.
 
     Args:
-        cross_section:
-        layer_stack:
+        cross_section: gdsfactory cross_section.
+        layer_stack: gdsfactory layer_stack.
         wavelength: in um.
         num_modes: to compute.
         order: order of the mesh elements. 1: linear, 2: quadratic.
         radius: defaults to inf.
         wafer_padding: in um.
+        kwargs: kwargs for compute_component_slice_modes
 
     Keyword Args:
         solver: can be slepc or scipy.
@@ -108,7 +110,7 @@ def compute_component_slice_modes(
     n_guess: float | None = None,
     solver: str = "scipy",
     material_name_to_index: dict[str, float] | None = None,
-    **kwargs,
+    **kwargs: Any,
 ) -> Modes:
     """Calculate effective index of component slice.
 
@@ -124,6 +126,8 @@ def compute_component_slice_modes(
         metallic_boundaries: if True, will set the boundaries to be metallic.
         n_guess: initial guess for the effective index.
         solver: can be slepc or scipy.
+        material_name_to_index: dictionary mapping material names to refractive indices.
+        kwargs: kwargs for get_mesh
 
     Keyword Args:
         resolutions (Dict): Pairs {"layername": {"resolution": float, "distance": "float}}

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/gmeep/get_simulation.py

@@ -158,9 +158,9 @@ def get_simulation(
         port_source_name = port_source.name
         warnings.warn(f"Selecting port_source_name={port_source_name!r} instead.")
 
-    assert isinstance(
-        component, Component
-    ), f"component needs to be a gf.Component, got Type {type(component)}"
+    assert isinstance(component, Component), (
+        f"component needs to be a gf.Component, got Type {type(component)}"
+    )
 
     component_extended = (
         gf.c.extend_ports(

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/gmsh/parse_component.py

@@ -88,7 +88,7 @@ def process_buffers(layer_polygons_dict: dict, layer_stack: LayerStack):
                     )
                     extended_layer_polygons_dict[f"{layername}_{poly_ind}_{z}"] = (
                         f"{layername}",
-                        f"{layername}_{poly_ind}_{zs[z_ind+1]}",
+                        f"{layername}_{poly_ind}_{zs[z_ind + 1]}",
                         polygon.buffer(width_buffer),
                         polygon.buffer(width_buffers[z_ind + 1]),
                     )

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/gmsh/parse_gds.py

@@ -30,14 +30,16 @@ def fuse_polygons(component, layer, round_tol=4, simplify_tol=1e-4, offset_tol=N
     # TODO: do all polygon processing in KLayout at the gplugins level for speed
     shapely_polygons = []
     for klayout_polygon in layer_region.each_merged():
-        exterior_points = []
+        exterior_points = [
+            (point.x / 1000, point.y / 1000)
+            for point in klayout_polygon.each_point_hull()
+        ]
         interior_points = []
-        for point in klayout_polygon.each_point_hull():
-            exterior_points.append((point.x / 1000, point.y / 1000))
         for hole_index in range(klayout_polygon.holes()):
-            holes_points = []
-            for point in klayout_polygon.each_point_hole(hole_index):
-                holes_points.append((point.x / 1000, point.y / 1000))
+            holes_points = [
+                (point.x / 1000, point.y / 1000)
+                for point in klayout_polygon.each_point_hole(hole_index)
+            ]
             interior_points.append(holes_points)
 
         shapely_polygons.append(

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/gmsh/xy_xsection_mesh.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from collections import OrderedDict
+from typing import Any
 
 import gdsfactory as gf
 import numpy as np
@@ -77,9 +78,9 @@ def xy_xsection_mesh(
     gmsh_version: float | None = None,
     interface_delimiter: str = "___",
     layer_port_delimiter: str | None = None,
-    background_remeshing_file=None,
+    background_remeshing_file: str | None = None,
     optimization_flags: tuple[tuple[str, int]] | None = None,
-    **kwargs,
+    **kwargs: Any,
 ):
     """Mesh xy cross-section of component at height z.
 
@@ -90,20 +91,25 @@ def xy_xsection_mesh(
         layer_physical_map: map layer names to physical names
         layer_meshbool_map: map layer names to mesh_bool (True: mesh the prisms, False: don't mesh)
         resolutions (Dict): Pairs {"layername": {"resolution": float, "distance": "float}} to roughly control mesh refinement
-        mesh_scaling_factor (float): factor multiply mesh geometry by
-        default_resolution_min (float): gmsh minimal edge length
-        default_resolution_max (float): gmsh maximal edge length
+        default_characteristic_length: default characteristic length for the mesh
         background_tag (str): name of the background layer to add (default: no background added)
         background_padding (Tuple): [xleft, ydown, xright, yup] distances to add to the components and to fill with background_tag
         background_mesh_order (int, float): mesh order to assign to the background
+        global_scaling: scaling factor for the mesh
+        global_scaling_premesh: scaling factor for the mesh before meshing
+        global_2D_algorithm: gmsh 2D algorithm to use
         filename (str, path): where to save the .msh file
-        global_meshsize_array: np array [x,y,z,lc] to parametrize the mesh
-        global_meshsize_interpolant_func: interpolating function for global_meshsize_array
-        extra_shapes_dict: Optional[OrderedDict] = OrderedDict of {key: geo} with key a label and geo a shapely (Multi)Polygon or (Multi)LineString of extra shapes to override component
+        verbosity: verbosity level for gmsh
         round_tol: during gds --> mesh conversion cleanup, number of decimal points at which to round the gdsfactory/shapely points before introducing to gmsh
         simplify_tol: during gds --> mesh conversion cleanup, shapely "simplify" tolerance (make it so all points are at least separated by this amount)
-        atol: tolerance used to establish equivalency between vertices
+        n_threads: number of threads to use for mesh generation
+        port_names: list of port names to mesh
+        gmsh_version: gmsh version to use
+        interface_delimiter: delimiter to use for new layers generated for interfaces: "layer{interface_delimiter}interface_name".
         layer_port_delimiter: Delimiter to use for new layers generated for ports: "layer{delimiter}port_name".
+        background_remeshing_file: filename to load background remeshing from.
+        optimization_flags: flags for Model.mesh
+        kwargs: kwargs for Model.mesh
     """
     if port_names:
         mesh_component = gf.Component()

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/dataprep/regions.py

@@ -1,4 +1,5 @@
 import uuid
+from typing import Any
 
 import gdsfactory as gf
 import kfactory as kf
@@ -46,6 +47,7 @@ class Region(kdb.Region):
         return size(self, -offset)
 
     def __add__(self, element) -> kdb.Region:
+        """Adds an element to the region."""
         if isinstance(element, float | int):
             return size(self, element)
 
@@ -54,7 +56,8 @@ class Region(kdb.Region):
         else:
             raise ValueError(f"Cannot add type {type(element)} to region")
 
-    def __sub__(self, element) -> kdb.Region | None:
+    def __sub__(self, element: float | int | kdb.Region) -> kdb.Region | None:
+        """Subtracts an element from the region."""
         if isinstance(element, float | int):
             return size(self, -element)
 
@@ -86,15 +89,17 @@ class RegionCollection:
 
     """
 
-    def __init__(self, gdspath, cell_name: str | None = None) -> None:
-        lib = kf.kcell.KCLayout(str(gdspath))
+    def __init__(self, gdspath: PathType, cell_name: str | None = None) -> None:
+        """Initializes the RegionCollection."""
+        lib = kf.KCLayout(str(gdspath))
         lib.read(filename=str(gdspath))
         self.layout = lib.cell_by_name(cell_name) if cell_name else lib.top_cell()
         self.lib = lib
-        self.regions = {}
+        self.regions: dict[tuple[int, int], Region] = {}
         self.cell = lib[lib.top_cell().cell_index()]
 
     def __getitem__(self, layer: tuple[int, int]) -> Region:
+        """Gets a layer from the collection."""
         _assert_is_layer(layer)
 
         if layer in self.regions:
@@ -107,11 +112,12 @@ class RegionCollection:
         return region
 
     def __setitem__(self, layer: tuple[int, int], region: Region) -> None:
+        """Sets a layer in the collection."""
         _assert_is_layer(layer)
         self.regions[layer] = region
 
-    def __contains__(self, item) -> bool:
-        # checks if the layout contains the given layer
+    def __contains__(self, item: tuple[int, int]) -> bool:
+        """Checks if the layout contains the given layer."""
         _assert_is_layer(item)
         layer, datatype = item
         return self.lib.find_layer(layer, datatype) is not None
@@ -157,7 +163,7 @@ class RegionCollection:
             uid = str(uuid.uuid4())[:8]
             cellname += f"_{uid}"
 
-        output_lib = kf.kcell.KCLayout("output")
+        output_lib = kf.KCLayout("output")
         c = kf.KCell(cellname, output_lib)
         if keep_original:
             c.copy_tree(self.layout)
@@ -169,11 +175,12 @@ class RegionCollection:
             c.shapes(output_lib.layer(layer[0], layer[1])).insert(region)
         return c
 
-    def show(self, gdspath: PathType = GDSDIR_TEMP / "out.gds", **kwargs) -> None:
+    def show(self, gdspath: PathType = GDSDIR_TEMP / "out.gds", **kwargs: Any) -> None:
         """Show gds in klayout.
 
         Args:
             gdspath: gdspath.
+            kwargs: keyword arguments.
 
         Keyword Args:
             keep_original: keep original cell.
@@ -183,6 +190,7 @@ class RegionCollection:
         gf.show(gdspath)
 
     def __delattr__(self, element) -> None:
+        """Deletes a layer from the collection."""
         setattr(self, element, Region())
 
 

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/drc/check_exclusion.py

@@ -18,8 +18,7 @@ def check_exclusion(
     min_projection: None = None,
     max_projection: None = None,
 ) -> int:
-    """Reads layer from top cell and returns a the area that violates min \
-    exclusion if 0 no area violates exclusion.
+    """Reads layer from top cell and returns a the area that violates min exclusion if 0 no area violates exclusion.
 
     Args:
         gdspath: path to GDS.
@@ -38,7 +37,7 @@ def check_exclusion(
         gdspath = gf.import_gds(gdspath)
 
     layout = gdspath.kcl
-    cell = gdspath._kdb_cell
+    cell = gdspath.kdb_cell
     a = pya.Region(cell.begin_shapes_rec(layout.layer(layer1[0], layer1[1])))
     b = pya.Region(cell.begin_shapes_rec(layout.layer(layer2[0], layer2[1])))
 

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/drc/check_inclusion.py

@@ -18,8 +18,7 @@ def check_inclusion(
     min_projection: None = None,
     max_projection: None = None,
 ) -> int:
-    """Reads layer from top cell and returns a the area that violates min \
-    inclusion if 0 no area violates exclusion.
+    """Reads layer from top cell and returns a the area that violates min inclusion if 0 no area violates exclusion.
 
     Args:
         gdspath: path to GDS.
@@ -38,7 +37,7 @@ def check_inclusion(
         gdspath = gf.import_gds(gdspath)
 
     layout = gdspath.kcl
-    cell = gdspath._kdb_cell
+    cell = gdspath.kdb_cell
     a = pya.Region(cell.begin_shapes_rec(layout.layer(layer_in[0], layer_in[1])))
     b = pya.Region(cell.begin_shapes_rec(layout.layer(layer_out[0], layer_out[1])))
 

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/drc/check_space.py

@@ -51,7 +51,7 @@ def check_space(
         gdspath = gf.import_gds(gdspath)
 
     layout = gdspath.kcl
-    cell = gdspath._kdb_cell
+    cell = gdspath.kdb_cell
     region = pya.Region(cell.begin_shapes_rec(layout.layer(layer[0], layer[1])))
 
     valid_metrics = ["Square", "Euclidean"]

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/drc/check_width.py

@@ -25,7 +25,7 @@ def check_width(
         gdspath = gf.import_gds(gdspath)
 
     layout = gdspath.kcl
-    cell = gdspath._kdb_cell
+    cell = gdspath.kdb_cell
     region = pya.Region(cell.begin_shapes_rec(layout.layer(layer[0], layer[1])))
     # print(region)
     # print(min_width*1e3)

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/drc/samples/drc_errors.py

@@ -46,8 +46,7 @@ def separation(
 def enclosing(
     enclosing: float = 0.1, layer1: Layer = (40, 0), layer2: Layer = (41, 0)
 ) -> Component:
-    """Layer1 must be enclosed by layer2 by value.
-    checks if layer1 encloses (is bigger than) layer2 by value.
+    """Layer1 must be enclosed by layer2 by value, checks if layer1 encloses (is bigger than) layer2 by value.
 
     Args:
         enclosing: value to enclose layer1 by layer2.

{gplugins-1.2.4 → gplugins-1.3.0}/gplugins/klayout/drc/write_drc.py

@@ -121,7 +121,7 @@ def check_not_inside(
     """
     if size is None:
         error = f"{layer} not inside {not_inside}"
-        return f"{layer}.not_inside({not_inside})" f".output({error!r}, {error!r})"
+        return f"{layer}.not_inside({not_inside}).output({error!r}, {error!r})"
     else:
         error = f"{layer} sized by {size} not inside {not_inside}"
         script = f"{layer}_sized = {layer}.size({size})\n "