pyedb 0.19.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

pyedb/dotnet/edb_core/cell/connectable.py

@@ -0,0 +1,64 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.layout_obj import LayoutObj
+
+
+class Connectable(LayoutObj):
+    """Manages EDB functionalities for a connectable object."""
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def net(self):
+        """Net Object.
+
+        Returns
+        -------
+        :class:`pyedb.dotnet.edb_core.edb_data.nets_data.EDBNetsData`
+        """
+        from pyedb.dotnet.edb_core.edb_data.nets_data import EDBNetsData
+
+        return EDBNetsData(self._edb_object.GetNet(), self._pedb)
+
+    @net.setter
+    def net(self, value):
+        """Set net."""
+        net = self._pedb.nets[value]
+        self._edb_object.SetNet(net.net_object)
+
+    @property
+    def component(self):
+        """Component connected to this object.
+
+        Returns
+        -------
+        :class:`dotnet.edb_core.edb_data.nets_data.EDBComponent`
+        """
+        from pyedb.dotnet.edb_core.cell.hierarchy.component import EDBComponent
+
+        edb_comp = self._edb_object.GetComponent()
+        if edb_comp.IsNull():
+            return None
+        else:
+            return EDBComponent(self._pedb, edb_comp)

pyedb/dotnet/edb_core/cell/hierarchy/component.py

@@ -32,16 +32,14 @@ from pyedb.dotnet.edb_core.cell.hierarchy.s_parameter_model import SparamModel
 from pyedb.dotnet.edb_core.cell.hierarchy.spice_model import SpiceModel
 from pyedb.dotnet.edb_core.definition.package_def import PackageDef
 from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstackInstance
-from pyedb.generic.general_methods import is_ironpython
-
-if not is_ironpython:
-    try:
-        import numpy as np
-    except ImportError:
-        warnings.warn(
-            "The NumPy module is required to run some functionalities of EDB.\n"
-            "Install with \n\npip install numpy\n\nRequires CPython."
-        )
+
+try:
+    import numpy as np
+except ImportError:
+    warnings.warn(
+        "The NumPy module is required to run some functionalities of EDB.\n"
+        "Install with \n\npip install numpy\n\nRequires CPython."
+    )
 from pyedb.generic.general_methods import get_filename_without_extension
 
 
@@ -63,6 +61,10 @@ class EDBComponent(Group):
         self._layout_instance = None
         self._comp_instance = None
 
+    @property
+    def group_type(self):
+        return self._edb_object.ToString().split(".")[-1].lower()
+
     @property
     def layout_instance(self):
         """EDB layout instance object."""

pyedb/dotnet/edb_core/cell/hierarchy/hierarchy_obj.py

@@ -22,7 +22,7 @@
 
 import logging
 
-from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
+from pyedb.dotnet.edb_core.cell.connectable import Connectable
 
 
 class HierarchyObj(Connectable):

pyedb/dotnet/edb_core/cell/layout.py

@@ -23,18 +23,168 @@
 """
 This module contains these classes: `EdbLayout` and `Shape`.
 """
+from pyedb.dotnet.edb_core.cell.hierarchy.component import EDBComponent
 from pyedb.dotnet.edb_core.cell.primitive import Bondwire
-from pyedb.dotnet.edb_core.edb_data.nets_data import EDBNetsData
+from pyedb.dotnet.edb_core.cell.terminal.bundle_terminal import BundleTerminal
+from pyedb.dotnet.edb_core.cell.terminal.edge_terminal import EdgeTerminal
+from pyedb.dotnet.edb_core.cell.terminal.padstack_instance_terminal import (
+    PadstackInstanceTerminal,
+)
+from pyedb.dotnet.edb_core.cell.terminal.pingroup_terminal import PinGroupTerminal
+from pyedb.dotnet.edb_core.cell.terminal.point_terminal import PointTerminal
+from pyedb.dotnet.edb_core.cell.voltage_regulator import VoltageRegulator
+from pyedb.dotnet.edb_core.edb_data.nets_data import (
+    EDBDifferentialPairData,
+    EDBExtendedNetData,
+    EDBNetClassData,
+    EDBNetsData,
+)
 from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstackInstance
+from pyedb.dotnet.edb_core.edb_data.primitives_data import (
+    EdbCircle,
+    EdbPath,
+    EdbPolygon,
+    EdbRectangle,
+    EdbText,
+)
 from pyedb.dotnet.edb_core.edb_data.sources import PinGroup
 from pyedb.dotnet.edb_core.general import convert_py_list_to_net_list
-from pyedb.dotnet.edb_core.layout import EdbLayout
+from pyedb.dotnet.edb_core.utilities.obj_base import ObjBase
 
 
-class Layout(EdbLayout):
+class Layout(ObjBase):
     def __init__(self, pedb, edb_object):
-        super().__init__(pedb)
-        self._edb_object = edb_object
+        super().__init__(pedb, edb_object)
+
+    @property
+    def cell(self):
+        """:class:`Cell <ansys.edb.layout.Cell>`: Owning cell for this layout.
+
+        Read-Only.
+        """
+        return self._pedb._active_cell
+
+    @property
+    def layer_collection(self):
+        """:class:`LayerCollection <ansys.edb.layer.LayerCollection>` : Layer collection of this layout."""
+        return self._edb_object.GetLayerCollection()
+
+    @layer_collection.setter
+    def layer_collection(self, layer_collection):
+        """Set layer collection."""
+        self._edb_object.SetLayerCollection(layer_collection)
+
+    @property
+    def _edb(self):
+        return self._pedb.edb_api
+
+    def expanded_extent(self, nets, extent, expansion_factor, expansion_unitless, use_round_corner, num_increments):
+        """Get an expanded polygon for the Nets collection.
+
+        Parameters
+        ----------
+        nets : list[:class:`Net <ansys.edb.net.Net>`]
+            A list of nets.
+        extent : :class:`ExtentType <ansys.edb.geometry.ExtentType>`
+            Geometry extent type for expansion.
+        expansion_factor : float
+            Expansion factor for the polygon union. No expansion occurs if the `expansion_factor` is less than or \
+            equal to 0.
+        expansion_unitless : bool
+            When unitless, the distance by which the extent expands is the factor multiplied by the longer dimension\
+            (X or Y distance) of the expanded object/net.
+        use_round_corner : bool
+            Whether to use round or sharp corners.
+            For round corners, this returns a bounding box if its area is within 10% of the rounded expansion's area.
+        num_increments : int
+            Number of iterations desired to reach the full expansion.
+
+        Returns
+        -------
+        :class:`PolygonData <ansys.edb.geometry.PolygonData>`
+
+        Notes
+        -----
+        Method returns the expansion of the contour, so any voids within expanded objects are ignored.
+        """
+        return self._edb_object.GetExpandedExtentFromNets(
+            convert_py_list_to_net_list(nets),
+            extent,
+            expansion_factor,
+            expansion_unitless,
+            use_round_corner,
+            num_increments,
+        )
+
+    def convert_primitives_to_vias(self, primitives, is_pins=False):
+        """Convert a list of primitives into vias or pins.
+
+        Parameters
+        ----------
+        primitives : list[:class:`Primitive <ansys.edb.primitive.Primitive>`]
+            List of primitives to convert.
+        is_pins : bool, optional
+            True for pins, false for vias (default).
+        """
+        self._edb_object.ConvertPrimitivesToVias(convert_py_list_to_net_list(primitives), is_pins)
+
+    @property
+    def zone_primitives(self):
+        """:obj:`list` of :class:`Primitive <ansys.edb.primitive.Primitive>` : List of all the primitives in \
+        :term:`zones <Zone>`.
+
+        Read-Only.
+        """
+        return list(self._edb_object.GetZonePrimitives())
+
+    @property
+    def fixed_zone_primitive(self):
+        """:class:`Primitive <ansys.edb.primitive.Primitive>` : Fixed :term:`zones <Zone>` primitive."""
+        return list(self._edb_object.GetFixedZonePrimitive())
+
+    @fixed_zone_primitive.setter
+    def fixed_zone_primitive(self, value):
+        self._edb_object.SetFixedZonePrimitives(value)
+
+    @property
+    def terminals(self):
+        """Get terminals belonging to active layout.
+
+        Returns
+        -------
+        Terminal dictionary : Dict[str, pyedb.dotnet.edb_core.edb_data.terminals.Terminal]
+        """
+        temp = []
+        for i in list(self._edb_object.Terminals):
+            terminal_type = i.ToString().split(".")[-1]
+            if terminal_type == "PinGroupTerminal":
+                temp.append(PinGroupTerminal(self._pedb, i))
+            elif terminal_type == "PadstackInstanceTerminal":
+                temp.append(PadstackInstanceTerminal(self._pedb, i))
+            elif terminal_type == "EdgeTerminal":
+                temp.append(EdgeTerminal(self._pedb, i))
+            elif terminal_type == "BundleTerminal":
+                temp.append(BundleTerminal(self._pedb, i))
+            elif terminal_type == "PointTerminal":
+                temp.append(PointTerminal(self._pedb, i))
+        return temp
+
+    @property
+    def cell_instances(self):
+        """:obj:`list` of :class:`CellInstance <ansys.edb.hierarchy.CellInstances>` : List of the cell instances in \
+                this layout.
+
+                Read-Only.
+                """
+        return list(self._edb_object.CellInstances)
+
+    @property
+    def layout_instance(self):
+        """:class:`LayoutInstance <ansys.edb.layout_instance.LayoutInstance>` : Layout instance of this layout.
+
+        Read-Only.
+        """
+        return self._edb_object.GetLayoutInstance()
 
     @property
     def nets(self):
@@ -42,15 +192,41 @@ class Layout(EdbLayout):
 
         Returns
         -------
-        dict[str, :class:`pyedb.dotnet.edb_core.edb_data.nets_data.EDBNetsData`]
-            Dictionary of nets.
         """
 
-        temp = {}
-        for net in self._edb_object.Nets:
-            n = EDBNetsData(net, self._pedb)
-            temp[n.name] = n
-        return temp
+        return [EDBNetsData(net, self._pedb) for net in self._edb_object.Nets]
+
+    @property
+    def primitives(self):
+        """List of primitives.Read-Only.
+
+        Returns
+        -------
+        list of :class:`dotnet.edb_core.dotnet.primitive.PrimitiveDotNet` cast objects.
+        """
+        prims = []
+        for p in self._edb_object.Primitives:
+            if p.GetPrimitiveType().ToString() == "Rectangle":
+                prims.append(EdbRectangle(p, self._pedb))
+            elif p.GetPrimitiveType().ToString() == "Circle":
+                prims.append(EdbCircle(p, self._pedb))
+            elif p.GetPrimitiveType().ToString() == "Polygon":
+                prims.append(EdbPolygon(p, self._pedb))
+            elif p.GetPrimitiveType().ToString() == "Path":
+                prims.append(EdbPath(p, self._pedb))
+            elif p.GetPrimitiveType().ToString() == "Bondwire":
+                prims.append(Bondwire(self._pedb, p))
+            elif p.GetPrimitiveType().ToString() == "Text":
+                prims.append(EdbText(p, self._pedb))
+            elif p.GetPrimitiveType().ToString() == "PrimitivePlugin":
+                pass
+            elif p.GetPrimitiveType().ToString() == "Path3D":
+                pass
+            elif p.GetPrimitiveType().ToString() == "BoardBendDef":
+                pass
+            else:
+                pass
+        return prims
 
     @property
     def bondwires(self):
@@ -61,118 +237,90 @@ class Layout(EdbLayout):
         list :
             List of bondwires.
         """
-        return [
-            Bondwire(self._pedb, i)
-            for i in self._edb_object.Primitives
-            if i.GetPrimitiveType().ToString() == "Bondwire"
-        ]
+        return [i for i in self.primitives if i.primitive_type == "bondwire"]
+
+    @property
+    def groups(self):
+        temp = []
+        for i in list(self._edb_object.Groups):
+            group_type = i.ToString().split(".")[-1].lower()
+            if group_type == "component":
+                temp.append(EDBComponent(self._pedb, i))
+            else:
+                pass
+        return temp
+
+    @property
+    def pin_groups(self):
+        return [PinGroup(pedb=self._pedb, edb_pin_group=i, name=i.GetName()) for i in self._edb_object.PinGroups]
+
+    @property
+    def net_classes(self):
+        return [EDBNetClassData(self._pedb, i) for i in list(self._edb_object.NetClasses)]
+
+    @property
+    def extended_nets(self):
+        return [EDBExtendedNetData(self._pedb, i) for i in self._edb_object.ExtendedNets]
+
+    @property
+    def differential_pairs(self):
+        return [EDBDifferentialPairData(self._pedb, i) for i in list(self._edb_object.DifferentialPairs)]
 
     @property
     def padstack_instances(self):
         """Get all padstack instances in a list."""
         return [EDBPadstackInstance(i, self._pedb) for i in self._edb_object.PadstackInstances]
 
-    def create_bondwire(
-        self,
-        definition_name,
-        placement_layer,
-        width,
-        material,
-        start_layer_name,
-        start_x,
-        start_y,
-        end_layer_name,
-        end_x,
-        end_y,
-        net,
-        bondwire_type="jedec4",
-    ):
-        """Create a bondwire object.
+    @property
+    def voltage_regulators(self):
+        return [VoltageRegulator(self._pedb, i) for i in list(self._edb_object.VoltageRegulators)]
 
-        Parameters
-        ----------
-        bondwire_type : :class:`BondwireType`
-            Type of bondwire: kAPDBondWire or kJDECBondWire types.
-        definition_name : str
-            Bondwire definition name.
-        placement_layer : str
-            Layer name this bondwire will be on.
-        width : :class:`Value <ansys.edb.utility.Value>`
-            Bondwire width.
-        material : str
-            Bondwire material name.
-        start_layer_name : str
-            Name of start layer.
-        start_x : :class:`Value <ansys.edb.utility.Value>`
-            X value of start point.
-        start_y : :class:`Value <ansys.edb.utility.Value>`
-            Y value of start point.
-        end_layer_name : str
-            Name of end layer.
-        end_x : :class:`Value <ansys.edb.utility.Value>`
-            X value of end point.
-        end_y : :class:`Value <ansys.edb.utility.Value>`
-            Y value of end point.
-        net : str or :class:`Net <ansys.edb.net.Net>` or None
-            Net of the Bondwire.
+    @property
+    def port_reference_terminals_connected(self):
+        """:obj:`bool`: Determine if port reference terminals are connected, applies to lumped ports and circuit ports.
 
-        Returns
-        -------
-        :class:`pyedb.dotnet.edb_core.dotnet.primitive.BondwireDotNet`
-            Bondwire object created.
+        True if they are connected, False otherwise.
+        Read-Only.
         """
-        return Bondwire(
-            pedb=self._pedb,
-            bondwire_type=bondwire_type,
-            definition_name=definition_name,
-            placement_layer=placement_layer,
-            width=self._pedb.edb_value(width),
-            material=material,
-            start_layer_name=start_layer_name,
-            start_x=self._pedb.edb_value(start_x),
-            start_y=self._pedb.edb_value(start_y),
-            end_layer_name=end_layer_name,
-            end_x=self._pedb.edb_value(end_x),
-            end_y=self._pedb.edb_value(end_y),
-            net=self.nets[net]._edb_object,
-        )
+        return self._edb_object.ArePortReferenceTerminalsConnected()
 
     def find_object_by_id(self, value: int):
-        """Find a Connectable object by Database ID.
+        """Find a layout object by Database ID.
 
         Parameters
         ----------
         value : int
+            ID of the object.
         """
         obj = self._pedb._edb.Cell.Connectable.FindById(self._edb_object, value)
         if obj.GetObjType().ToString() == "PadstackInstance":
-            return EDBPadstackInstance(obj, self._pedb)
+            return EDBPadstackInstance(obj, self._pedb) if obj is not None else None
+
+    def find_net_by_name(self, value: str):
+        """Find a net object by name
+
+        Parameters
+        ----------
+        value : str
+            Name of the net.
+
+        Returns
+        -------
+
+        """
+        obj = self._pedb._edb.Cell.Net.FindByName(self._edb_object, value)
+        return EDBNetsData(obj, self._pedb) if obj is not None else None
 
-    def create_pin_group(self, name: str, pins_by_id: list[int] = None, pins_by_aedt_name: list[str] = None):
-        """Create a PinGroup.
+    def find_component_by_name(self, value: str):
+        """Find a component object by name. Component name is the reference designator in layout.
 
         Parameters
-        name : str,
-            Name of the PinGroup.
-        pins_by_id : list[int] or None
-            List of pins by ID.
-        pins_by_aedt_name : list[str] or None
-            List of pins by AEDT name.
+        ----------
+        value : str
+            Name of the component.
+        Returns
+        -------
+
         """
-        pins = []
-
-        if pins_by_id is not None:
-            for p in pins_by_id:
-                pins.append(self.find_object_by_id(p._edb_object))
-        else:
-            p_inst = self.padstack_instances
-            while True:
-                p = p_inst.pop(0)
-                if p.aedt_name in pins_by_aedt_name:
-                    pins.append(p._edb_object)
-                    pins_by_aedt_name.remove(p.aedt_name)
-                if len(pins_by_aedt_name) == 0:
-                    break
-
-        obj = self._edb.cell.hierarchy.pin_group.Create(self._edb_object, name, convert_py_list_to_net_list(pins))
-        return PinGroup(name, obj, self._pedb)
+        obj = self._pedb._edb.Cell.Hierarchy.Component.FindByName(self._edb_object, value)
+        return EDBComponent(self._pedb, obj) if obj is not None else None

pyedb/dotnet/edb_core/cell/layout_obj.py

@@ -20,17 +20,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from pyedb.dotnet.edb_core.layout_obj_instance import LayoutObjInstance
 from pyedb.dotnet.edb_core.utilities.obj_base import ObjBase
 
 
-class LayoutObjInstance:
-    """Manages EDB functionalities for the layout object instance."""
-
-    def __init__(self, pedb, edb_object):
-        self._pedb = pedb
-        self._edb_object = edb_object
-
-
 class LayoutObj(ObjBase):
     """Manages EDB functionalities for the layout object."""
 
@@ -89,45 +82,7 @@ class LayoutObj(ObjBase):
     def delete(self):
         """Delete this primitive."""
         self._edb_object.Delete()
+        self._pedb.modeler._primitives = []
+        self._pedb.padstacks._instances = {}
+        self._pedb.padstacks._definitions = {}
         return True
-
-
-class Connectable(LayoutObj):
-    """Manages EDB functionalities for a connectable object."""
-
-    def __init__(self, pedb, edb_object):
-        super().__init__(pedb, edb_object)
-
-    @property
-    def net(self):
-        """Net Object.
-
-        Returns
-        -------
-        :class:`pyedb.dotnet.edb_core.edb_data.nets_data.EDBNetsData`
-        """
-        from pyedb.dotnet.edb_core.edb_data.nets_data import EDBNetsData
-
-        return EDBNetsData(self._edb_object.GetNet(), self._pedb)
-
-    @net.setter
-    def net(self, value):
-        """Set net."""
-        net = self._pedb.nets[value]
-        self._edb_object.SetNet(net.net_object)
-
-    @property
-    def component(self):
-        """Component connected to this object.
-
-        Returns
-        -------
-        :class:`dotnet.edb_core.edb_data.nets_data.EDBComponent`
-        """
-        from pyedb.dotnet.edb_core.cell.hierarchy.component import EDBComponent
-
-        edb_comp = self._edb_object.GetComponent()
-        if edb_comp.IsNull():
-            return None
-        else:
-            return EDBComponent(self._pedb, edb_comp)

pyedb/dotnet/edb_core/cell/primitive.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
+from pyedb.dotnet.edb_core.cell.connectable import Connectable
 
 
 class Primitive(Connectable):
@@ -73,6 +73,18 @@ class Primitive(Connectable):
         except AttributeError:  # pragma: no cover
             return ""
 
+    @property
+    def primitive_type(self):
+        """Return the type of the primitive.
+
+        Expected output is among ``"circle"``, ``"rectangle"``,``"polygon"``,``"path"`` or ``"bondwire"``.
+
+        Returns
+        -------
+        str
+        """
+        return self._edb_object.GetPrimitiveType().ToString().lower()
+
     @property
     def net_name(self):
         """Get the primitive net name.
@@ -166,7 +178,7 @@ class Bondwire(Primitive):
 
     def __create(self, **kwargs):
         return self._pedb._edb.Cell.Primitive.Bondwire.Create(
-            self._pedb.modeler._edb_object,
+            self._pedb.layout._edb_object,
             kwargs.get("net"),
             self._bondwire_type[kwargs.get("bondwire_type")],
             kwargs.get("definition_name"),

pyedb/dotnet/edb_core/cell/terminal/padstack_instance_terminal.py

@@ -95,4 +95,4 @@ class PadstackInstanceTerminal(Terminal):
     @property
     def padstack_instance(self):
         p_inst, _ = self._get_parameters()
-        return self._pedb.modeler.find_object_by_id(p_inst.GetId())
+        return self._pedb.layout.find_object_by_id(p_inst.GetId())

pyedb/dotnet/edb_core/cell/terminal/point_terminal.py

@@ -52,7 +52,7 @@ class PointTerminal(Terminal):
         """
         terminal = self._pedb.edb_api.cell.terminal.PointTerminal.Create(
             self._pedb.active_layout,
-            self._pedb.nets[net].net_object,
+            self._pedb.layout.find_net_by_name(net)._edb_object,
             name,
             self._pedb.point_data(*location),
             self._pedb.stackup[layer]._edb_layer,

pyedb/dotnet/edb_core/cell/terminal/terminal.py

@@ -22,7 +22,7 @@
 
 import re
 
-from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
+from pyedb.dotnet.edb_core.cell.connectable import Connectable
 from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstackInstance
 from pyedb.dotnet.edb_core.edb_data.primitives_data import cast
 
@@ -159,24 +159,6 @@ class Terminal(Connectable):
         ppp.DoRenormalize = value
         self._port_post_processing_prop = ppp
 
-    @property
-    def name(self):
-        """Port Name.
-
-        Returns
-        -------
-        str
-        """
-        return self._edb_object.GetName()
-
-    @name.setter
-    def name(self, value):
-        if isinstance(value, str):
-            if not any(port for port in list(self._pedb.excitations.keys()) if port == value):
-                self._edb_object.SetName(value)
-            else:
-                self._pedb.logger.warning("An existing port already has this same name. A port name must be unique.")
-
     @property
     def net_name(self):
         """Net name.