pyedb 0.57.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

pyedb/dotnet/database/utilities/siwave_simulation_setup.py

@@ -185,6 +185,7 @@ class SiwaveSimulationSetup(SimulationSetup):
 
     @enabled.setter
     def enabled(self, value: bool):
+        """Set the enabled flag for the setup."""
         self.sim_setup_info.simulation_settings.Enabled = value
 
     @property
@@ -324,6 +325,21 @@ class SiwaveDCSimulationSetup(SimulationSetup):
         self.set_dc_slider(1)
         return self
 
+    @property
+    def enabled(self):
+        """Flag indicating if the setup is enabled.
+
+        .. deprecated:: 0.57.0
+            Use :property:`settings.enabled` property instead.
+
+        Returns
+        -------
+        bool
+        """
+
+        warnings.warn("`enabled` property is deprecated. Use `settings.enabled` property instead.", DeprecationWarning)
+        return self.settings.enabled
+
     @property
     def sim_setup_info(self):
         """Overrides the default sim_setup_info object."""
@@ -346,7 +362,7 @@ class SiwaveDCSimulationSetup(SimulationSetup):
     @property
     def dc_ir_settings(self):
         """DC IR settings."""
-        return SiwaveDCIRSettings(self)
+        return self.settings
 
     def get_configurations(self):
         """Get SIwave DC simulation settings.
@@ -370,36 +386,270 @@ class SiwaveDCSimulationSetup(SimulationSetup):
         - ``1``: Balanced
         - ``2``: Optimal accuracy
         """
-        self.use_custom_settings = False
-        self.dc_settings.dc_slider_position = value
-        self.dc_advanced_settings.set_dc_slider(value)
+        self.settings.use_custom_settings = False
+        self.settings.dc.dc_slider_position = value
+        self.settings.dc_advanced.set_dc_slider(value)
 
     @property
     def dc_settings(self):
-        """SIwave DC setting."""
-        return DCSettings(self)
+        """SIwave DC setting.
+
+        deprecated:: 0.57.0
+              Use :property:`settings` property instead.
+
+        """
+        warnings.warn("`dc_settings` is deprecated. Use `settings.dc` property instead.", DeprecationWarning)
+        return self.settings.dc
+
+    @property
+    def settings(self):
+        """Get the settings interface for SIwave DC simulation.
+
+        Returns
+        -------
+        Settings
+            An instance of the Settings class providing access to SIwave DC simulation settings.
+        """
+        return Settings(self, self.sim_setup_info)
 
     @property
     def dc_advanced_settings(self):
         """Siwave DC advanced settings.
 
+        .. deprecated :: 0.57.0
+                Use :property:`settings` property instead.
+
         Returns
         -------
         :class:`pyedb.dotnet.database.edb_data.siwave_simulation_setup_data.SiwaveDCAdvancedSettings`
         """
-        return DCAdvancedSettings(self)
+        warnings.warn(
+            "`dc_advanced_settings` is deprecated. Use `settings.dc_advanced` property instead.", DeprecationWarning
+        )
+        return self.settings.dc_advanced
 
     @property
     def source_terms_to_ground(self):
         """Dictionary of grounded terminals.
 
+        .. deprecated:: 0.57.0
+            Use :property:`settings.source_terms_to_ground` property instead.
+
         Returns
         -------
         Dictionary
             {str, int}, keys is source name, value int 0 unspecified, 1 negative node, 2 positive one.
 
         """
-        return convert_netdict_to_pydict(self.get_sim_setup_info.simulation_settings.DCIRSettings.SourceTermsToGround)
+        warnings.warn(
+            "`source_terms_to_ground` is deprecated. Use `settings.source_terms_to_ground` property instead.",
+            DeprecationWarning,
+        )
+        return self.settings.source_terms_to_ground
+
+    def add_source_terminal_to_ground(self, source_name, terminal=0):
+        """Add a source terminal to ground.
+
+        .. deprecated:: 0.57.0
+            Use :method:`settings.add_source_terminal_to_ground` method instead.
+
+        Parameters
+        ----------
+        source_name : str,
+            Source name.
+        terminal : int, optional
+            Terminal to assign. Options are:
+
+             - 0=Unspecified
+             - 1=Negative node
+             - 2=Positive none
+
+        Returns
+        -------
+        bool
+
+        """
+        warnings.warn(
+            "`add_source_terminal_to_ground` is deprecated. Use "
+            "`settings.add_source_terminal_to_ground` method instead.",
+            DeprecationWarning,
+        )
+        return self.settings.add_source_terminal_to_ground(source_name, terminal)
+
+
+class General:
+    """Class to manage global settings for the Siwave simulation setup module.
+    Added to be compliant with ansys-edbe-core settings structure."""
+
+    def __init__(self, parent):
+        self._parent = parent
+
+    @property
+    def pi_slider_pos(self):
+        return self._parent.dc_slider_position
+
+    @property
+    def si_slider_pos(self):
+        return self._parent.si_slider_position
+
+    @property
+    def use_custom_settings(self):
+        return self._parent.use_dc_custom_settings
+
+    @property
+    def use_si_settings(self):
+        return self._parent.use_si_settings
+
+
+class SIwaveSParameterSettings:
+    def __init__(self, parent):
+        self._parent = parent
+
+    @property
+    def dc_behavior(self):
+        return
+
+    @property
+    def extrapolation(self):
+        return
+
+    @property
+    def interpolation(self):
+        return
+
+    @property
+    def use_state_space(self):
+        return True
+
+
+class Settings(SimulationSetup, SiwaveDCIRSettings):
+    """Class to manage global settings for the Siwave simulation setup module.
+    Added to be compliant with ansys-edbe-core settings structure."""
+
+    def __init__(self, parent, sim_setup_info):
+        SimulationSetup.__init__(self, pedb=parent._pedb, edb_object=parent._edb_object)
+        SiwaveDCIRSettings.__init__(self, parent)
+        self._parent = parent
+        self._sim_setup_info = sim_setup_info
+
+    @property
+    def advanced(self):
+        return True
+
+    @property
+    def dc(self):
+        return DCSettings(self._parent)
+
+    @property
+    def dc_advanced(self):
+        return DCAdvancedSettings(self._parent)
+
+    @property
+    def general(self):
+        return DCSettings(self._parent)
+
+    @property
+    def dc_report_config_file(self) -> str:
+        """Path to the DC report configuration file."""
+        # return self._sim_setup_info._edb_object.SimulationSettings.DCIRSettings.DCReportConfigFile
+        return super().dc_report_config_file
+
+    @dc_report_config_file.setter
+    def dc_report_config_file(self, value: str):
+        SiwaveDCIRSettings.dc_report_config_file = value
+
+    @property
+    def dc_report_show_active_devices(self) -> bool:
+        """Flag to show active devices in the DC report."""
+        return super().dc_report_show_active_devices
+
+    @dc_report_show_active_devices.setter
+    def dc_report_show_active_devices(self, value: bool):
+        SiwaveDCIRSettings.dc_report_show_active_devices = value
+
+    @property
+    def enabled(self) -> bool:
+        """Flag indicating if the setup is enabled."""
+        return self._sim_setup_info.simulation_settings.Enabled
+
+    @enabled.setter
+    def enabled(self, value: bool):
+        self._sim_setup_info.simulation_settings.Enabled = value
+
+    @property
+    def export_dc_thermal_data(self) -> bool:
+        """Flag to export DC thermal data."""
+        return SiwaveDCIRSettings.export_dc_thermal_data
+
+    @export_dc_thermal_data.setter
+    def export_dc_thermal_data(self, value: bool):
+        SiwaveDCIRSettings.export_dc_thermal_data = value
+
+    @property
+    def full_dc_report_path(self) -> str:
+        """Full path to the DC report."""
+        return SiwaveDCIRSettings.full_dc_report_path
+
+    @full_dc_report_path.setter
+    def full_dc_report_path(self, value: str):
+        SiwaveDCIRSettings.full_dc_report_path = value
+
+    @property
+    def icepak_temp_file_path(self) -> str:
+        """Path to the Icepak temporary file."""
+        return SiwaveDCIRSettings.icepak_temp_file_path
+
+    @icepak_temp_file_path.setter
+    def icepak_temp_file_path(self, value: str):
+        SiwaveDCIRSettings.icepak_temp_file_path = value
+
+    @property
+    def import_thermal_data(self) -> bool:
+        """Flag to import thermal data."""
+        return super().import_thermal_data
+
+    @import_thermal_data.setter
+    def import_thermal_data(self, value: bool):
+        SiwaveDCIRSettings.import_thermal_data = value
+
+    @property
+    def s_parameter(self) -> SIwaveSParameterSettings:
+        """S-parameter settings."""
+        return SIwaveSParameterSettings(self._parent)
+
+    @property
+    def source_terms_to_ground(self) -> dict[str, int]:
+        """Dictionary of grounded terminals.
+
+        Returns
+        -------
+        Dictionary
+            {str, int}, keys is source name, value int 0 unspecified, 1 negative node, 2 positive one.
+
+        """
+        return convert_netdict_to_pydict(super().source_terms_to_ground)
+
+    @source_terms_to_ground.setter
+    def source_terms_to_ground(self, value: dict[str, int]):
+        SiwaveDCIRSettings.source_terms_to_ground = convert_pydict_to_netdict(value)
+
+    @property
+    def use_loop_res_for_per_pin(self):
+        """Flag to use loop resistance for per-pin calculations."""
+        return super().use_loop_res_for_per_pin
+
+    @use_loop_res_for_per_pin.setter
+    def use_loop_res_for_per_pin(self, value: bool):
+        SiwaveDCIRSettings.use_loop_res_for_per_pin = value
+
+    @property
+    def via_report_path(self) -> str:
+        """Path to the via report."""
+        return super().via_report_path
+
+    @via_report_path.setter
+    def via_report_path(self, value: str):
+        SiwaveDCIRSettings.via_report_path = value
 
     def add_source_terminal_to_ground(self, source_name, terminal=0):
         """Add a source terminal to ground.
@@ -422,7 +672,5 @@ class SiwaveDCSimulationSetup(SimulationSetup):
         """
         terminals = self.source_terms_to_ground
         terminals[source_name] = terminal
-        self.get_sim_setup_info.simulation_settings.DCIRSettings.SourceTermsToGround = convert_pydict_to_netdict(
-            terminals
-        )
+        self._sim_setup_info.simulation_settings.DCIRSettings.SourceTermsToGround = convert_pydict_to_netdict(terminals)
         return self._update_setup()

pyedb/dotnet/edb.py

@@ -32,7 +32,7 @@ import os
 from pathlib import Path
 import re
 import shutil
-import subprocess
+import subprocess  # nosec B404
 import sys
 import time
 import traceback
@@ -754,6 +754,11 @@ class Edb:
 
         This function supports all AEDT formats, including DXF, GDS, SML (IPC2581), BRD, MCM, SIP, ZIP and TGZ.
 
+        .. 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
         ----------
         input_file : str
@@ -790,16 +795,16 @@ class Edb:
         self._nets = None
         aedb_name = os.path.splitext(os.path.basename(input_file))[0] + ".aedb"
         if anstranslator_full_path and os.path.exists(anstranslator_full_path):
-            command = anstranslator_full_path
+            executable_path = anstranslator_full_path
         else:
-            command = os.path.join(self.base_path, "anstranslator")
+            executable_path = os.path.join(self.base_path, "anstranslator")
             if is_windows:
-                command += ".exe"
+                executable_path += ".exe"
 
         if not working_dir:
             working_dir = os.path.dirname(input_file)
         cmd_translator = [
-            command,
+            executable_path,
             input_file,
             os.path.join(working_dir, aedb_name),
             "-l={}".format(os.path.join(working_dir, "Translator.log")),
@@ -817,7 +822,10 @@ class Edb:
             cmd_translator.append('-t="{}"'.format(tech_file))
         if layer_filter:
             cmd_translator.append('-f="{}"'.format(layer_filter))
-        subprocess.run(cmd_translator)
+        try:
+            subprocess.run(cmd_translator, check=True)  # nosec
+        except subprocess.CalledProcessError as e:  # nosec
+            raise RuntimeError("An error occurred while translating board file to ``edb.def`` file") from e
         if not os.path.exists(os.path.join(working_dir, aedb_name)):
             raise RuntimeWarning(f"Translator failed. command : {' '.join(cmd_translator)}")
         else:
@@ -4837,6 +4845,11 @@ class Edb:
     def compare(self, input_file, results=""):
         """Compares current open database with another one.
 
+        .. 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
         ----------
         input_file : str
@@ -4852,16 +4865,16 @@ class Edb:
         if not results:
             results = self.edbpath[:-5] + "_compare_results"
             os.mkdir(results)
-        command = os.path.join(self.base_path, "EDBDiff.exe")
+        executable_path = os.path.join(self.base_path, "EDBDiff.exe")
         if is_linux:
             mono_path = os.path.join(self.base_path, "common/mono/Linux64/bin/mono")
-            cmd_input = [mono_path, command, input_file, self.edbpath, results]
+            command = [mono_path, executable_path, input_file, self.edbpath, results]
         else:
-            cmd_input = [command, input_file, self.edbpath, results]
-        p = subprocess.run(cmd_input)
-        if p.returncode == 0:
+            command = [executable_path, input_file, self.edbpath, results]
+        try:
+            subprocess.run(command, check=True)  # nosec
             return str(Path(self.base_path).joinpath("EDBDiff.exe"))
-        else:
+        except subprocess.CalledProcessError as e:  # nosec
             raise RuntimeError(
                 "EDBDiff.exe execution failed. Please check if the executable is present in the base path."
-            )
+            ) from e

pyedb/extensions/create_cell_array.py

@@ -26,12 +26,15 @@ This module contains the array building feature from unit cell.
 
 import itertools
 from typing import Optional, Union
+import warnings
 
 from pyedb import Edb
+from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
+from pyedb.misc.decorators import execution_timer
 
 
 # ----------------------
-# Public façade function
+# Public api
 # ----------------------
 def create_array_from_unit_cell(
     edb: Edb,
@@ -94,12 +97,15 @@ def create_array_from_unit_cell(
         adapter = _GrpcAdapter(edb)
     else:
         adapter = _DotNetAdapter(edb)
+        warnings.warn(".NET back-end is deprecated and will be removed in future releases.", UserWarning)
+        warnings.warn("Consider moving to PyEDB gRPC (ANSYS 2025R2) for better performances", UserWarning)
     return __create_array_from_unit_cell_impl(edb, adapter, x_number, y_number, offset_x, offset_y)
 
 
 # ------------------------------------------------------------------
 # Implementation (technology-agnostic)
 # ------------------------------------------------------------------
+@execution_timer("create_array_from_unit_cell")
 def __create_array_from_unit_cell_impl(
     edb: Edb,
     adapter: "_BaseAdapter",
@@ -156,34 +162,44 @@ def __create_array_from_unit_cell_impl(
     paths = list(edb.modeler.paths)
     vias = list(edb.padstacks.vias.values())
     components = list(edb.components.instances.values())
+    pingroups = edb.layout.pin_groups
+    if edb.grpc:
+        pg_dict = {
+            pad.edb_uid: pg.name  # edb_uid → PinGroup.name
+            for pg in pingroups  # for every PinGroup
+            for pad in pg.pins.values()  # for every PadstackInstance in its pin-dict
+        }
+    else:
+        pg_dict = {
+            pad.id: pg.name  # edb_uid → PinGroup.name
+            for pg in pingroups  # for every PinGroup
+            for pad in pg.pins.values()  # for every PadstackInstance in its pin-dict
+        }
 
     # ---------- Replication loops ----------
     edb.logger.info(f"Starting array replication {x_number}×{y_number}")
+    total_number = x_number * y_number - 1  # minus original
+    cell_count = 0
     for i, j in itertools.product(range(x_number), range(y_number)):
         if i == 0 and j == 0:
             continue  # original already exists
-
         dx = edb.value(offset_x * i)
         dy = edb.value(offset_y * j)
-
+        # Components
+        for comp in components:
+            adapter.duplicate_component(comp, dx, dy, i, j, pin_groups=pg_dict)
         # Primitives & voids
         for prim in primitives:
-            new_poly = adapter.duplicate_primitive(prim, dx, dy, i, j)
-            for void in prim.voids:
-                adapter.duplicate_void(new_poly, void, dx, dy)
-
+            if not prim.is_void:
+                adapter.duplicate_primitive(prim, dx, dy, i, j)
         # Paths
         for path in paths:
             adapter.duplicate_path(path, dx, dy, i, j)
-
         # Stand-alone vias
         for via in (v for v in vias if not v.component):
             adapter.duplicate_standalone_via(via, dx, dy, i, j)
-
-        # Components
-        for comp in components:
-            adapter.duplicate_component(comp, dx, dy, i, j)
-
+        cell_count += 1
+        edb.logger.info(f"Replicated cell {cell_count} of {total_number} ({(cell_count / total_number) * 100:.1f}%)")
     edb.logger.info("Array replication finished successfully")
     return True
 
@@ -196,6 +212,8 @@ class _BaseAdapter:
 
     def __init__(self, edb: Edb):
         self.edb = edb
+        self.layers = edb.stackup.layers
+        self.active_layout = edb.active_layout
 
     # ---- Outline helpers ----
     def is_supported_outline(self, outline) -> bool:
@@ -222,10 +240,6 @@ class _BaseAdapter:
         """Return a new primitive translated by (dx, dy)."""
         raise NotImplementedError
 
-    def duplicate_void(self, new_poly, void, dx, dy):
-        """Add a translated copy of *void* to *new_poly*."""
-        raise NotImplementedError
-
     def duplicate_path(self, path, dx, dy, i, j):
         """Create a translated copy of *path*."""
         raise NotImplementedError
@@ -234,7 +248,7 @@ class _BaseAdapter:
         """Create a translated copy of a stand-alone via."""
         raise NotImplementedError
 
-    def duplicate_component(self, comp, dx, dy, i, j):
+    def duplicate_component(self, comp, dx, dy, i, j, pin_groups=None):
         """Create a translated copy of *comp* (including its pins)."""
         raise NotImplementedError
 
@@ -254,15 +268,11 @@ class _GrpcAdapter(_BaseAdapter):
 
     def duplicate_primitive(self, prim, dx, dy, i, j):
         moved_pd = prim.polygon_data.move((dx, dy))
+        voids = [voids.polygon_data.move((dx, dy)) for voids in prim.voids]
         return self.edb.modeler.create_polygon(
-            moved_pd,
-            layer_name=prim.layer.name,
-            net_name=prim.net.name,
+            moved_pd, layer_name=prim.layer.name, net_name=prim.net.name, voids=voids
         )
 
-    def duplicate_void(self, new_poly, void, dx, dy):
-        new_poly.add_void(void.polygon_data.move((dx, dy)))
-
     def duplicate_path(self, path, dx, dy, i, j):
         moved_line = path.cast().center_line.move((dx, dy))
         self.edb.modeler.create_trace(
@@ -276,26 +286,24 @@ class _GrpcAdapter(_BaseAdapter):
         )
 
     def duplicate_standalone_via(self, via, dx, dy, i, j):
-        from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
-
         pos = via.position
         PadstackInstance.create(
-            self.edb.active_layout,
+            self.active_layout,
             net=via.net,
-            name=f"{via.name}_i{i}_j{j}",
-            padstack_def=self.edb.padstacks.definitions[via.padstack_definition],
+            name=f"{via.name}_X{i}_Y{j}",
+            padstack_def=via.definition,
             position_x=pos[0] + dx,
             position_y=pos[1] + dy,
             rotation=0.0,
-            top_layer=self.edb.stackup.layers[via.start_layer],
-            bottom_layer=self.edb.stackup.layers[via.stop_layer],
+            top_layer=self.layers[via.start_layer],
+            bottom_layer=self.layers[via.stop_layer],
         )
 
-    def duplicate_component(self, comp, dx, dy, i, j):
-        from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
-
+    def duplicate_component(self, comp, dx, dy, i, j, pin_groups=None):
         new_pins = []
+        _pg = {}
         for pin in comp.pins.values():
+            pg_name = pin_groups.get(pin.edb_uid, None) if pin_groups else None
             pos = pin.position
             new_pin = PadstackInstance.create(
                 self.edb.active_layout,
@@ -309,6 +317,8 @@ class _GrpcAdapter(_BaseAdapter):
                 bottom_layer=self.edb.stackup.layers[pin.stop_layer],
             )
             new_pins.append(new_pin)
+            if pg_name:
+                _pg.setdefault(pg_name, []).append(new_pin)
 
         if new_pins:
             res = self.edb.value(comp.res_value) if hasattr(comp, "res_value") and comp.res_value else None
@@ -323,8 +333,11 @@ class _GrpcAdapter(_BaseAdapter):
                 l_value=ind,
                 c_value=cap,
             )
+            new_comp.type = comp.type
             if hasattr(comp, "component_property") and comp.component_property:
                 new_comp.component_property = comp.component_property
+            for pg_name, pins in _pg.items():
+                self.edb.components.create_pingroup_from_pins(pins=pins, group_name=f"{pg_name}_{i}_{j}")
 
 
 class _DotNetAdapter(_BaseAdapter):
@@ -352,14 +365,6 @@ class _DotNetAdapter(_BaseAdapter):
             net_name=prim.net.name,
         )
 
-    def duplicate_void(self, new_poly, void, dx, dy):
-        from pyedb.dotnet.database.geometry.point_data import PointData
-
-        vector = PointData.create_from_xy(self.edb, x=dx, y=dy)
-        void_polygon_data = void.polygon_data
-        void_polygon_data._edb_object.Move(vector._edb_object)
-        new_poly.add_void(void_polygon_data.points)
-
     def duplicate_path(self, path, dx, dy, i, j):
         from pyedb.dotnet.database.geometry.point_data import PointData
 
@@ -386,7 +391,7 @@ class _DotNetAdapter(_BaseAdapter):
             via_name=f"{via.aedt_name}_i{i}_j{j}",
         )
 
-    def duplicate_component(self, comp, dx, dy, i, j):
+    def duplicate_component(self, comp, dx, dy, i, j, pin_groups=None):
         new_pins = []
         for pin in comp.pins.values():
             pos = pin.position
@@ -396,7 +401,6 @@ class _DotNetAdapter(_BaseAdapter):
                 via_name=f"{pin.aedt_name}_i{i}_j{j}",
             )
             new_pins.append(new_pin)
-
         if new_pins:
             new_comp = self.edb.components.create(
                 pins=new_pins,