gplugins 1.4.2__tar.gz → 2.0.1__tar.gz

{gplugins-1.4.2 → gplugins-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gplugins
-Version: 1.4.2
+Version: 2.0.1
 Summary: gdsfactory plugins
 Keywords: python
 Author-email: gdsfactory <contact@gdsfactory.com>
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 License-File: LICENSE
-Requires-Dist: gdsfactory>=9.3.5
+Requires-Dist: gdsfactory>=9.15.1
 Requires-Dist: pint
 Requires-Dist: tqdm
 Requires-Dist: numpy==2.2
@@ -24,45 +24,39 @@ Requires-Dist: pytest ; extra == "dev"
 Requires-Dist: pytest-cov ; extra == "dev"
 Requires-Dist: pytest_regressions ; extra == "dev"
 Requires-Dist: devsim ; extra == "devsim"
-Requires-Dist: pyvista<=0.43.8 ; extra == "devsim"
+Requires-Dist: pyvista<=0.46.0 ; extra == "devsim"
 Requires-Dist: tidy3d>=2.8.2,<2.9 ; extra == "devsim"
 Requires-Dist: jupytext ; extra == "docs"
 Requires-Dist: matplotlib ; extra == "docs"
 Requires-Dist: jupyter-book~=1.0 ; extra == "docs"
-Requires-Dist: pyvista[all]<=0.43.8 ; extra == "docs"
+Requires-Dist: pyvista[all]<=0.46.0 ; extra == "docs"
 Requires-Dist: bokeh ; extra == "docs"
 Requires-Dist: scikit-learn ; extra == "docs"
 Requires-Dist: femwell~=0.1.11 ; extra == "femwell"
-Requires-Dist: meshwell~=1.0.7 ; extra == "femwell"
+Requires-Dist: meshwell~=2.1.1 ; extra == "femwell"
 Requires-Dist: jinja2 ; extra == "gfviz"
 Requires-Dist: fastapi ; extra == "gfviz"
 Requires-Dist: shapely ; extra == "gfviz"
 Requires-Dist: natsort ; extra == "gfviz"
-Requires-Dist: gmsh==4.14.0 ; extra == "gmsh"
-Requires-Dist: h5py ; extra == "gmsh"
-Requires-Dist: mapbox_earcut ; extra == "gmsh"
-Requires-Dist: meshio ; extra == "gmsh"
-Requires-Dist: pygmsh ; extra == "gmsh"
-Requires-Dist: pyvista<=0.43.8 ; extra == "gmsh"
-Requires-Dist: trimesh ; extra == "gmsh"
-Requires-Dist: shapely ; extra == "gmsh"
-Requires-Dist: meshwell~=1.0.7 ; extra == "gmsh"
 Requires-Dist: klayout ; extra == "klayout"
 Requires-Dist: pyvis<=0.3.1 ; extra == "klayout"
 Requires-Dist: vlsir ; extra == "klayout"
 Requires-Dist: vlsirtools ; extra == "klayout"
+Requires-Dist: gitpython ; extra == "klayout"
 Requires-Dist: luminescent>=0.2.12,<0.4.0 ; extra == "luminescent"
 Requires-Dist: sortedcontainers ; extra == "luminescent"
 Requires-Dist: mypy ; extra == "maintainer"
 Requires-Dist: tbump ; extra == "maintainer"
 Requires-Dist: towncrier ; extra == "maintainer"
 Requires-Dist: meow-sim>=0.14.1,<0.15 ; extra == "meow"
-Requires-Dist: sax>=0.15.6,<0.16.0 ; extra == "meow"
+Requires-Dist: sax~=0.16.3 ; extra == "meow"
 Requires-Dist: tidy3d>=2.8.2,<2.9 ; extra == "meow"
+Requires-Dist: shapely ; extra == "meshwell"
+Requires-Dist: meshwell~=2.1.1 ; extra == "meshwell"
 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: sax~=0.16.3 ; extra == "sax"
 Requires-Dist: bokeh ; extra == "schematic"
 Requires-Dist: ipywidgets ; extra == "schematic"
 Requires-Dist: natsort ; extra == "schematic"
@@ -75,18 +69,18 @@ Provides-Extra: devsim
 Provides-Extra: docs
 Provides-Extra: femwell
 Provides-Extra: gfviz
-Provides-Extra: gmsh
 Provides-Extra: klayout
 Provides-Extra: luminescent
 Provides-Extra: maintainer
 Provides-Extra: meow
+Provides-Extra: meshwell
 Provides-Extra: path-length-analysis
 Provides-Extra: sax
 Provides-Extra: schematic
 Provides-Extra: tidy3d
 Provides-Extra: vlsir
 
-# gplugins 1.4.2
+# gplugins 2.0.1
 
 [![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/)
@@ -94,7 +88,9 @@ Provides-Extra: vlsir
 [![MIT](https://img.shields.io/github/license/gdsfactory/gplugins)](https://choosealicense.com/licenses/mit/)
 [![codecov](https://img.shields.io/codecov/c/github/gdsfactory/gplugins)](https://codecov.io/gh/gdsfactory/gdsfactory/tree/main/gplugins)
 
-GDSFactory plugins:
+## GDSFactory plugins
+
+Run simulations with GDSFactory by installing plugins.
 
 - Device simulators
     - Meshing
@@ -129,7 +125,7 @@ You can install most plugins with:
 pip install "gdsfactory[full]" --upgrade
 ```
 
-or
+Or list the plugins individually:
 
 ```bash
 pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,sax,tidy3d]" --upgrade
@@ -139,7 +135,6 @@ Or install only the plugins you need. For example:
 
 ```bash
 pip install "gplugins[schematic,femwell,meow,sax,tidy3d]" --upgrade
-
 ```
 
 ### Non-pip plugins
@@ -152,7 +147,8 @@ The following plugins require special installation as they can't be installed wi
 
 ## Installation for contributors
 
-We recommend `uv` for installing GDSFactory:
+We recommend `uv` for installing GDSfactory.
+If you don't already have uv, install with the following command:
 
 ```bash
 # On macOS and Linux.
@@ -164,17 +160,17 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-Then you can install gdsfactory with:
+-Then you can install GDSFactory with:
 
 ```bash
-uv venv --python 3.11
+uv venv --python 3.12
 uv sync --extra docs --extra dev
 ```
 
-
 ## Getting started
 
-- [Read docs](https://gdsfactory.github.io/gplugins/)
-- [Read gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)
-- [![Join the chat at https://gitter.im/gdsfactory-dev/community](https://badges.gitter.im/gdsfactory-dev/community.svg)](https://gitter.im/gdsfactory-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+- [Read the gplugins docs](https://gdsfactory.github.io/gplugins/)
+- [Read the GDSFactory docs](https://gdsfactory.github.io/gdsfactory/)
+- [Read the GDSFactory+ docs](https://gdsfactory.com/plus/))
+- [Join the discussion at GDSFactory Community Slack](https://join.slack.com/t/gdsfactory-community/shared_invite/zt-3aoygv7cg-r5BH6yvL4YlHfY8~UXp0Wg)
 

{gplugins-1.4.2 → gplugins-2.0.1}/README.md

@@ -1,4 +1,4 @@
-# gplugins 1.4.2
+# gplugins 2.0.1
 
 [![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/)
@@ -6,7 +6,9 @@
 [![MIT](https://img.shields.io/github/license/gdsfactory/gplugins)](https://choosealicense.com/licenses/mit/)
 [![codecov](https://img.shields.io/codecov/c/github/gdsfactory/gplugins)](https://codecov.io/gh/gdsfactory/gdsfactory/tree/main/gplugins)
 
-GDSFactory plugins:
+## GDSFactory plugins
+
+Run simulations with GDSFactory by installing plugins.
 
 - Device simulators
     - Meshing
@@ -41,7 +43,7 @@ You can install most plugins with:
 pip install "gdsfactory[full]" --upgrade
 ```
 
-or
+Or list the plugins individually:
 
 ```bash
 pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,sax,tidy3d]" --upgrade
@@ -51,7 +53,6 @@ Or install only the plugins you need. For example:
 
 ```bash
 pip install "gplugins[schematic,femwell,meow,sax,tidy3d]" --upgrade
-
 ```
 
 ### Non-pip plugins
@@ -64,7 +65,8 @@ The following plugins require special installation as they can't be installed wi
 
 ## Installation for contributors
 
-We recommend `uv` for installing GDSFactory:
+We recommend `uv` for installing GDSfactory.
+If you don't already have uv, install with the following command:
 
 ```bash
 # On macOS and Linux.
@@ -76,16 +78,16 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-Then you can install gdsfactory with:
+-Then you can install GDSFactory with:
 
 ```bash
-uv venv --python 3.11
+uv venv --python 3.12
 uv sync --extra docs --extra dev
 ```
 
-
 ## Getting started
 
-- [Read docs](https://gdsfactory.github.io/gplugins/)
-- [Read gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)
-- [![Join the chat at https://gitter.im/gdsfactory-dev/community](https://badges.gitter.im/gdsfactory-dev/community.svg)](https://gitter.im/gdsfactory-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+- [Read the gplugins docs](https://gdsfactory.github.io/gplugins/)
+- [Read the GDSFactory docs](https://gdsfactory.github.io/gdsfactory/)
+- [Read the GDSFactory+ docs](https://gdsfactory.com/plus/))
+- [Join the discussion at GDSFactory Community Slack](https://join.slack.com/t/gdsfactory-community/shared_invite/zt-3aoygv7cg-r5BH6yvL4YlHfY8~UXp0Wg)

{gplugins-1.4.2 → gplugins-2.0.1}/gplugins/__init__.py

@@ -1,6 +1,6 @@
 """gplugins - gdsfactory plugins."""
 
-__version__ = "1.4.2"
+__version__ = "2.0.1"
 
 import pathlib
 

{gplugins-1.4.2 → gplugins-2.0.1}/gplugins/common/base_models/component.py

@@ -87,6 +87,31 @@ def cleanup_component(component, layer_stack, round_tol=2, simplify_tol=1e-2):
     }
 
 
+def cleanup_component_layermap(component, layermap, round_tol=2, simplify_tol=1e-2):
+    """Process component polygons before processing.
+
+    Uses layermap (design layers) names.
+
+    Args:
+        component: gdsfactory component
+        layermap: LayerMap object or dict with layer names as keys
+        round_tol: tolerance for rounding coordinates
+        simplify_tol: tolerance for polygon simplification
+    """
+    layer_dict = vars(layermap) if not isinstance(layermap, dict) else layermap
+
+    return {
+        layer: fuse_polygons(
+            component,
+            layer,
+            round_tol=round_tol,
+            simplify_tol=simplify_tol,
+        )
+        for layername, layer in layer_dict.items()
+        if not layername.startswith("_")  # Skip private attributes
+    }
+
+
 def move_polar_rad_copy(
     pos: Coordinate, angle: float, length: float
 ) -> NDArray[np.float64]:

gplugins-2.0.1/gplugins/common/utils/geometry.py

@@ -0,0 +1,31 @@
+from typing import List
+import gdsfactory as gf
+import kfactory as kf
+from shapely.geometry import Polygon, MultiPolygon
+
+def region_to_shapely_polygons(region: kf.kdb.Region) -> MultiPolygon:
+    """Convert a kfactory Region to a list of Shapely polygons."""
+    polygons = []
+    for polygon_kdb in region.each():
+        exterior_coords = [
+            (gf.kcl.to_um(point.x), gf.kcl.to_um(point.y))
+            for point in polygon_kdb.each_point_hull()
+        ]
+        # Extract hole coordinates
+        holes = []
+        num_holes = polygon_kdb.holes()
+        for hole_idx in range(num_holes):
+            hole_coords = []
+            for point in polygon_kdb.each_point_hole(hole_idx):
+                hole_coords.append((gf.kcl.to_um(point.x), gf.kcl.to_um(point.y)))
+            holes.append(hole_coords)
+
+
+        # Create Shapely polygon
+        if holes:
+            polygon = Polygon(exterior_coords, holes)
+        else:
+            polygon = Polygon(exterior_coords)
+        polygons.append(polygon)
+
+    return MultiPolygon(polygons)

{gplugins-1.4.2 → gplugins-2.0.1}/gplugins/common/utils/get_capacitance.py

@@ -60,7 +60,7 @@ def get_capacitance(
             return run_capacitive_simulation_palace(
                 component,
                 simulation_folder=simulation_folder,
-                simulator_params=simulator_params,
+                solver_config=simulator_params,
                 **kwargs,
             )
         case _:

gplugins-2.0.1/gplugins/common/utils/get_component_with_net_layers.py

@@ -0,0 +1,178 @@
+import copy
+
+import gdsfactory as gf
+from gdsfactory.technology.layer_stack import DerivedLayer, LayerLevel
+from gdsfactory.typings import Port
+import klayout.db as kdb
+from gdsfactory import Component, LayerEnum
+from gdsfactory.technology import LayerStack, LogicalLayer
+
+
+def get_component_layer_stack(
+    component: Component,
+    layer_stack: LayerStack,
+) -> LayerStack:
+    """Returns a new layer_stack only with layers that appear in the provided component.
+
+    Arguments:
+        component: to process.
+        layer_stack: to process.
+
+    Returns:
+        new_layer_stack: without layers that do not appear in component.
+    """
+    new_layer_stack = layer_stack.model_copy()
+
+    layers_present = component.layers
+    layernames_dict = new_layer_stack.get_layer_to_layername()
+    layernames_present = [
+        name
+        for sublist in [
+            layernames_dict[LogicalLayer(layer=layer)] for layer in layers_present
+        ]
+        for name in sublist
+    ]
+    for key in list(new_layer_stack.layers.keys()):
+        if key not in layernames_present:
+            new_layer_stack.layers.pop(key)
+
+    return new_layer_stack
+
+
+def compare_layerlevel_and_port_layers(layer_level: LayerLevel, port: Port) -> bool:
+    """Compare the layer information between a :class:`~LayerLevel` and a :class:`~Port`.
+
+    Note:
+        If ``layer_level.layer`` is :class:`~LogicalLayer`, ``layer_level.layer`` is used.
+        If ``layer_level.layer`` is :class:`~DerivedLayer`, ``layer_level.derived_layer`` is used.
+
+    Args:
+        layer_level: The LayerLevel object containing layer information
+        port: The Port object containing layer_info with layer and datatype
+
+    Returns:
+        bool: True if the layer and datatype match between both objects
+    """
+
+    port_layer_tuple = (
+        port.layer_info.layer,
+        port.layer_info.datatype,
+    )
+
+    is_derived_layer = isinstance(layer_level.layer, DerivedLayer)
+    if is_derived_layer:
+        layer_level_tuple = (layer_level.derived_layer.layer.layer, layer_level.derived_layer.layer.datatype)
+        return layer_level_tuple == port_layer_tuple
+
+    layer_enum_or_tuple = layer_level.layer.layer
+    if isinstance(layer_enum_or_tuple, tuple):
+        layer_level_tuple = layer_enum_or_tuple
+    else:
+        layer_level_tuple = (
+            layer_enum_or_tuple.layer,
+            layer_enum_or_tuple.datatype,
+        )
+
+    return layer_level_tuple == port_layer_tuple
+
+
+def get_component_with_net_layers(
+    component: Component,
+    layer_stack: LayerStack,
+    port_names: list[str],
+    delimiter: str = "#",
+    new_layers_init: tuple[int, int] = (10010, 0),
+    add_to_layerstack: bool = True,
+) -> Component:
+    """Returns a component where polygons touching a port are put on new logical layers.
+
+    Uses port's layer attribute to decide which polygons need to be renamed.
+    New layers are named "layername{delimiter}portname".
+
+    Args:
+        component: to process.
+        layer_stack: to process.
+        port_names: list of port_names to process into new layers.
+        delimiter: the new layer created is called "layername{delimiter}portname".
+        new_layers_init: initial layer number for the temporary new layers.
+        add_to_layerstack: True by default, but can be set to False to disable parsing of the layerstack.
+    """
+
+    # Initialize returned component
+    net_component = component.copy()
+
+    new_layerlevels = []
+    # For each port to consider, convert relevant polygons
+    for i, port_name in enumerate(port_names):
+        port = component.ports[port_name]
+        # Get original port layer polygons, and modify a new component without that layer
+        polygons = (
+            net_component.extract(layers=(port.layer,))
+            .get_polygons()
+            .get(port.layer, [])
+        )
+        net_component = net_component.remove_layers(
+            layers=(port.layer,), recursive=False
+        )
+        for polygon in polygons:
+            # If polygon belongs to port, create a unique new layer, and add the polygon to it
+            if polygon.sized(int(3 * gf.kcl.dbu)).inside(
+                kdb.Point(*port.to_itype().center)
+            ):
+                try:
+                    derived_layerlevels_touching_port = [
+                        e
+                        for e in layer_stack.layers.values()
+                        if e.derived_layer is not None
+                        and e not in new_layerlevels
+                        and compare_layerlevel_and_port_layers(e, port)
+                    ]
+                    logical_layerlevels_touching_port = [
+                        e
+                        for e in layer_stack.layers.values()
+                        if not isinstance(
+                            e.layer, gf.technology.layer_stack.DerivedLayer
+                        )
+                        and e not in new_layerlevels
+                        and compare_layerlevel_and_port_layers(e, port)
+                    ]
+
+                    layerlevels_touching_port = (
+                        derived_layerlevels_touching_port
+                        + logical_layerlevels_touching_port
+                    )
+                except KeyError as e:
+                    raise KeyError(
+                        "Make sure your `layer_stack` contains all layers with ports"
+                    ) from e
+
+                for j, old_layerlevel in enumerate(layerlevels_touching_port):
+                    new_layer_number = (
+                        new_layers_init[0] + i,
+                        new_layers_init[1] + j,
+                    )
+                    if add_to_layerstack:
+                        # new_layer = copy.deepcopy(layer_stack.layers[old_layerlevel])
+                        new_layerlevel = copy.deepcopy(old_layerlevel)
+                        new_layerlevel.layer = LogicalLayer(
+                            layer=(
+                                new_layers_init[0] + i,
+                                new_layers_init[1] + j,
+                            )
+                        )
+                        new_layerlevel.name = (
+                            f"{old_layerlevel.name}{delimiter}{port_name}"
+                        )
+                        # Increase mesh order to ensure new layer is on top old
+                        new_layerlevel.mesh_order = old_layerlevel.mesh_order - 1
+                        layer_stack.layers[
+                            f"{old_layerlevel.name}{delimiter}{port_name}"
+                        ] = new_layerlevel
+                        new_layerlevels.append(new_layerlevel)
+                    net_component.add_polygon(polygon, layer=new_layer_number)
+            # Otherwise put the polygon back on the same layer
+            else:
+                net_component.add_polygon(polygon, layer=port.layer)
+
+    net_component.name = f"{component.name}_net_layers"
+    return net_component

{gplugins-1.4.2 → gplugins-2.0.1}/gplugins/devsim/get_simulation.py

@@ -20,11 +20,8 @@ from gdsfactory.technology import LayerLevel, LayerStack
 from scipy.interpolate import NearestNDInterpolator
 
 from gplugins.devsim.doping import get_doping_info_generic
-from gplugins.gmsh import (
-    fuse_polygons,
-    get_u_bounds_polygons,
-    uz_xsection_mesh,
-)
+from gplugins.common.base_models.component import fuse_polygons
+from gplugins.meshwell import get_u_bounds_polygons
 
 um_to_cm = 1e-4
 
@@ -65,18 +62,16 @@ def create_2Duz_simulation(
         simulation_layertack.layers[contact_name] = layerlevel
 
     # Get structural mesh
-    mesh = uz_xsection_mesh(
-        component,
-        xsection_bounds,
-        simulation_layertack,
-        resolutions=resolutions,
-        mesh_scaling_factor=mesh_scaling_factor,
-        default_resolution_min=default_resolution_min,
-        default_resolution_max=default_resolution_max,
-        background_tag=background_tag,
-        filename=temp_file_name,
-        global_meshsize_array=global_meshsize_array,
-        global_meshsize_interpolant_func=global_meshsize_interpolant_func,
+    # TODO: Update to use meshwell API
+    # The old uz_xsection_mesh has been removed. Replace with:
+    # 1. Convert xsection_bounds to LineString
+    # 2. Call get_meshwell_cross_section() to get surfaces
+    # 3. Use meshwell.cad.cad() to create CAD file
+    # 4. Use meshwell.mesh.mesh() to create mesh file with resolutions
+    raise NotImplementedError(
+        "uz_xsection_mesh has been removed. "
+        "This function needs to be updated to use the new meshwell API. "
+        "See gplugins/femwell/mode_solver.py:compute_component_slice_modes for an example."
     )
 
     # Get doping layer bounds

{gplugins-1.4.2 → gplugins-2.0.1}/gplugins/elmer/get_capacitance.py

@@ -23,7 +23,9 @@ from gplugins.common.utils.async_helpers import (
     execute_and_stream_output,
     run_async_with_event_loop,
 )
-from gplugins.gmsh import get_mesh
+from gplugins.meshwell.get_meshwell_3D import get_meshwell_prisms
+from meshwell.cad import cad
+from meshwell.mesh import mesh
 
 ELECTROSTATIC_SIF = "electrostatic.sif"
 ELECTROSTATIC_TEMPLATE = Path(__file__).parent / f"{ELECTROSTATIC_SIF}.j2"
@@ -220,12 +222,24 @@ def run_capacitive_simulation_elmer(
     if mesh_file:
         shutil.copyfile(str(mesh_file), str(simulation_folder / filename))
     else:
-        get_mesh(
+        prisms = get_meshwell_prisms(
             component=component,
-            type="3D",
-            filename=simulation_folder / filename,
             layer_stack=layer_stack,
-            **((mesh_parameters or {}) | {"layer_port_delimiter": port_delimiter}),
+        )
+        cad(
+            entities_list=prisms,
+            output_file=(
+                cad_output := (simulation_folder / filename).with_suffix(".xao")
+            ),
+            boundary_delimiter=(boundary_delimiter:="boundary"),
+            progress_bars=True,
+        )
+        mesh(
+            input_file=cad_output,
+            output_file=(simulation_folder / filename).with_suffix(".msh"),
+            boundary_delimiter=boundary_delimiter,
+            dim=3,
+            **(mesh_parameters or {}),
         )
 
     # `interruptible` works on gmsh versions >= 4.11.2
@@ -246,7 +260,7 @@ def run_capacitive_simulation_elmer(
     # Signals are converted to Elmer Boundary Conditions
     ground_layers = {
         next(k for k, v in layer_stack.layers.items() if v.layer == port.layer)
-        for port in component.get_ports()
+        for port in component.ports
     }  # ports allowed only on metal
     metal_surfaces = [
         e for e in mesh_surface_entities if any(ground in e for ground in ground_layers)