pyedb 0.50.1__py3-none-any.whl → 0.51.2__py3-none-any.whl

pyedb/grpc/database/hierarchy/component.py

@@ -132,7 +132,7 @@ class Component(GrpcComponentGroup):
         self.enabled = value
 
     @property
-    def ic_die_properties(self) -> ICDieProperty:
+    def ic_die_properties(self) -> any:
         """IC Die property.
 
         returns
@@ -877,12 +877,20 @@ class Component(GrpcComponentGroup):
     def numpins(self) -> int:
         """Number of Pins of Component.
 
+        ..deprecated:: 0.51.0
+           Use: func:`num_pins` instead.
         Returns
         -------
         int
             Component pins number.
         """
-        return self.num_pins
+
+        warnings.warn("Use num_pins instead.", DeprecationWarning)
+        try:
+            return self.num_pins
+        except Exception as e:
+            self._pedb.logger.error(f"{e}")
+            return 0
 
     @property
     def partname(self) -> str:

pyedb/grpc/database/layout_validation.py

@@ -55,10 +55,12 @@ class LayoutValidation:
 
         Examples
         --------
-
         >>> edb = Edb("edb_file")
-        >>> dc_shorts = edb.layout_validation.dc_shorts()
-
+        >>> # Find shorts without fixing
+        >>> shorts = edb.layout_validation.dc_shorts()
+        >>>
+        >>> # Find and fix shorts on specific nets
+        >>> fixed_shorts = edb.layout_validation.dc_shorts(net_list=["GND", "VCC"], fix=True)
         """
         if not net_list:
             net_list = list(self._pedb.nets.nets.keys())
@@ -154,8 +156,17 @@ class LayoutValidation:
 
         Examples
         --------
-
-        >>> renamed_nets = edb.layout_validation.disjoint_nets(["GND","Net2"])
+        >>> edb = Edb("edb_file")
+        >>> # Find disjoint nets on all nets
+        >>> new_nets = edb.layout_validation.disjoint_nets()
+        >>>
+        >>> # Clean disjoints on specific nets with advanced options
+        >>> cleaned = edb.layout_validation.disjoint_nets(
+        ...     net_list=["GND"],
+        ...     keep_only_main_net=True,
+        ...     clean_disjoints_less_than=1e-6,
+        ...     order_by_area=True
+        ... ))
         """
         timer_start = self._pedb.logger.reset_timer()
 
@@ -274,6 +285,15 @@ class LayoutValidation:
         Returns
         -------
         bool
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Fix self-intersections on all nets
+        >>> edb.layout_validation.fix_self_intersections()
+        >>>
+        >>> # Fix self-intersections on specific nets
+        >>> edb.layout_validation.fix_self_intersections(net_list=["RF_line"])
         """
         if not net_list:
             net_list = list(self._pedb.nets.nets.keys())
@@ -290,7 +310,17 @@ class LayoutValidation:
         return True
 
     def illegal_net_names(self, fix=False):
-        """Find and fix illegal net names."""
+        """Find and fix illegal net names.
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Identify illegal net names
+        >>> edb.layout_validation.illegal_net_names()
+        >>>
+        >>> # Find and automatically fix illegal names
+        >>> edb.layout_validation.illegal_net_names(fix=True)
+        """
         pattern = r"[\(\)\\\/:;*?<>\'\"|`~$]"
 
         nets = self._pedb.nets.nets
@@ -307,7 +337,17 @@ class LayoutValidation:
         return
 
     def illegal_rlc_values(self, fix=False) -> list[str]:
-        """Find and fix RLC illegal values."""
+        """Find and fix RLC illegal values.
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Identify components with illegal RLC values
+        >>> bad_components = edb.layout_validation.illegal_rlc_values()
+        >>>
+        >>> # Automatically fix invalid inductor values
+        >>> edb.layout_validation.illegal_rlc_values(fix=True)
+        """
         inductors = self._pedb.components.inductors
 
         temp = []
@@ -321,6 +361,17 @@ class LayoutValidation:
         return temp
 
     def padstacks_no_name(self, fix=False):
+        """Identify and fix padstacks without names.
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Report unnamed padstacks
+        >>> edb.layout_validation.padstacks_no_name()
+        >>>
+        >>> # Automatically assign names to unnamed padstacks
+        >>> edb.layout_validation.padstacks_no_name(fix=True)
+        """
         pds = self._pedb.layout.padstack_instances
         counts = 0
         via_count = 1

pyedb/grpc/database/nets.py

@@ -36,11 +36,120 @@ from pyedb.misc.utilities import compute_arc_points
 class Nets(CommonNets):
     """Manages EDB methods for nets management accessible from `Edb.nets` property.
 
-    Examples
-    --------
+        Examples
+        --------
     >>> from pyedb import Edb
-    >>> edbapp = Edb("myaedbfolder", edbversion="2021.2")
-    >>> edb_nets = edbapp.nets
+
+    >>> # Initialize EDB session
+    >>> edbapp = Edb(edbversion="2025.2")
+
+    >>> # Access Nets class
+    >>> nets = edbapp.nets
+
+    >>> # =================
+    >>> # Property examples
+    >>> # =================
+
+    >>> # Get all nets dictionary
+    >>> all_nets = nets.nets
+    >>> print("All nets:", list(all_nets.keys()))
+
+    >>> # Get net names list
+    >>> net_names = nets.netlist
+    >>> print("Net names:", net_names)
+
+    >>> # Get signal nets
+    >>> signal_nets = nets.signal
+    >>> print("Signal nets:", list(signal_nets.keys()))
+
+    >>> # Get power/ground nets
+    >>> power_nets = nets.power
+    >>> print("Power nets:", list(power_nets.keys()))
+
+    >>> # Get nets by components
+    >>> nets_by_comps = nets.nets_by_components
+    >>> print("Nets by components:", nets_by_comps)
+
+    >>> # Get components by nets
+    >>> comps_by_nets = nets.components_by_nets
+    >>> print("Components by nets:", comps_by_nets)
+
+    >>> # ===============
+    >>> # Method examples
+    >>> # ===============
+
+    >>> # Get net by name
+    >>> net_obj = nets["GND"]
+    >>> print(f"Net object: {net_obj.name}")
+
+    >>> # Check net existence
+    >>> if "PCIe_RX" in nets:
+    >>>    print("PCIe_RX exists")
+
+    >>> # Identify eligible power nets
+    >>> eligible_pwr = nets.eligible_power_nets(threshold=0.25)
+    >>> print("Eligible power nets:", [net.name for net in eligible_pwr])
+
+    >>> # Generate extended nets (deprecated)
+    >>> nets.generate_extended_nets(
+    >>> resistor_below=5,
+    >>>inductor_below=0.5,
+    >>> capacitor_above=0.1
+    >>> )
+
+    >>> # Classify nets
+    >>> nets.classify_nets(
+    >>> power_nets=["VDD_CPU", "VDD_MEM"],
+    >>> signal_nets=["PCIe_TX", "ETH_RX"]
+    >>> )
+
+    >>> # Check power/ground status
+    >>> is_power = nets.is_power_gound_net(["VDD_CPU", "PCIe_TX"])
+    >>> print("Is power net:", is_power)
+
+    >>> # Get DC-connected nets
+    >>> dc_connected = nets.get_dcconnected_net_list(
+    >>> ground_nets=["GND"],
+    >>> res_value=0.002
+    >>> )
+        print("DC-connected nets:", dc_connected)
+
+    >>> # Get power tree
+    >>> comp_list, columns, net_group = nets.get_powertree(
+    >>> power_net_name="VDD_CPU",
+    >>> ground_nets=["GND"]
+    >>> )
+    >>> print("Power tree components:", comp_list)
+
+    >>> # Find net by name
+    >>> found_net = nets.get_net_by_name("PCIe_TX")
+    >>> print(f"Found net: {found_net.name}")
+
+    >>> # Delete nets
+    >>> deleted = nets.delete(["Unused_Net", "Test_Net"])
+    >>> print("Deleted nets:", deleted)
+
+    >>> # Find or create net
+    >>> new_net = nets.find_or_create_net(net_name="New_Net")
+    >>> print(f"Created net: {new_net.name}")
+
+    >>> # Check net-component association
+    >>> in_component = nets.is_net_in_component("U1", "VDD_CPU")
+    >>> print("Net in component:", in_component)
+
+    >>> # Find and fix disjoint nets (deprecated)
+    >>> fixed_nets = nets.find_and_fix_disjoint_nets(
+    >>> net_list=["PCIe_TX"],
+    >>> clean_disjoints_less_than=1e-6
+    >>> )
+    >>> print("Fixed nets:", fixed_nets)
+
+    >>> # Merge net polygons
+    >>> merged = nets.merge_nets_polygons(["VDD_CPU", "VDD_MEM"])
+    >>> print("Polygons merged:", merged)
+
+        # Close EDB session
+    >>> edbapp.close()
     """
 
     def __getitem__(self, name):
@@ -55,6 +164,11 @@ class Nets(CommonNets):
         -------
         pyedb.grpc.database.net.net.Net
             Net object if found, otherwise None.
+
+        Examples
+        --------
+        >>> gnd_net = edb_nets["GND"]
+        >>> print(gnd_net.name)
         """
         return Net(self._pedb, Net.find_by_name(self._active_layout, name))
 
@@ -70,6 +184,11 @@ class Nets(CommonNets):
         -------
         bool
             True if the net exists, False otherwise.
+
+        Examples
+        --------
+        >>> if "PCIe_RX" in edb_nets:
+        >>>     print("Net exists")
         """
         return name in self.nets
 
@@ -117,6 +236,12 @@ class Nets(CommonNets):
         -------
         dict[str, pyedb.grpc.database.net.net.Net]
             Dictionary of net names to Net objects.
+
+         Examples
+        --------
+        >>> all_nets = edb_nets.nets
+        >>> for net_name, net_obj in all_nets.items():
+        ...     print(net_name, net_obj.is_power_ground)
         """
         return {i.name: i for i in self._pedb.layout.nets}
 
@@ -128,6 +253,11 @@ class Nets(CommonNets):
         -------
         list[str]
             Names of all nets in the layout.
+
+        Examples
+        --------
+        >>> net_names = edb_nets.netlist
+        >>> print("Total nets:", len(net_names))
         """
         return list(self.nets.keys())
 
@@ -139,6 +269,11 @@ class Nets(CommonNets):
         -------
         dict[str, pyedb.grpc.database.net.net.Net]
             Dictionary of signal net names to Net objects.
+
+        Examples
+        --------
+        >>> signal_nets = edb_nets.signal
+        >>> print("Signal nets:", list(signal_nets.keys()))
         """
         nets = {}
         for net, value in self.nets.items():
@@ -154,6 +289,11 @@ class Nets(CommonNets):
         -------
         dict[str, pyedb.grpc.database.net.net.Net]
             Dictionary of power/ground net names to Net objects.
+
+        Examples
+        --------
+        >>> power_nets = edb_nets.power
+        >>> print("Power nets:", list(power_nets.keys()))
         """
         nets = {}
         for net, value in self.nets.items():
@@ -176,6 +316,11 @@ class Nets(CommonNets):
         -------
         list[pyedb.grpc.database.net.net.Net]
             List of nets eligible as power/ground nets.
+
+        Examples
+        --------
+        >>> eligible_pwr = edb_nets.eligible_power_nets(threshold=0.25)
+        >>> print([net.name for net in eligible_pwr])
         """
         pwr_gnd_nets = []
         for net in self._layout.nets[:]:
@@ -205,6 +350,11 @@ class Nets(CommonNets):
         -------
         dict[str, list[str]]
             Dictionary mapping component names to list of net names.
+
+        Examples
+        --------
+        >>> nets_by_comps = edb_nets.nets_by_components
+        >>> print("U1 nets:", nets_by_comps.get("U1", []))
         """
         for comp, i in self._pedb.components.instances.items():
             self._nets_by_comp_dict[comp] = i.nets
@@ -218,6 +368,11 @@ class Nets(CommonNets):
         -------
         dict[str, list[str]]
             Dictionary mapping net names to list of component names.
+
+        Examples
+        --------
+        >>> comps_by_nets = edb_nets.components_by_nets
+        >>> print("Components on GND:", comps_by_nets.get("GND", []))
         """
         for comp, i in self._pedb.components.instances.items():
             for n in i.nets:
@@ -260,6 +415,14 @@ class Nets(CommonNets):
         -------
         list
             List of generated extended nets.
+
+        Examples
+        --------
+        >>> edb_nets.generate_extended_nets(
+        ...     resistor_below=5,
+        ...     inductor_below=0.5,
+        ...     capacitor_above=0.1
+        ... )
         """
         warnings.warn("Use new method :func:`edb.extended_nets.generate_extended_nets` instead.", DeprecationWarning)
         self._pedb.extended_nets.generate_extended_nets(
@@ -315,6 +478,13 @@ class Nets(CommonNets):
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        >>> edb_nets.classify_nets(
+        ...     power_nets=["VDD_CPU", "VDD_MEM"],
+        ...     signal_nets=["PCIe_TX", "ETH_RX"]
+        ... )
         """
         if isinstance(power_nets, str):
             power_nets = []
@@ -344,6 +514,11 @@ class Nets(CommonNets):
         -------
         bool
             True if any net is power/ground, False otherwise.
+
+        Examples
+        --------
+        >>> is_power = edb_nets.is_power_gound_net(["VDD_CPU", "PCIe_TX"])
+        >>> print("Contains power net:", is_power)
         """
         if isinstance(netname_list, str):
             netname_list = [netname_list]
@@ -367,6 +542,15 @@ class Nets(CommonNets):
         -------
         list[set]
             List of sets of connected nets.
+
+        Examples
+        --------
+        >>> dc_connected = edb_nets.get_dcconnected_net_list(
+        ...     ground_nets=["GND"],
+        ...     res_value=0.002
+        ... )
+        >>> for net_group in dc_connected:
+        ...     print("Connected nets:", net_group)
         """
         temp_list = []
         for _, comp_obj in self._pedb.components.inductors.items():
@@ -416,6 +600,14 @@ class Nets(CommonNets):
         -------
         tuple
             (component_list, component_list_columns, net_group)
+
+        Examples
+        --------
+        >>> comp_list, columns, net_group = edb_nets.get_powertree(
+        ...     power_net_name="VDD_CPU",
+        ...     ground_nets=["GND"]
+        ... )
+        >>> print("Power tree components:", comp_list)
         """
         flag_in_ng = False
         net_group = []
@@ -474,6 +666,12 @@ class Nets(CommonNets):
         -------
         pyedb.grpc.database.net.net.Net
             Net object if found, otherwise None.
+
+        Examples
+        --------
+        >>> found_net = edb_nets.get_net_by_name("PCIe_TX")
+        >>> if found_net:
+        ...     print("Net found:", found_net.name)
         """
         edb_net = Net.find_by_name(self._active_layout, net_name)
         if edb_net is not None:
@@ -528,6 +726,20 @@ class Nets(CommonNets):
         -------
         pyedb.grpc.database.net.net.Net | list[pyedb.grpc.database.net.net.Net]
             Net object or list of matching net objects.
+
+        Examples
+        --------
+        >>> # Create new net
+        >>> new_net = edb_nets.find_or_create_net(net_name="New_Net")
+        >>>
+        >>> # Find existing net
+        >>> existing_net = edb_nets.find_or_create_net(net_name="GND")
+        >>>
+        >>> # Find nets starting with "VDD"
+        >>> vdd_nets = edb_nets.find_or_create_net(start_with="VDD")
+        >>>
+        >>> # Find nets ending with "_P"
+        >>> pos_nets = edb_nets.find_or_create_net(end_with="_P")
         """
         if not net_name and not start_with and not contain and not end_with:
             net_name = generate_unique_name("NET_")
@@ -591,6 +803,11 @@ class Nets(CommonNets):
         -------
         bool
             True if the net is found in the component, False otherwise.
+
+        Examples
+        --------
+        >>> in_component = edb_nets.is_net_in_component("U1", "VDD_CPU")
+        >>> print("Net in component:", in_component)
         """
         if component_name not in self._pedb.components.instances:
             return False
@@ -625,6 +842,13 @@ class Nets(CommonNets):
 
             New nets created.
 
+        Examples
+        --------
+        >>> fixed_nets = edb_nets.find_and_fix_disjoint_nets(
+        ...     net_list=["PCIe_TX"],
+        ...     clean_disjoints_less_than=1e-6
+        ... )
+        >>> print("Fixed nets:", fixed_nets)
         """
 
         warnings.warn("Use new function :func:`edb.layout_validation.disjoint_nets` instead.", DeprecationWarning)
@@ -644,6 +868,11 @@ class Nets(CommonNets):
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        >>> merged = edb_nets.merge_nets_polygons(["VDD_CPU", "VDD_MEM"])
+        >>> print("Merge successful:", merged)
         """
         if isinstance(net_names_list, str):
             net_names_list = [net_names_list]