pyedb 0.57.0__tar.gz → 0.58.0__tar.gz

{pyedb-0.57.0 → pyedb-0.58.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyedb
-Version: 0.57.0
+Version: 0.58.0
 Summary: Higher-Level Pythonic Ansys Electronics Data Base
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: PyEDB developers <simon.vandenbrouck@ansys.com>
@@ -29,6 +29,8 @@ Requires-Dist: shapely
 Requires-Dist: scikit-rf
 Requires-Dist: ansys-edb-core>=0.2.0
 Requires-Dist: psutil
+Requires-Dist: defusedxml>=0.7,<8.0
+Requires-Dist: matplotlib>=3.5.0,<3.11
 Requires-Dist: ansys-sphinx-theme>=1.0.0,<1.5 ; extra == "doc"
 Requires-Dist: imageio>=2.30.0,<2.38 ; extra == "doc"
 Requires-Dist: ipython>=8.13.0,<8.32 ; extra == "doc"
@@ -41,14 +43,12 @@ Requires-Dist: numpydoc>=1.5.0,<1.9 ; extra == "doc"
 Requires-Dist: pypandoc>=1.10.0,<1.16 ; extra == "doc"
 Requires-Dist: recommonmark ; extra == "doc"
 Requires-Dist: Sphinx>=7.1.0,<8.2 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2021.3.14 ; extra == "doc" and ( python_version == '3.8')
+Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc" and ( python_version == '3.8')
 Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc" and ( python_version > '3.8')
 Requires-Dist: sphinx-copybutton>=0.5.0,<0.6 ; extra == "doc"
 Requires-Dist: sphinx-gallery>=0.14.0,<0.20 ; extra == "doc"
 Requires-Dist: sphinx_design>=0.4.0,<0.7 ; extra == "doc"
 Requires-Dist: shapely ; extra == "doc"
-Requires-Dist: matplotlib>=3.5.0,<3.11 ; extra == "full"
-Requires-Dist: shapely ; extra == "full"
 Requires-Dist: matplotlib>=3.5.0,<3.11 ; extra == "tests"
 Requires-Dist: mock>=5.1.0,<5.3 ; extra == "tests"
 Requires-Dist: pytest>=7.4.0,<8.5 ; extra == "tests"
@@ -62,7 +62,6 @@ Project-URL: Documentation, https://edb.docs.pyansys.com
 Project-URL: Releases, https://github.com/ansys/pyedb/releases
 Project-URL: Source, https://github.com/ansys/pyedb
 Provides-Extra: doc
-Provides-Extra: full
 Provides-Extra: tests
 
 <!-- -->

{pyedb-0.57.0 → pyedb-0.58.0}/pyproject.toml

@@ -38,6 +38,8 @@ dependencies = [
     "scikit-rf",
     "ansys-edb-core>=0.2.0",
     "psutil",
+    "defusedxml>=0.7,<8.0",
+    "matplotlib>=3.5.0,<3.11",
 ]
 
 [project.optional-dependencies]
@@ -64,17 +66,12 @@ doc = [
     # NOTE: Remove recommonmark once examples are reworked.
     "recommonmark",
     "Sphinx>=7.1.0,<8.2",
-    "sphinx-autobuild==2021.3.14; python_version == '3.8'",
+    "sphinx-autobuild==2024.10.3; python_version == '3.8'",
     "sphinx-autobuild==2024.10.3; python_version > '3.8'",
     "sphinx-copybutton>=0.5.0,<0.6",
     "sphinx-gallery>=0.14.0,<0.20",
     "sphinx_design>=0.4.0,<0.7",
     "shapely",
-
-]
-full = [
-    "matplotlib>=3.5.0,<3.11",
-    "shapely",
 ]
 
 

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/__init__.py

@@ -37,7 +37,7 @@ deprecation_warning()
 #
 
 pyedb_path = os.path.dirname(__file__)
-__version__ = "0.57.0"
+__version__ = "0.58.0"
 version = __version__
 
 #

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/configuration/cfg_pin_groups.py

@@ -35,6 +35,8 @@ class CfgPinGroups:
         layout_pin_groups = self._pedb.siwave.pin_groups
         for pg_name, pg_obj in layout_pin_groups.items():
             pins = list(pg_obj.pins.keys())
+            if len(pins) == 0:  # pragma: no cover
+                continue
             refdes = list(pg_obj.pins.values())[0].component.name
             cfg_pg = CfgPinGroup(
                 self._pedb,

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/cell/hierarchy/component.py

@@ -25,6 +25,8 @@ import re
 from typing import Optional
 import warnings
 
+import numpy as np
+
 from pyedb.dotnet.database.cell.hierarchy.hierarchy_obj import Group
 from pyedb.dotnet.database.cell.hierarchy.model import PinPairModel, SPICEModel
 from pyedb.dotnet.database.cell.hierarchy.netlist_model import NetlistModel
@@ -33,14 +35,6 @@ from pyedb.dotnet.database.cell.hierarchy.s_parameter_model import SparamModel
 from pyedb.dotnet.database.cell.hierarchy.spice_model import SpiceModel
 from pyedb.dotnet.database.definition.package_def import PackageDef
 from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance
-
-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
 
 

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/cell/layout.py

@@ -409,8 +409,8 @@ class Layout(ObjBase):
         """
         candidates = self.padstack_instances
         if instance_id is not None:
-            instance_id = int(instance_id)
             value = instance_id if isinstance(instance_id, list) else [instance_id]
+            value = [int(i) for i in value]
             candidates = [i for i in candidates if i.id in value]
 
         if aedt_name is not None:

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/components.py

@@ -961,7 +961,7 @@ class Components(object):
         if not isinstance(port_type, int):
             if port_type == "circuit_port":
                 port_type = SourceType.CircPort
-            elif port_type == "coaxial_port":
+            elif port_type in ["coaxial_port", "coax_port"]:
                 port_type = SourceType.CoaxPort
             elif port_type == "lumped_port":
                 port_type = SourceType.LumpedPort
@@ -1518,8 +1518,6 @@ class Components(object):
                 if componentDefinitionPin.IsNull():
                     self._logger.error("Failed to create component definition pin {}-{}".format(name, pin.GetName()))
                     return None
-        else:
-            self._logger.warning("Found existing component definition for footprint {}".format(name))
         return componentDefinition
 
     def create_rlc_component(

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/edb_data/control_file.py

@@ -23,10 +23,12 @@
 import copy
 import os
 import re
-import subprocess
+import subprocess  # nosec B404
 import sys
 import xml
 
+from defusedxml.ElementTree import parse as defused_parse
+
 from pyedb.generic.general_methods import ET, env_path, env_value, is_linux
 from pyedb.generic.settings import settings
 from pyedb.misc.aedtlib_personalib_install import write_pretty_xml
@@ -36,6 +38,11 @@ from pyedb.misc.misc import list_installed_ansysem
 def convert_technology_file(tech_file, edbversion=None, control_file=None):
     """Convert a technology file to edb control file (xml).
 
+    .. warning::
+        Do not execute this function with untrusted function argument, environment
+        variables or pyedb global settings.
+        See the :ref:`security guide<ref_security_consideration>` for details.
+
     Parameters
     ----------
     tech_file : str
@@ -99,10 +106,11 @@ def convert_technology_file(tech_file, edbversion=None, control_file=None):
         ]
         commands.append(command)
         commands.append(["rm", "-r", vlc_file_name + ".aedb"])
-        my_env = os.environ.copy()
         for command in commands:
-            p = subprocess.Popen(command, env=my_env)
-            p.wait()
+            try:
+                subprocess.run(command, check=True)  # nosec
+            except subprocess.CalledProcessError as e:  # nosec
+                raise RuntimeError("An error occurred while converting a technology file to edb control file") from e
         if os.path.exists(control_file):
             settings.logger.info("Xml file created.")
             return control_file
@@ -1213,7 +1221,7 @@ class ControlFile:
         -------
         bool
         """
-        tree = ET.parse(xml_input)
+        tree = defused_parse(xml_input)
         root = tree.getroot()
         for el in root:
             if el.tag == "Stackup":

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/edb_data/padstacks_data.py

@@ -22,6 +22,7 @@
 
 from collections import OrderedDict
 import math
+import re
 import warnings
 
 from pyedb.dotnet.clr_module import String
@@ -1213,6 +1214,39 @@ class EDBPadstackInstance(Connectable):
         if not term.is_null:
             return term
 
+    @property
+    def side_number(self):
+        """Return the number of sides meshed of the padstack instance.
+        Returns
+        -------
+        int
+            Number of sides meshed of the padstack instance.
+        """
+        side_value = self._edb_object.GetProductProperty(self._pedb._edb.ProductId.Hfss3DLayout, 21)
+        if side_value[0]:
+            return int(re.search(r"(?m)^\s*sid=(\d+)", side_value[1]).group(1))
+        return 0
+
+    @side_number.setter
+    def side_number(self, value):
+        """Set the number of sides meshed of the padstack instance.
+
+        Parameters
+        ----------
+        value : int
+            Number of sides to mesh the padstack instance.
+
+        Returns
+        -------
+        bool
+            True if successful, False otherwise.
+        """
+        if isinstance(value, int) and 3 <= value <= 64:
+            prop_string = f"$begin ''\n\tsid={value}\n\tmat='copper'\n\tvs='Wirebond'\n$end ''\n"
+            self._edb_object.SetProductProperty(self._pedb._edb.ProductId.Hfss3DLayout, 21, prop_string)
+        else:
+            raise ValueError("Number of sides must be an integer between 3 and 64")
+
     @property
     def terminal(self):
         """Terminal."""
@@ -1918,18 +1952,6 @@ class EDBPadstackInstance(Connectable):
         """
         return int(self._edb_padstackinstance.GetGroup().GetPlacementLayer().GetTopBottomAssociation())
 
-    @property
-    def side_number(self) -> float:
-        if not self._side_number:
-            prop_string = "$begin ''\n\tsid=3\n\tmat='copper'\n\tvs='Wirebond'\n$end ''\n"
-            self._edb_padstackinstance.SetProductProperty(self._pedb._edb.ProductId.Designer, 21, prop_string)
-        self._side_number = self._edb_padstackinstance.GetProductProperty(self._pedb._edb.ProductId.Designer, 21)
-        return self._side_number
-
-    @side_number.setter
-    def side_number(self, value):
-        self._side_number = self._edb_padstackinstance.GetProductProperty(self._pedb._edb.ProductId.Designer, 21, value)
-
     def create_rectangle_in_pad(self, layer_name, return_points=False, partition_max_order=16):
         """Create a rectangle inscribed inside a padstack instance pad.
 

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/edb_data/sources.py

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from typing import List, Tuple, Union
 import warnings
 
 from pyedb.generic.constants import NodeType, SourceType
@@ -279,9 +280,27 @@ class PinGroup(object):
     @property
     def pins(self):
         """Gets the pins belong to this pin group."""
-        from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance
+        edb_pin_ids = [edb_pin.GetId() for edb_pin in list(self._edb_object.GetPins())]
+        if len(edb_pin_ids) == 0:
+            return {}
+        else:
+            pins = self._pedb.layout.find_padstack_instances(instance_id=edb_pin_ids)
+            return {i.name: i for i in pins}
+
+    def remove_pins(self, pins: Union[str, List[str]]):
+        """Remove pins from the pin group.
+
+        Parameters
+        ----------
+        pins : str, list
+            List of padstack instance names.
+
+        """
+        _pins = pins if isinstance(pins, Union[list, Tuple]) else [pins]
 
-        return {i.GetName(): EDBPadstackInstance(i, self._pedb) for i in list(self._edb_object.GetPins())}
+        pin_objs = [j for i, j in self.pins.items() if i in _pins]
+        for p in pin_objs:
+            self._edb_object.RemovePin(p._edb_object)
 
     @property
     def node_pins(self):

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/general.py

@@ -27,17 +27,12 @@ This module contains EDB general methods and related methods.
 
 from __future__ import absolute_import  # noreorder
 
+from enum import Enum
 import logging
 import re
 
 from pyedb.dotnet.clr_module import Dictionary, List, Tuple
 
-try:
-    from enum import Enum
-except ImportError:
-    Enum = None
-
-
 logger = logging.getLogger(__name__)
 
 

{pyedb-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/layout_validation.py

@@ -339,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-0.57.0 → pyedb-0.58.0}/src/pyedb/dotnet/database/sim_setup_data/io/siwave.py

@@ -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-0.57.0 → pyedb-0.58.0}/src/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": [],
@@ -1996,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
@@ -2266,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-0.57.0 → pyedb-0.58.0}/src/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."""