pyedb 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

pyedb/dotnet/database/layout_validation.py

@@ -155,7 +155,7 @@ class LayoutValidation:
         Examples
         --------
 
-        >>> renamed_nets = edb.layout_validation.disjoint_nets(["GND","Net2"])
+        >>> renamed_nets = edb.layout_validation.disjoint_nets(["GND", "Net2"])
         """
 
         if not net_list:
@@ -208,8 +208,11 @@ class LayoutValidation:
                             if isinstance(obj_dict[el], Primitive):
                                 if not obj_dict[el].is_void:
                                     sum += obj_dict[el].area()
-                        except:
-                            pass
+                        except Exception as e:
+                            self._pedb.logger.warning(
+                                f"A(n) {type(e).__name__} error occurred while calculating area "
+                                f"for element {elem} - Default value of 0 is used: {str(e)}"
+                            )
                     return sum
 
                 if order_by_area:
@@ -336,3 +339,11 @@ class LayoutValidation:
                 if fix:
                     obj.aedt_name = f"via_{obj.id}"
         self._pedb.logger.info(f"Found {counts}/{len(pds)} padstacks have no name.")
+
+    @execution_timer("empty_pin_group")
+    def delete_empty_pin_groups(self):
+        for name, pg in self._pedb.siwave.pin_groups.items():
+            pins = pg.pins
+            if len(pins) == 0:
+                pg.delete()
+                self._pedb.logger.info(f"Pin group {name} deleted because it has no pins.")

pyedb/dotnet/database/materials.py

@@ -243,9 +243,7 @@ class Material(object):
         if self.__dc_model and value:
             self.__dc_model.SetDCRelativePermitivity(value)
         else:
-            self.__edb.logger.error(
-                f"DC permittivity cannot be updated in material without DC model or value {value}." f""
-            )
+            self.__edb.logger.error(f"DC permittivity cannot be updated in material without DC model or value {value}.")
 
     @property
     def dielectric_model_frequency(self):

pyedb/dotnet/database/modeler.py

@@ -23,6 +23,7 @@
 """
 This module contains these classes: `EdbLayout` and `Shape`.
 """
+
 import math
 import warnings
 
@@ -355,8 +356,11 @@ class Modeler(object):
                 bounding_box.Item2.X.ToDouble(),
                 bounding_box.Item2.Y.ToDouble(),
             ]
-        except:
-            pass
+        except Exception as e:
+            self._logger.warning(
+                f"A(n) {type(e).__name__} error occurred while retrieving bounding box for polygon {polygon} - "
+                f"Empty list is returned: {str(e)}"
+            )
         return bounding
 
     def get_polygon_points(self, polygon):
@@ -383,7 +387,7 @@ class Modeler(object):
         --------
 
         >>> poly = database.modeler.get_polygons_by_layer("GND")
-        >>> points  = database.modeler.get_polygon_points(poly[0])
+        >>> points = database.modeler.get_polygon_points(poly[0])
 
         """
         points = []

pyedb/dotnet/database/nets.py

@@ -308,22 +308,30 @@ class EdbNets(CommonNets):
                 val_value = cmp.rlc_values
                 if refdes in exception_list:
                     pass
-                elif (
-                    val_type == "Inductor"
-                    and self._pedb.edb_value(val_value[1]).ToDouble() <= self._pedb.edb_value(inductor_below).ToDouble()
-                ):
-                    pass
-                elif (
-                    val_type == "Resistor"
-                    and self._pedb.edb_value(val_value[0]).ToDouble() <= self._pedb.edb_value(resistor_below).ToDouble()
-                ):
-                    pass
-                elif (
-                    val_type == "Capacitor"
-                    and self._pedb.edb_value(val_value[2]).ToDouble()
-                    >= self._pedb.edb_value(capacitor_above).ToDouble()
-                ):
-                    pass
+                elif val_type == "Inductor":
+                    if val_value[1] is None:
+                        continue
+                    elif (
+                        not self._pedb.edb_value(val_value[1]).ToDouble()
+                        <= self._pedb.edb_value(inductor_below).ToDouble()
+                    ):
+                        continue
+                elif val_type == "Resistor":
+                    if val_value[0] is None:
+                        continue
+                    elif (
+                        not self._pedb.edb_value(val_value[0]).ToDouble()
+                        <= self._pedb.edb_value(resistor_below).ToDouble()
+                    ):
+                        continue
+                elif val_type == "Capacitor":
+                    if val_value[2] is None:
+                        continue
+                    elif (
+                        not self._pedb.edb_value(val_value[2]).ToDouble()
+                        >= self._pedb.edb_value(capacitor_above).ToDouble()
+                    ):
+                        continue
                 else:
                     continue
 
@@ -575,7 +583,7 @@ class EdbNets(CommonNets):
         Examples
         --------
 
-        >>> deleted_nets = database.nets.delete(["Net1","Net2"])
+        >>> deleted_nets = database.nets.delete(["Net1", "Net2"])
         """
         warnings.warn("Use :func:`delete` method instead.", DeprecationWarning)
         return self.delete(netlist=netlist)
@@ -596,7 +604,7 @@ class EdbNets(CommonNets):
         Examples
         --------
 
-        >>> deleted_nets = database.nets.delete(["Net1","Net2"])
+        >>> deleted_nets = database.nets.delete(["Net1", "Net2"])
         """
         if isinstance(netlist, str):
             netlist = [netlist]
@@ -733,7 +741,7 @@ class EdbNets(CommonNets):
         Examples
         --------
 
-        >>> renamed_nets = database.nets.find_and_fix_disjoint_nets(["GND","Net2"])
+        >>> renamed_nets = database.nets.find_and_fix_disjoint_nets(["GND", "Net2"])
         """
         warnings.warn("Use new function :func:`edb.layout_validation.disjoint_nets` instead.", DeprecationWarning)
         return self._pedb.layout_validation.disjoint_nets(

pyedb/dotnet/database/padstack.py

@@ -23,6 +23,7 @@
 """
 This module contains the `EdbPadstacks` class.
 """
+
 from collections import defaultdict
 import math
 from typing import Dict, List
@@ -708,8 +709,9 @@ class EdbPadstacks(object):
                             )
                         else:  # pragma no cover
                             self._logger.error(
-                                "Failed to reassign anti-pad value {} on Pads-stack definition {},"
-                                " layer{}".format(str(value), padstack.edb_padstack.GetName(), layer)
+                                "Failed to reassign anti-pad value {} on Pads-stack definition {}, layer{}".format(
+                                    str(value), padstack.edb_padstack.GetName(), layer
+                                )
                             )
                             all_succeed = False
                 padstack.edb_padstack.SetData(cloned_padstack_data)

pyedb/dotnet/database/sim_setup_data/io/siwave.py

@@ -349,7 +349,7 @@ class AdvancedSettings(SettingsBase):
             ``True`` if automatic mesh is used, ``False`` otherwise.
         """
         warnings.warn(
-            "`automatic_mesh` is deprecated." "Use `mesh_automatic` instead.",
+            "`automatic_mesh` is deprecated. Use `mesh_automatic` instead.",
             DeprecationWarning,
         )
         return self.sim_setup_info.simulation_settings.AdvancedSettings.MeshAutoMatic
@@ -713,6 +713,19 @@ class DCAdvancedSettings(SettingsBase):
     def max_num_pass(self):
         """Maximum number of passes.
 
+        deprecated: Use `max_num_passes` instead.
+
+        Returns
+        -------
+        int
+        """
+        warnings.warn("`max_num_pass` is deprecated. Use `max_num_passes` instead.", DeprecationWarning)
+        return self.max_num_passes
+
+    @property
+    def max_num_passes(self):
+        """Maximum number of passes.
+
         Returns
         -------
         int
@@ -723,6 +736,19 @@ class DCAdvancedSettings(SettingsBase):
     def min_num_pass(self):
         """Minimum number of passes.
 
+        deprecated: Use `min_num_passes` instead.
+
+        Returns
+        -------
+        int
+        """
+        warnings.warn("`min_num_pass` is deprecated. Use `min_num_passes` instead.", DeprecationWarning)
+        return self.sim_setup_info
+
+    @property
+    def min_num_passes(self):
+        """Minimum number of passes.
+
         Returns
         -------
         int
@@ -753,6 +779,19 @@ class DCAdvancedSettings(SettingsBase):
     def num_bondwire_sides(self):
         """Number of bondwire sides.
 
+        deprecated: Use `num_bw_sides` instead.
+
+        Returns
+        -------
+        int
+        """
+        warnings.warn("`num_bondwire_sides` is deprecated. Use `num_bw_sides` instead.", DeprecationWarning)
+        return self.num_bw_sides
+
+    @property
+    def num_bw_sides(self):
+        """Number of bondwire sides.
+
         Returns
         -------
         int
@@ -794,6 +833,20 @@ class DCAdvancedSettings(SettingsBase):
     def refine_bondwires(self):
         """Whether to refine mesh along bondwires.
 
+        deprecated: Use `refine_bws` instead.
+
+        Returns
+        -------
+        bool
+            ``True`` if refine bondwires is used, ``False`` otherwise.
+        """
+        warnings.warn("`refine_bondwires` is deprecated. Use `refine_bws` instead.", DeprecationWarning)
+        return self.refine_bws
+
+    @property
+    def refine_bws(self):
+        """Whether to refine mesh along bondwires.
+
         Returns
         -------
         bool

pyedb/dotnet/database/siwave.py

@@ -24,6 +24,7 @@
 This module contains these classes: ``CircuitPort``, ``CurrentSource``, ``EdbSiwave``,
 ``PinGroup``, ``ResistorSource``, ``Source``, ``SourceType``, and ``VoltageSource``.
 """
+
 import os
 import time
 
@@ -483,8 +484,8 @@ class EdbSiwave(object):
 
         >>> from pyedb import Edb
         >>> edbapp = Edb("myaedbfolder", "project name", "release version")
-        >>> pins =edbapp.components.get_pin_from_component("U2A5")
-        >>> edbapp.siwave.create_resistor_on_pin(pins[0], pins[1],50,"res_name")
+        >>> pins = edbapp.components.get_pin_from_component("U2A5")
+        >>> edbapp.siwave.create_resistor_on_pin(pins[0], pins[1], 50, "res_name")
         """
         resistor = ResistorSource()
         resistor.positive_node.net = pos_pin.net_name
@@ -625,7 +626,7 @@ class EdbSiwave(object):
 
         >>> from pyedb import Edb
         >>> edbapp = Edb("myaedbfolder", "project name", "release version")
-        >>> edb.siwave.create_voltage_source_on_net("U2A5","V1P5_S3","U2A5","GND",3.3,0,"source_name")
+        >>> edb.siwave.create_voltage_source_on_net("U2A5", "V1P5_S3", "U2A5", "GND", 3.3, 0, "source_name")
         """
         if not negative_component_name:
             negative_component_name = positive_component_name

pyedb/dotnet/database/stackup.py

@@ -33,6 +33,11 @@ import logging
 import math
 import warnings
 
+from defusedxml.ElementTree import parse as defused_parse
+import matplotlib.colors as colors
+import numpy as np
+import pandas as pd
+
 from pyedb.dotnet.database.edb_data.layer_data import (
     LayerEdbClass,
     StackupLayerEdbClass,
@@ -42,24 +47,6 @@ from pyedb.dotnet.database.general import convert_py_list_to_net_list
 from pyedb.generic.general_methods import ET, generate_unique_name
 from pyedb.misc.aedtlib_personalib_install import write_pretty_xml
 
-colors = None
-pd = None
-np = None
-try:
-    import matplotlib.colors as colors
-except ImportError:
-    colors = None
-
-try:
-    import numpy as np
-except ImportError:
-    np = None
-
-try:
-    import pandas as pd
-except ImportError:
-    pd = None
-
 logger = logging.getLogger(__name__)
 
 
@@ -473,9 +460,6 @@ class Stackup(LayerCollection):
         -------
         bool
         """
-        if not np:
-            self._pedb.logger.error("Numpy is needed. Please, install it first.")
-            return False
         if not layer_count % 2 == 0:
             return False
 
@@ -973,10 +957,6 @@ class Stackup(LayerCollection):
         return self.export(fpath, file_format=file_format, include_material_with_layer=include_material_with_layer)
 
     def _export_layer_stackup_to_csv_xlsx(self, fpath=None, file_format=None):
-        if not pd:
-            self._pedb.logger.error("Pandas is needed. Please, install it first.")
-            return False
-
         data = {
             "Type": [],
             "Material": [],
@@ -1137,7 +1117,7 @@ class Stackup(LayerCollection):
 
         Examples
         --------
-        >>> edb = Edb(edbpath=targetfile,  edbversion="2021.2")
+        >>> edb = Edb(edbpath=targetfile, edbversion="2021.2")
         >>> edb.stackup.flip_design()
         >>> edb.save()
         >>> edb.close_edb()
@@ -1227,8 +1207,11 @@ class Stackup(LayerCollection):
                         sball_prop = cmp_prop.GetSolderBallProperty().Clone()
                         sball_prop.SetPlacement(self._pedb.definition.SolderballPlacement.AbovePadstack)
                         cmp_prop.SetSolderBallProperty(sball_prop)
-                except:
-                    pass
+                except Exception as e:
+                    self._logger.warning(
+                        f"A(n) {type(e).__name__} error occurred while attempting to update "
+                        f"SolderBallProperty for component {cmp}: {str(e)}"
+                    )
                 if cmp_type == self._pedb.definition.ComponentType.IC:
                     die_prop = cmp_prop.GetDieProperty().Clone()
                     chip_orientation = die_prop.GetOrientation()
@@ -1356,22 +1339,28 @@ class Stackup(LayerCollection):
 
         Examples
         --------
-        >>> edb1 = Edb(edbpath=targetfile1,  edbversion="2021.2")
+        >>> edb1 = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> edb2 = Edb(edbpath=targetfile2, edbversion="2021.2")
 
         >>> hosting_cmp = edb1.components.get_component_by_name("U100")
         >>> mounted_cmp = edb2.components.get_component_by_name("BGA")
 
         >>> vector, rotation, solder_ball_height = edb1.components.get_component_placement_vector(
-        ...                                                     mounted_component=mounted_cmp,
-        ...                                                     hosting_component=hosting_cmp,
-        ...                                                     mounted_component_pin1="A12",
-        ...                                                     mounted_component_pin2="A14",
-        ...                                                     hosting_component_pin1="A12",
-        ...                                                     hosting_component_pin2="A14")
-        >>> edb2.stackup.place_in_layout(edb1.active_cell, angle=0.0, offset_x=vector[0],
-        ...                              offset_y=vector[1], flipped_stackup=False, place_on_top=True,
-        ...                              )
+        ...     mounted_component=mounted_cmp,
+        ...     hosting_component=hosting_cmp,
+        ...     mounted_component_pin1="A12",
+        ...     mounted_component_pin2="A14",
+        ...     hosting_component_pin1="A12",
+        ...     hosting_component_pin2="A14",
+        ... )
+        >>> edb2.stackup.place_in_layout(
+        ...     edb1.active_cell,
+        ...     angle=0.0,
+        ...     offset_x=vector[0],
+        ...     offset_y=vector[1],
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         # if flipped_stackup and place_on_top or (not flipped_stackup and not place_on_top):
         self.adjust_solder_dielectrics()
@@ -1453,13 +1442,18 @@ class Stackup(LayerCollection):
 
         Examples
         --------
-        >>> edb1 = Edb(edbpath=targetfile1,  edbversion="2021.2")
+        >>> edb1 = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> edb2 = Edb(edbpath=targetfile2, edbversion="2021.2")
         >>> hosting_cmp = edb1.components.get_component_by_name("U100")
         >>> mounted_cmp = edb2.components.get_component_by_name("BGA")
-        >>> edb2.stackup.place_in_layout(edb1.active_cell, angle=0.0, offset_x="1mm",
-        ...                                   offset_y="2mm", flipped_stackup=False, place_on_top=True,
-        ...                                   )
+        >>> edb2.stackup.place_in_layout(
+        ...     edb1.active_cell,
+        ...     angle=0.0,
+        ...     offset_x="1mm",
+        ...     offset_y="2mm",
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         _angle = angle * math.pi / 180.0
 
@@ -1592,13 +1586,18 @@ class Stackup(LayerCollection):
 
         Examples
         --------
-        >>> edb1 = Edb(edbpath=targetfile1,  edbversion="2021.2")
+        >>> edb1 = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> edb2 = Edb(edbpath=targetfile2, edbversion="2021.2")
         >>> hosting_cmp = edb1.components.get_component_by_name("U100")
         >>> mounted_cmp = edb2.components.get_component_by_name("BGA")
-        >>> edb1.stackup.place_instance(edb2, angle=0.0, offset_x="1mm",
-        ...                                   offset_y="2mm", flipped_stackup=False, place_on_top=True,
-        ...                                   )
+        >>> edb1.stackup.place_instance(
+        ...     edb2,
+        ...     angle=0.0,
+        ...     offset_x="1mm",
+        ...     offset_y="2mm",
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         _angle = angle * math.pi / 180.0
 
@@ -1736,11 +1735,16 @@ class Stackup(LayerCollection):
 
         Examples
         --------
-        >>> edb1 = Edb(edbpath=targetfile1,  edbversion="2021.2")
+        >>> edb1 = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> a3dcomp_path = "connector.a3dcomp"
-        >>> edb1.stackup.place_a3dcomp_3d_placement(a3dcomp_path, angle=0.0, offset_x="1mm",
-        ...                                   offset_y="2mm", flipped_stackup=False, place_on_top=True,
-        ...                                   )
+        >>> edb1.stackup.place_a3dcomp_3d_placement(
+        ...     a3dcomp_path,
+        ...     angle=0.0,
+        ...     offset_x="1mm",
+        ...     offset_y="2mm",
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         zero_data = self._edb_value(0.0)
         one_data = self._edb_value(1.0)
@@ -1795,7 +1799,7 @@ class Stackup(LayerCollection):
 
         Examples
         --------
-        >>> edb = Edb(edbpath=targetfile1,  edbversion="2021.2")
+        >>> edb = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> edb.stackup.residual_copper_area_per_layer()
         """
         temp_data = {name: 0 for name, _ in self.signal_layers.items()}
@@ -1972,10 +1976,6 @@ class Stackup(LayerCollection):
         file_path : str
             File path to the CSV file.
         """
-        if not pd:
-            self._pedb.logger.error("Pandas is needed. You must install it first.")
-            return False
-
         df = pd.read_csv(file_path, index_col=0)
 
         for name in self.layers.keys():  # pragma: no cover
@@ -2242,9 +2242,6 @@ class Stackup(LayerCollection):
             ``True`` when successful, ``False`` when failed.
         """
 
-        if not colors:
-            self._pedb.logger.error("Matplotlib is needed. Please, install it first.")
-            return False
         tree = ET.parse(file_path)
         root = tree.getroot()
         stackup = root.find("Stackup")

pyedb/dotnet/database/utilities/heatsink.py

@@ -1,5 +1,4 @@
 class HeatSink:
-
     """Heatsink model description.
 
     Parameters

pyedb/dotnet/database/utilities/hfss_simulation_setup.py

@@ -382,6 +382,87 @@ class HfssSimulationSetup(SimulationSetup):
             return False
         return True
 
+    def auto_mesh_operation(
+        self,
+        trace_ratio_seeding: float = 3,
+        signal_via_side_number: int = 12,
+        power_ground_via_side_number: int = 6,
+    ) -> bool:
+        """
+        Automatically create and apply a length-based mesh operation for all nets in the design.
+
+        The method inspects every signal net, determines the smallest trace width, and
+        seeds a :class:`LengthMeshOperation` whose maximum element length is
+        ``smallest_width * trace_ratio_seeding``. Signal vias (padstack instances) are
+        configured with the requested number of polygon sides, while power/ground vias
+        are updated through the global ``num_via_sides`` advanced setting.
+
+        Parameters
+        ----------
+        trace_ratio_seeding : float, optional
+            Ratio used to compute the maximum allowed element length from the
+            smallest trace width found in the design.  The resulting length is
+            ``min_width * trace_ratio_seeding``.  Defaults to ``3``.
+        signal_via_side_number : int, optional
+            Number of sides (i.e. faceting resolution) assigned to **signal**
+            padstack instances that belong to the nets being meshed.
+            Defaults to ``12``.
+        power_ground_via_side_number : int, optional
+            Number of sides assigned to **power/ground** vias via the global
+            ``advanced.num_via_sides`` setting.  Defaults to ``6``.
+
+        Returns
+        -------
+        bool
+
+        Raises
+        ------
+        ValueError
+            If the design contains no terminals, making mesh seeding impossible.
+
+        Notes
+        -----
+        * Only primitives of type ``"path"`` are considered when determining the
+          smallest trace width.
+        * Every ``(net, layer, sheet)`` tuple required by the mesher is
+          automatically populated; sheet are explicitly marked as ``False``.
+        * Existing contents of :attr:`mesh_operations` are **replaced** by the
+          single new operation.
+
+        Examples
+        --------
+        >>> setup = edbapp.setups["my_setup"]
+        >>> setup.auto_mesh_operation(trace_ratio_seeding=4, signal_vias_side_number=16)
+        >>> setup.mesh_operations[0].max_length
+        '2.5um'
+        """
+        net_for_mesh_seeding = list(set([term.net.name for term in list(self._pedb.terminals.values())]))
+        if not net_for_mesh_seeding:
+            raise ValueError("No terminals found to seed the mesh operation.")
+        net_layer_dict = {}
+        smallest_width = 1e3
+        for net in net_for_mesh_seeding:
+            net_layer_dict[net] = []
+            traces = [prim for prim in self._pedb.modeler.primitives_by_net[net] if prim.type.lower() == "path"]
+            _width = min([trace.width for trace in traces], default=1e3)
+            if _width < smallest_width:
+                smallest_width = _width
+            layers = list(set([trace.layer.name for trace in traces]))
+            for layer in layers:
+                net_layer_dict[net].append(layer)
+            for inst in [
+                inst for inst in list(self._pedb.padstacks.padstack_instances.values()) if inst.net_name == net
+            ]:
+                inst.side_number = signal_via_side_number
+        self.add_length_mesh_operation(
+            net_layer_list=net_layer_dict,
+            name=f"{self.name}_AutoMeshOp",
+            max_length=f"{round(float((smallest_width * trace_ratio_seeding)), 9) * 1e6}um",
+        )
+        if f"{self.name}_AutoMeshOp" in self.mesh_operations:
+            return True
+        return False
+
 
 class HFSSPISimulationSetup(SimulationSetup):
     """Manages EDB methods for HFSSPI simulation setup."""

pyedb/dotnet/database/utilities/simulation_setup.py

@@ -371,11 +371,13 @@ class SimulationSetup(object):
         Examples
         --------
         >>> setup1 = edbapp.create_siwave_syz_setup("setup1")
-        >>> setup1.add_frequency_sweep(frequency_sweep=[
-        ...     ["linear count", "0", "1kHz", 1],
-        ...     ["log scale", "1kHz", "0.1GHz", 10],
-        ...     ["linear scale", "0.1GHz", "10GHz", "0.1GHz"],
-        ...     ])
+        >>> setup1.add_frequency_sweep(
+        ...     frequency_sweep=[
+        ...         ["linear count", "0", "1kHz", 1],
+        ...         ["log scale", "1kHz", "0.1GHz", 10],
+        ...         ["linear scale", "0.1GHz", "10GHz", "0.1GHz"],
+        ...     ]
+        ... )
         """
         warnings.warn("`add_frequency_sweep` is deprecated. Use `add_sweep` method instead.", DeprecationWarning)
         return self.add_sweep(name, frequency_sweep)

pyedb/dotnet/database/utilities/siwave_cpa_simulation_setup.py

@@ -691,6 +691,7 @@ class SIWaveCPASimulationSetup:
         self._pedb = pedb
         self._channel_setup = ChannelSetup(pedb)
         self._solver_options = SolverOptions(pedb)
+        self.type = "cpa"
         if isinstance(siwave_cpa_setup_class, SIwaveCpaSetup):
             self._apply_cfg_object(siwave_cpa_setup_class)
         else: