pyedb 0.49.0__py3-none-any.whl → 0.50.1__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,19 @@ class StackupLayer(GrpcStackupLayer):
         self.negative = value
 
     @property
-    def material(self):
+    def is_stackup_layer(self) -> bool:
+        """Testing if layer is stackup layer.
+
+        Returns
+        -------
+        `True` if layer type is "signal" or "dielectric".
+        """
+        if self.type in ["signal", "dielectric", "via", "wirebond"]:
+            return True
+        return False
+
+    @property
+    def material(self) -> str:
         """Material.
 
         Returns
@@ -220,7 +232,7 @@ class StackupLayer(GrpcStackupLayer):
         self.set_material(name)
 
     @property
-    def conductivity(self):
+    def conductivity(self) -> float:
         """Material conductivity.
 
         Returns
@@ -229,11 +241,12 @@ class StackupLayer(GrpcStackupLayer):
             Material conductivity value.
         """
         if self.material in self._pedb.materials.materials:
-            return self._pedb.materials[self.material].conductivity
+            condcutivity = self._pedb.materials[self.material].conductivity
+            return condcutivity if condcutivity else 0.0
         return None
 
     @property
-    def permittivity(self):
+    def permittivity(self) -> float:
         """Material permittivity.
 
         Returns
@@ -242,11 +255,12 @@ class StackupLayer(GrpcStackupLayer):
             Material permittivity value.
         """
         if self.material in self._pedb.materials.materials:
-            return self._pedb.materials[self.material].permittivity
+            permittivity = self._pedb.materials[self.material].permittivity
+            return permittivity if permittivity else 0.0
         return None
 
     @property
-    def loss_tangent(self):
+    def loss_tangent(self) -> float:
         """Material loss_tangent.
 
         Returns
@@ -255,11 +269,12 @@ class StackupLayer(GrpcStackupLayer):
             Material loss tangent value.
         """
         if self.material in self._pedb.materials.materials:
-            return self._pedb.materials[self.material].loss_tangent
+            loss_tangent = self._pedb.materials[self.material].loss_tangent
+            return loss_tangent if loss_tangent else 0.0
         return None
 
     @property
-    def dielectric_fill(self):
+    def dielectric_fill(self) -> str:
         """Material name of the layer dielectric fill.
 
         Returns
@@ -270,7 +285,7 @@ class StackupLayer(GrpcStackupLayer):
         if self.type == "signal":
             return self.get_fill_material()
         else:
-            return
+            return None
 
     @dielectric_fill.setter
     def dielectric_fill(self, name):
@@ -280,7 +295,7 @@ class StackupLayer(GrpcStackupLayer):
             pass
 
     @property
-    def thickness(self):
+    def thickness(self) -> float:
         """Layer thickness.
 
         Returns
@@ -295,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
@@ -314,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
@@ -327,9 +342,9 @@ class StackupLayer(GrpcStackupLayer):
             if len(top_roughness_model) == 2:
                 return top_roughness_model[0].value
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @top_hallhuray_nodule_radius.setter
     def top_hallhuray_nodule_radius(self, value):
@@ -342,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
@@ -355,9 +370,9 @@ class StackupLayer(GrpcStackupLayer):
             if len(top_roughness_model) == 2:
                 return top_roughness_model[1].value
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @top_hallhuray_surface_ratio.setter
     def top_hallhuray_surface_ratio(self, value):
@@ -370,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
@@ -383,9 +398,9 @@ class StackupLayer(GrpcStackupLayer):
             if len(bottom_roughness_model) == 2:
                 return round(bottom_roughness_model[0].value, 9)
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @bottom_hallhuray_nodule_radius.setter
     def bottom_hallhuray_nodule_radius(self, value):
@@ -398,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
@@ -411,9 +426,9 @@ class StackupLayer(GrpcStackupLayer):
             if len(bottom_roughness_model) == 2:
                 return bottom_roughness_model[1].value
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @bottom_hallhuray_surface_ratio.setter
     def bottom_hallhuray_surface_ratio(self, value):
@@ -426,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
@@ -439,9 +454,9 @@ class StackupLayer(GrpcStackupLayer):
             side_roughness_model = self.get_roughness_model(GrpcRoughnessRegion.SIDE)
             if len(side_roughness_model) == 2:
                 return round(side_roughness_model[0].value, 9)
-            return None
+            return 0.0
         except:
-            return None
+            return 0.0
 
     @side_hallhuray_nodule_radius.setter
     def side_hallhuray_nodule_radius(self, value):
@@ -454,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
@@ -466,9 +481,9 @@ class StackupLayer(GrpcStackupLayer):
             side_roughness_model = self.get_roughness_model(GrpcRoughnessRegion.SIDE)
             if len(side_roughness_model) == 2:
                 return side_roughness_model[1].value
-            return None
+            return 0.0
         except:
-            return None
+            return 0.0
 
     @side_hallhuray_surface_ratio.setter
     def side_hallhuray_surface_ratio(self, value):
@@ -481,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
@@ -494,9 +509,9 @@ class StackupLayer(GrpcStackupLayer):
             if isinstance(top_roughness_model, GrpcValue):
                 return top_roughness_model.value
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @top_groisse_roughness.setter
     def top_groisse_roughness(self, value):
@@ -509,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
@@ -522,9 +537,9 @@ class StackupLayer(GrpcStackupLayer):
             if isinstance(bottom_roughness_model, GrpcValue):
                 return bottom_roughness_model.value
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @bottom_groisse_roughness.setter
     def bottom_groisse_roughness(self, value):
@@ -537,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
@@ -550,9 +565,9 @@ class StackupLayer(GrpcStackupLayer):
             if isinstance(side_roughness_model, GrpcValue):
                 return side_roughness_model.value
             else:
-                return None
+                return 0.0
         except:
-            return None
+            return 0.0
 
     @side_groisse_roughness.setter
     def side_groisse_roughness(self, value):
@@ -571,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
@@ -588,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":
@@ -605,6 +623,13 @@ class StackupLayer(GrpcStackupLayer):
             else:
                 model = GrpcValue(groisse_roughness)
             self.set_roughness_model(model, r)
+        if [
+            self.get_roughness_model(GrpcRoughnessRegion.TOP),
+            self.get_roughness_model(GrpcRoughnessRegion.BOTTOM),
+            self.get_roughness_model(GrpcRoughnessRegion.SIDE),
+        ]:
+            return True
+        return False
 
     @property
     def properties(self):
@@ -649,3 +674,78 @@ class StackupLayer(GrpcStackupLayer):
         data["roughness"] = roughness
         data["etching"] = {"enabled": self.etch_factor_enabled, "factor": self.etch_factor}
         return data
+
+    def _json_format(self):
+        dict_out = {
+            "color": self.color,
+            "dielectric_fill": self.dielectric_fill,
+            "etch_factor": self.etch_factor,
+            "material": self.material,
+            "loss_tangent": self.loss_tangent,
+            "permittivity": self.permittivity,
+            "conductivity": self.conductivity,
+            "zones": self.zones,
+            "transparency": self.transparency,
+            "name": self.name,
+            "roughness_enabled": self.roughness_enabled,
+            "thickness": self.thickness,
+            "lower_elevation": self.lower_elevation,
+            "upper_elevation": self.upper_elevation,
+            "type": self.type,
+            "top_hallhuray_nodule_radius": self.top_hallhuray_nodule_radius,
+            "top_hallhuray_surface_ratio": self.top_hallhuray_surface_ratio,
+            "side_hallhuray_nodule_radius": self.side_hallhuray_nodule_radius,
+            "side_hallhuray_surface_ratio": self.side_hallhuray_surface_ratio,
+            "bottom_hallhuray_nodule_radius": self.bottom_hallhuray_nodule_radius,
+            "bottom_hallhuray_surface_ratio": self.bottom_hallhuray_surface_ratio,
+        }
+        return dict_out
+
+    def _load_layer(self, layer):
+        if layer:
+            self.color = layer["color"]
+            self.type = layer["type"]
+            if isinstance(layer["material"], str):
+                self.material = layer["material"]
+            else:
+                material_data = layer["material"]
+                if material_data is not None:
+                    material_name = layer["material"]["name"]
+                    self._pedb.materials.add_material(material_name, **material_data)
+                    self.material = material_name
+            if layer["dielectric_fill"]:
+                if isinstance(layer["dielectric_fill"], str):
+                    self.dielectric_fill = layer["dielectric_fill"]
+                else:
+                    dielectric_data = layer["dielectric_fill"]
+                    if dielectric_data is not None:
+                        self._pedb.materials.add_material(**dielectric_data)
+                    self.dielectric_fill = layer["dielectric_fill"]["name"]
+            self.thickness = layer["thickness"]
+            self.etch_factor = layer["etch_factor"]
+            self.roughness_enabled = layer["roughness_enabled"]
+            if self.roughness_enabled:
+                self.top_hallhuray_nodule_radius = layer["top_hallhuray_nodule_radius"]
+                self.top_hallhuray_surface_ratio = layer["top_hallhuray_surface_ratio"]
+                self.assign_roughness_model(
+                    "huray",
+                    layer["top_hallhuray_nodule_radius"],
+                    layer["top_hallhuray_surface_ratio"],
+                    apply_on_surface="top",
+                )
+                self.bottom_hallhuray_nodule_radius = layer["bottom_hallhuray_nodule_radius"]
+                self.bottom_hallhuray_surface_ratio = layer["bottom_hallhuray_surface_ratio"]
+                self.assign_roughness_model(
+                    "huray",
+                    layer["bottom_hallhuray_nodule_radius"],
+                    layer["bottom_hallhuray_surface_ratio"],
+                    apply_on_surface="bottom",
+                )
+                self.side_hallhuray_nodule_radius = layer["side_hallhuray_nodule_radius"]
+                self.side_hallhuray_surface_ratio = layer["side_hallhuray_surface_ratio"]
+                self.assign_roughness_model(
+                    "huray",
+                    layer["side_hallhuray_nodule_radius"],
+                    layer["side_hallhuray_surface_ratio"],
+                    apply_on_surface="side",
+                )

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

@@ -37,7 +37,7 @@ class LayoutValidation:
         self._pedb = pedb
         self._layout_instance = self._pedb.layout_instance
 
-    def dc_shorts(self, net_list=None, fix=False):
+    def dc_shorts(self, net_list=None, fix=False) -> list[list[str, str]]:
         """Find DC shorts on layout.
 
         Parameters
@@ -130,7 +130,7 @@ class LayoutValidation:
         clean_disjoints_less_than=0.0,
         order_by_area=False,
         keep_disjoint_pins=False,
-    ):
+    ) -> list[str]:
         """Find and fix disjoint nets from a given netlist.
 
         Parameters
@@ -263,7 +263,7 @@ class LayoutValidation:
 
         return new_nets
 
-    def fix_self_intersections(self, net_list=None):
+    def fix_self_intersections(self, net_list=None) -> bool:
         """Find and fix self intersections from a given netlist.
 
         Parameters
@@ -306,7 +306,7 @@ class LayoutValidation:
         self._pedb._logger.info("Found {} illegal net names.".format(len(renamed_nets)))
         return
 
-    def illegal_rlc_values(self, fix=False):
+    def illegal_rlc_values(self, fix=False) -> list[str]:
         """Find and fix RLC illegal values."""
         inductors = self._pedb.components.inductors
 
@@ -318,7 +318,7 @@ class LayoutValidation:
                 if fix:
                     v.rlc_values = [0, 1, 0]
         self._pedb._logger.info(f"Found {len(temp)} inductors have no value.")
-        return
+        return temp
 
     def padstacks_no_name(self, fix=False):
         pds = self._pedb.layout.padstack_instances