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

pyedb/grpc/database/layers/stackup_layer.py

@@ -48,7 +48,7 @@ class StackupLayer(GrpcStackupLayer):
         }
 
     @property
-    def type(self):
+    def type(self) -> str:
         """Layer type.
 
         Returns
@@ -139,7 +139,7 @@ class StackupLayer(GrpcStackupLayer):
             )
 
     @property
-    def lower_elevation(self):
+    def lower_elevation(self) -> float:
         """Lower elevation.
 
         Returns
@@ -155,7 +155,7 @@ class StackupLayer(GrpcStackupLayer):
             super(StackupLayer, self.__class__).lower_elevation.__set__(self, GrpcValue(value))
 
     @property
-    def fill_material(self):
+    def fill_material(self) -> str:
         """The layer's fill material.
 
         Returns
@@ -172,7 +172,7 @@ class StackupLayer(GrpcStackupLayer):
             self.set_fill_material(value)
 
     @property
-    def upper_elevation(self):
+    def upper_elevation(self) -> float:
         """Upper elevation.
 
         Returns
@@ -183,7 +183,7 @@ class StackupLayer(GrpcStackupLayer):
         return round(super().upper_elevation.value, 9)
 
     @property
-    def is_negative(self):
+    def is_negative(self) -> bool:
         """Determine whether this layer is a negative layer.
 
         Returns
@@ -205,7 +205,7 @@ class StackupLayer(GrpcStackupLayer):
         self.negative = value
 
     @property
-    def is_stackup_layer(self):
+    def is_stackup_layer(self) -> bool:
         """Testing if layer is stackup layer.
 
         Returns
@@ -217,7 +217,7 @@ class StackupLayer(GrpcStackupLayer):
         return False
 
     @property
-    def material(self):
+    def material(self) -> str:
         """Material.
 
         Returns
@@ -232,7 +232,7 @@ class StackupLayer(GrpcStackupLayer):
         self.set_material(name)
 
     @property
-    def conductivity(self):
+    def conductivity(self) -> float:
         """Material conductivity.
 
         Returns
@@ -246,7 +246,7 @@ class StackupLayer(GrpcStackupLayer):
         return None
 
     @property
-    def permittivity(self):
+    def permittivity(self) -> float:
         """Material permittivity.
 
         Returns
@@ -260,7 +260,7 @@ class StackupLayer(GrpcStackupLayer):
         return None
 
     @property
-    def loss_tangent(self):
+    def loss_tangent(self) -> float:
         """Material loss_tangent.
 
         Returns
@@ -274,7 +274,7 @@ class StackupLayer(GrpcStackupLayer):
         return None
 
     @property
-    def dielectric_fill(self):
+    def dielectric_fill(self) -> str:
         """Material name of the layer dielectric fill.
 
         Returns
@@ -295,7 +295,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def thickness(self):
+    def thickness(self) -> float:
         """Layer thickness.
 
         Returns
@@ -310,7 +310,7 @@ class StackupLayer(GrpcStackupLayer):
         super(StackupLayer, self.__class__).thickness.__set__(self, GrpcValue(value))
 
     @property
-    def etch_factor(self):
+    def etch_factor(self) -> float:
         """Layer etching factor.
 
         Returns
@@ -329,7 +329,7 @@ class StackupLayer(GrpcStackupLayer):
             super(StackupLayer, self.__class__).etch_factor.__set__(self, GrpcValue(value))
 
     @property
-    def top_hallhuray_nodule_radius(self):
+    def top_hallhuray_nodule_radius(self) -> float:
         """Huray model nodule radius on layer top.
 
         Returns
@@ -357,7 +357,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def top_hallhuray_surface_ratio(self):
+    def top_hallhuray_surface_ratio(self) -> float:
         """Huray model surface ratio on layer top.
 
         Returns
@@ -385,7 +385,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def bottom_hallhuray_nodule_radius(self):
+    def bottom_hallhuray_nodule_radius(self) -> float:
         """Huray model nodule radius on layer bottom.
 
         Returns
@@ -413,7 +413,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def bottom_hallhuray_surface_ratio(self):
+    def bottom_hallhuray_surface_ratio(self) -> float:
         """Huray model surface ratio on layer bottom.
 
         Returns
@@ -441,7 +441,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def side_hallhuray_nodule_radius(self):
+    def side_hallhuray_nodule_radius(self) -> float:
         """Huray model nodule radius on layer sides.
 
         Returns
@@ -469,7 +469,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def side_hallhuray_surface_ratio(self):
+    def side_hallhuray_surface_ratio(self) -> float:
         """Huray model surface ratio on layer sides.
 
         Returns
@@ -496,7 +496,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def top_groisse_roughness(self):
+    def top_groisse_roughness(self) -> float:
         """Groisse model on layer top.
 
         Returns
@@ -524,7 +524,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def bottom_groisse_roughness(self):
+    def bottom_groisse_roughness(self) -> float:
         """Groisse model on layer bottom.
 
         Returns
@@ -552,7 +552,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def side_groisse_roughness(self):
+    def side_groisse_roughness(self) -> float:
         """Groisse model on layer bottom.
 
         Returns
@@ -586,7 +586,7 @@ class StackupLayer(GrpcStackupLayer):
         huray_surface_ratio="2.9",
         groisse_roughness="1um",
         apply_on_surface="all",
-    ):
+    ) -> bool:
         """Assign roughness model on this layer.
 
         Parameters
@@ -603,6 +603,9 @@ class StackupLayer(GrpcStackupLayer):
             Where to assign roughness model. The default is ``"all"``. Options are ``"top"``, ``"bottom"``,
              ``"side"``.
 
+        Returns
+        -------
+        bool
         """
         regions = []
         if apply_on_surface == "all":

pyedb/grpc/database/layout/layout.py

@@ -72,7 +72,7 @@ class Layout(GrpcLayout):
         return self._pedb._active_cell
 
     @property
-    def primitives(self):
+    def primitives(self) -> list[any]:
         prims = []
         for prim in super().primitives:
             if isinstance(prim, ansys.edb.core.primitive.path.Path):
@@ -90,7 +90,7 @@ class Layout(GrpcLayout):
         return prims
 
     @property
-    def terminals(self):
+    def terminals(self) -> list[any]:
         """Get terminals belonging to active layout.
 
         Returns
@@ -113,7 +113,7 @@ class Layout(GrpcLayout):
         return temp
 
     @property
-    def nets(self):
+    def nets(self) -> list[Net]:
         """Nets.
 
         Returns
@@ -124,7 +124,7 @@ class Layout(GrpcLayout):
         return [Net(self._pedb, net) for net in super().nets]
 
     @property
-    def bondwires(self):
+    def bondwires(self) -> list[Bondwire]:
         """Bondwires.
 
         Returns
@@ -135,7 +135,7 @@ class Layout(GrpcLayout):
         return [i for i in self.primitives if i.primitive_type == "bondwire"]
 
     @property
-    def groups(self):
+    def groups(self) -> list[Component]:
         """Groups
 
         Returns
@@ -147,7 +147,7 @@ class Layout(GrpcLayout):
         return [Component(self._pedb, g) for g in self._pedb.active_cell.layout.groups]
 
     @property
-    def pin_groups(self):
+    def pin_groups(self) -> list[PinGroup]:
         """Pin groups.
 
         Returns
@@ -159,7 +159,7 @@ class Layout(GrpcLayout):
         return [PinGroup(self._pedb, i) for i in self._pedb.active_cell.layout.pin_groups]
 
     @property
-    def net_classes(self):
+    def net_classes(self) -> list[NetClass]:
         """Net classes.
 
         Returns
@@ -171,7 +171,7 @@ class Layout(GrpcLayout):
         return [NetClass(self._pedb, i) for i in self._pedb.active_cell.layout.net_classes]
 
     @property
-    def extended_nets(self):
+    def extended_nets(self) -> list[ExtendedNet]:
         """Extended nets.
 
         Returns
@@ -183,7 +183,7 @@ class Layout(GrpcLayout):
         return [ExtendedNet(self._pedb, i) for i in self._pedb.active_cell.layout.extended_nets]
 
     @property
-    def differential_pairs(self):
+    def differential_pairs(self) -> list[DifferentialPair]:
         """Differential pairs.
 
         Returns
@@ -195,13 +195,13 @@ class Layout(GrpcLayout):
         return [DifferentialPair(self._pedb, i) for i in self._pedb.active_cell.layout.differential_pairs]
 
     @property
-    def padstack_instances(self):
+    def padstack_instances(self) -> list[PadstackInstance]:
         """Get all padstack instances in a list."""
         return [PadstackInstance(self._pedb, i) for i in self._pedb.active_cell.layout.padstack_instances]
 
     #
     @property
-    def voltage_regulators(self):
+    def voltage_regulators(self) -> list[VoltageRegulator]:
         """Voltage regulators.
 
         List[:class:`VoltageRegulator <pyedb.grpc.database.layout.voltage_regulator.VoltageRegulator>`.
@@ -212,7 +212,7 @@ class Layout(GrpcLayout):
 
     def find_primitive(
         self, layer_name: Union[str, list] = None, name: Union[str, list] = None, net_name: Union[str, list] = None
-    ) -> list:
+    ) -> list[any]:
         """Find a primitive objects by layer name.
         Parameters
         ----------

pyedb/grpc/database/layout/voltage_regulator.py

@@ -25,7 +25,7 @@ from ansys.edb.core.layout.voltage_regulator import (
 )
 from ansys.edb.core.utility.value import Value as GrpcValue
 
-from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance
+from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
 
 
 class VoltageRegulator(GrpcVoltageRegulator):
@@ -62,7 +62,7 @@ class VoltageRegulator(GrpcVoltageRegulator):
         self.group = self._pedb.components.instances[value]
 
     @property
-    def load_regulator_current(self):
+    def load_regulator_current(self) -> float:
         """Load regulator current value
 
         Returns
@@ -77,7 +77,7 @@ class VoltageRegulator(GrpcVoltageRegulator):
         self.load_regulation_percent = GrpcValue(value)
 
     @property
-    def load_regulation_percent(self):
+    def load_regulation_percent(self) -> float:
         """Retrieve load regulation percent value.
 
         Returns
@@ -92,7 +92,7 @@ class VoltageRegulator(GrpcVoltageRegulator):
         self.load_regulation_percent = GrpcValue(value)
 
     @property
-    def negative_remote_sense_pin(self):
+    def negative_remote_sense_pin(self) -> PadstackInstance:
         """Retrieve negative remote sense pin.
 
         Returns
@@ -107,11 +107,11 @@ class VoltageRegulator(GrpcVoltageRegulator):
         if isinstance(value, int):
             if value in self._pedb.padsatcks.instances:
                 self.neg_remote_sense_pin = self._pedb.padsatcks.instances[value]
-        elif isinstance(value, EDBPadstackInstance):
+        elif isinstance(value, PadstackInstance):
             self.neg_remote_sense_pin = value
 
     @property
-    def positive_remote_sense_pin(self):
+    def positive_remote_sense_pin(self) -> PadstackInstance:
         """Retrieve positive remote sense pin.
 
         Returns
@@ -128,13 +128,13 @@ class VoltageRegulator(GrpcVoltageRegulator):
                 self.positive_remote_sense_pin = self._pedb.padsatcks.instances[value]
                 if not self.component:
                     self.component = self._pedb.padsatcks.instances[value].component.name
-        elif isinstance(value, EDBPadstackInstance):
+        elif isinstance(value, PadstackInstance):
             self.positive_remote_sense_pin = value
             if not self.component:
                 self.component = value.component.name
 
     @property
-    def voltage(self):
+    def voltage(self) -> float:
         """Retrieve voltage value.
 
         Returns

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