pyedb 0.50.1__py3-none-any.whl → 0.52.0__py3-none-any.whl

pyedb/dotnet/database/cell/layout.py

@@ -80,6 +80,7 @@ def primitive_cast(pedb, edb_object):
 class Layout(ObjBase):
     def __init__(self, pedb, edb_object):
         super().__init__(pedb, edb_object)
+        self._primitives = []
 
     @property
     def cell(self):
@@ -230,7 +231,15 @@ class Layout(ObjBase):
         -------
         list of :class:`dotnet.database.dotnet.primitive.PrimitiveDotNet` cast objects.
         """
-        return [primitive_cast(self._pedb, p) for p in self._edb_object.Primitives if p]
+        primitives = list(self._edb_object.Primitives)
+        if len(primitives) != len(self._primitives):
+            self._primitives = [primitive_cast(self._pedb, p) for p in primitives]
+        return self._primitives
+
+    @property
+    def primitives_by_aedt_name(self) -> dict:
+        """Primitives."""
+        return {i.aedt_name: i for i in self.primitives}
 
     @property
     def bondwires(self):

pyedb/dotnet/database/dotnet/database.py

@@ -27,7 +27,6 @@ import sys
 
 from pyedb import __version__
 from pyedb.dotnet.database.general import convert_py_list_to_net_list
-from pyedb.edb_logger import pyedb_logger
 from pyedb.generic.general_methods import (
     env_path,
     env_path_student,
@@ -704,7 +703,6 @@ class EdbDotNet(object):
     """Edb Dot Net Class."""
 
     def __init__(self, edbversion, student_version=False):
-        self._logger = pyedb_logger
         if not edbversion:  # pragma: no cover
             try:
                 edbversion = "20{}.{}".format(list_installed_ansysem()[0][-3:-1], list_installed_ansysem()[0][-1:])

pyedb/dotnet/database/edb_data/padstacks_data.py

@@ -1807,8 +1807,14 @@ class EDBPadstackInstance(Primitive):
 
         val = String("")
         _, name = self._edb_padstackinstance.GetProductProperty(self._pedb.edb_api.ProductId.Designer, 11, val)
-        name = str(name).strip("'")
-        return name
+        aedt_name = str(name).strip("'")
+        if aedt_name == "":
+            if self.is_pin and self.component:
+                aedt_name = f"{self.component.name}-{self.component_pin}"
+            elif self.component_pin:
+                aedt_name = self.component_pin
+            self.aedt_name = aedt_name
+        return aedt_name
 
     @aedt_name.setter
     def aedt_name(self, value):

pyedb/dotnet/database/layout_validation.py

@@ -22,7 +22,6 @@
 
 import re
 
-from pyedb.dotnet.clr_module import String
 from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance
 from pyedb.dotnet.database.edb_data.primitives_data import Primitive
 from pyedb.generic.general_methods import generate_unique_name
@@ -304,38 +303,33 @@ class LayoutValidation:
 
     def illegal_rlc_values(self, fix=False):
         """Find and fix RLC illegal values."""
-        inductors = self._pedb.components.inductors
 
-        temp = []
-        for k, v in inductors.items():
-            componentProperty = v.edbcomponent.GetComponentProperty()
-            model = componentProperty.GetModel().Clone()
-            pinpairs = model.PinPairs
-
-            if not len(list(pinpairs)):  # pragma: no cover
-                temp.append(k)
-                if fix:
-                    v.rlc_values = [0, 1, 0]
-
-        self._pedb._logger.info("Found {} inductors have no value.".format(len(temp)))
+        for name, objs in {
+            "inductors": self._pedb.components.inductors,
+            "resistors": self._pedb.components.resistors,
+            "capacitors": self._pedb.components.capacitors,
+        }.items():
+            temp = []
+            for k, v in objs.items():
+                componentProperty = v.edbcomponent.GetComponentProperty()
+                model = componentProperty.GetModel().Clone()
+                pinpairs = model.PinPairs
+
+                if not len(list(pinpairs)):  # pragma: no cover
+                    temp.append(k)
+                    if fix:
+                        v.rlc_values = [0, 1, 0]
+
+            self._pedb._logger.info(f"Found {len(temp)} {name} have no value.")
         return
 
     def padstacks_no_name(self, fix=False):
+        """Find and fix padstacks without aedt_name."""
         pds = self._pedb.layout.padstack_instances
         counts = 0
-        via_count = 1
         for obj in pds:
-            val = String("")
-            _, name = obj._edb_object.GetProductProperty(self._pedb.edb_api.ProductId.Designer, 11, val)
-            name = str(name).strip("'")
-            if name == "":
+            if obj.aedt_name == "":
                 counts += 1
                 if fix:
-                    if not obj.component:
-                        obj._edb_object.SetProductProperty(self._pedb.edb_api.ProductId.Designer, 11, f"Via{via_count}")
-                        via_count = via_count + 1
-                    else:
-                        obj._edb_object.SetProductProperty(
-                            self._pedb.edb_api.ProductId.Designer, 11, f"{obj.component.name}-{obj.component_pin}"
-                        )
+                    obj.aedt_name = f"via_{obj.id}"
         self._pedb._logger.info(f"Found {counts}/{len(pds)} padstacks have no name.")

pyedb/dotnet/database/modeler.py

@@ -67,7 +67,6 @@ class Modeler(object):
 
     def __init__(self, p_edb):
         self._pedb = p_edb
-        self._primitives = []
 
     @property
     def _edb(self):

pyedb/dotnet/database/stackup.py

@@ -2234,7 +2234,7 @@ class Stackup(LayerCollection):
                     material.loss_tanget = material_properties["DielectricLossTangent"]
         return True
 
-    def _import_xml(self, file_path, rename=False):
+    def _import_xml(self, file_path):
         """Read external xml file and convert into json file.
         You can use xml file to import layer stackup but using json file is recommended.
         see :class:`pyedb.dotnet.database.edb_data.simulation_configuration.SimulationConfiguration´ class to
@@ -2304,7 +2304,8 @@ class Stackup(LayerCollection):
                 layers.append(layer)
             stackup_dict["layers"] = layers
         cfg = {"stackup": stackup_dict}
-        return self._pedb.configuration.load(cfg, apply_file=True)
+        self._pedb.configuration.load(cfg)
+        return self._pedb.configuration.run()
 
     def _export_xml(self, file_path):
         """Export stackup information to an external XMLfile.
@@ -2391,7 +2392,7 @@ class Stackup(LayerCollection):
         elif file_path.endswith(".json"):
             return self._import_json(file_path, rename=rename)
         elif file_path.endswith(".xml"):
-            return self._import_xml(file_path, rename=rename)
+            return self._import_xml(file_path)
         else:
             return False
 

pyedb/dotnet/edb.py

@@ -25,6 +25,7 @@
 This module is implicitly loaded in HFSS 3D Layout when launched.
 
 """
+from datetime import datetime
 from itertools import combinations
 import os
 from pathlib import Path
@@ -91,6 +92,7 @@ from pyedb.dotnet.database.utilities.siwave_simulation_setup import (
     SiwaveDCSimulationSetup,
     SiwaveSimulationSetup,
 )
+from pyedb.edb_logger import pyedb_logger
 from pyedb.generic.constants import AEDT_UNITS, SolverType, unit_converter
 from pyedb.generic.general_methods import (
     generate_unique_name,
@@ -195,6 +197,10 @@ class Edb(Database):
         layer_filter: str = None,
         remove_existing_aedt: bool = False,
     ):
+        self._logger = pyedb_logger
+        now = datetime.now()
+        self.logger.info(f"Star initializing Edb {now.time()}")
+
         if isinstance(edbpath, Path):
             edbpath = str(edbpath)
 
@@ -290,7 +296,7 @@ class Edb(Database):
                 self._logger.add_file_logger(self.log_name, "Edb")
             self.open_edb()
         if self.active_cell:
-            self.logger.info("EDB initialized.")
+            self.logger.info(f"EDB initialized.Time lapse {datetime.now() - now}")
         else:
             raise AttributeError("Failed to initialize DLLs.")
 
@@ -1232,7 +1238,7 @@ class Edb(Database):
         return self._core_primitives
 
     @property
-    def layout(self):
+    def layout(self) -> Layout:
         """Layout object.
 
         Returns
@@ -4729,3 +4735,37 @@ class Edb(Database):
             return self.variables[variable_name]
         else:
             return False
+
+    def compare(self, input_file, results=""):
+        """Compares current open database with another one.
+
+        Parameters
+        ----------
+        input_file : str
+            Path to the edb file.
+        results: str, optional
+            Path to directory in which results will be saved. If no path is given, a new "_compare_results"
+            directory will be created with the same naming and path as the .aedb folder.
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+        """
+        self.save()
+        if not results:
+            results = self.edbpath[:-5] + "_compare_results"
+            os.mkdir(results)
+        command = 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]
+        else:
+            cmd_input = [command, input_file, self.edbpath, results]
+        subprocess.run(cmd_input)
+
+        if not os.path.exists(os.path.join(results, "EDBDiff.csv")):
+            self.logger.error("Comparison execution failed")
+            return False
+        else:
+            self.logger.info("Comparison correctly completed")
+            return True

pyedb/generic/design_types.py

@@ -37,79 +37,200 @@ def Edb(
 ):
     """Provides the EDB application interface.
 
-    This module inherits all objects that belong to EDB.
-
-    Parameters
-    ----------
-    edbpath : str, optional
-        Full path to the ``aedb`` folder. The variable can also contain
-        the path to a layout to import. Allowed formats are BRD,
-        XML (IPC2581), GDS, and DXF. The default is ``None``.
-        For GDS import, the Ansys control file (also XML) should have the same
-        name as the GDS file. Only the file extension differs.
-    cellname : str, optional
-        Name of the cell to select. The default is ``None``.
-    isreadonly : bool, optional
-        Whether to open EBD in read-only mode when it is
-        owned by HFSS 3D Layout. The default is ``False``.
-    edbversion : str, optional
-        Version of EDB to use. The default is ``"2021.2"``.
-    isaedtowned : bool, optional
-        Whether to launch EDB from HFSS 3D Layout. The
-        default is ``False``.
-    oproject : optional
-        Reference to the AEDT project object.
-    student_version : bool, optional
-        Whether to open the AEDT student version. The default is ``False.``
-    technology_file : str, optional
-        Full path to technology file to be converted to xml before importing or xml. Supported by GDS format only.
-    grpc : bool, optional
-        Whether to enable gRPC. Default value is ``False``.
-
-    Returns
-    -------
-    :class:`Edb <pyedb.dotnet.edb.Edb>` or :class:`Edb <pyedb.grpc.edb.Edb>`
-
-    Note
-    ----
-    PyEDB gRPC will be released starting ANSYS release 2025R2. For legacy purpose, the gRPC will not be activated by
-    default. However, PyEDB gRPC will be the lon term supported version. The legacy PyEDB .NET will be deprecated and
-    at some point all new features will only be implemented in PyEDB gRPC. We highly encourage users moving to gRPC
-    starting release 2025R2, we tried keeping gRPC version backward compatible with legace .NET as much as possible and
-    only minor adjustments are required to be compatible.
-
-    Examples
-    --------
-    Create an ``Edb`` object and a new EDB cell.
+        This module inherits all objects that belong to EDB.
+
+        Parameters
+        ----------
+        edbpath : str, optional
+            Full path to the ``aedb`` folder. The variable can also contain
+            the path to a layout to import. Allowed formats are BRD,
+            XML (IPC2581), GDS, and DXF. The default is ``None``.
+            For GDS import, the Ansys control file (also XML) should have the same
+            name as the GDS file. Only the file extension differs.
+        cellname : str, optional
+            Name of the cell to select. The default is ``None``.
+        isreadonly : bool, optional
+            Whether to open EBD in read-only mode when it is
+            owned by HFSS 3D Layout. The default is ``False``.
+        edbversion : str, optional
+            Version of EDB to use. The default is ``"2021.2"``.
+        isaedtowned : bool, optional
+            Whether to launch EDB from HFSS 3D Layout. The
+            default is ``False``.
+        oproject : optional
+            Reference to the AEDT project object.
+        student_version : bool, optional
+            Whether to open the AEDT student version. The default is ``False.``
+        technology_file : str, optional
+            Full path to technology file to be converted to xml before importing or xml. Supported by GDS format only.
+        grpc : bool, optional
+            Whether to enable gRPC. Default value is ``False``.
+
+        Returns
+        -------
+        :class:`Edb <pyedb.dotnet.edb.Edb>` or :class:`Edb <pyedb.grpc.edb.Edb>`
+
+        Note
+        ----
+        PyEDB gRPC will be released starting ANSYS release 2025R2. For legacy purpose, the gRPC will not be activated by
+        default. However, PyEDB gRPC will be the lon term supported version. The legacy PyEDB .NET will be deprecated
+        and at some point all new features will only be implemented in PyEDB gRPC. We highly encourage users moving to
+        gRPC starting release 2025R2, we tried keeping gRPC version backward compatible with legace .NET as much as
+        possible and only minor adjustments are required to be compatible.
+
+        Examples
+        --------
+        1. Creating and Opening an EDB Database
 
     >>> from pyedb import Edb
-    >>> app = Edb()
 
-    Add a new variable named "s1" to the ``Edb`` instance.
+        # Create a new EDB instance
+    >>> edb = Edb()
+
+        # Open an existing AEDB database
+    >>> edb = Edb(edbpath="my_project.aedb")
+
+        # Import a board file (BRD, XML, GDS, etc.)
+    >>> edb = Edb(edbpath="my_board.brd")
+
+        2. Cutout Operation
+
+        # Simple cutout with signal and reference nets
+    >>> edb.cutout(
+    >>>    signal_list=["PCIe", "USB"],
+    >>>    reference_list=["GND"]
+    >>>    )
+
+        # Advanced cutout with custom parameters
+    >>> edb.cutout(
+    >>>    signal_list=["DDR"],
+    >>>    reference_list=["GND"],
+    >>>    extent_type="ConvexHull",
+    >>>    expansion_size=0.002,
+    >>>    use_round_corner=True,
+    >>>    output_aedb_path="cutout.aedb",
+    >>>    remove_single_pin_components=True
+    >>>    )
+
+        3. Exporting Designs
+
+        # Export to IPC2581 format
+    >>> edb.export_to_ipc2581("output.xml", units="millimeter")
+
+        # Export to HFSS project
+    >>> edb.export_hfss("hfss_output")
+
+        # Export to Q3D project
+    >>> edb.export_q3d("q3d_output", net_list=["PowerNet"])
+
+        # Export to Maxwell project
+    >>> edb.export_maxwell("maxwell_output")
+
+        4. Simulation Setup
+
+        # Create SIwave SYZ setup
+    >>> syz_setup = edb.create_siwave_syz_setup(
+    >>> name="GHz_Setup",
+    >>> start_freq="1GHz",
+    >>> stop_freq="10GHz"
+    >>> )
+
+        # Create SIwave DC setup
+    >>> dc_setup = edb.create_siwave_dc_setup(
+    >>> name="DC_Analysis",
+    >>> use_dc_point=True
+    >>> )
+
+        # Solve with SIwave
+    >>> edb.solve_siwave()
+
+        5. Database Management
+
+        # Save database
+    >>> edb.save()
+
+        # Save as new database
+    >>> edb.save_as("new_project.aedb")
+
+        # Close database
+    >>> edb.close()
+
+        6. Stackup and Material Operations
+
+        # Access stackup layers
+    >>> for layer_name, layer in edb.stackup.layers.items():
+    >>> print(f"Layer: {layer_name}, Thickness: {layer.thickness}")
+
+        # Add new material
+    >>> edb.materials.add_material("MyMaterial", permittivity=4.3, loss_tangent=0.02)
+
+        # Change layer thickness
+    >>> edb.stackup["TopLayer"].thickness = "0.035mm"
+
+        7. Port Creation
+
+        # Create wave port between two pins
+    >>> wave_port = edb.source_excitation.create_port(
+    >>> positive_terminal=pin1,
+    >>> negative_terminal=pin2,
+    >>> port_type="Wave"
+    >>> )
+
+        # Create lumped port
+    >>> lumped_port = edb.source_excitation.create_port(
+    >>> positive_terminal=via_terminal,
+    >>> port_type="Lumped"
+    >>> )
+
+        8. Component Management
+
+        # Delete components by type
+    >>> edb.components.delete_component(["R1", "C2"])
+
+        # Set component properties
+    >>> edb.components["U1"].set_property("Value", "10nH")
+
+        9. Parametrization
+
+        # Auto-parametrize design elements
+    >>> params = edb.auto_parametrize_design(
+    >>> traces=True,
+    >>> pads=True,
+    >>> antipads=True,
+    >>> use_relative_variables=True
+    >>> )
+    >>> print("Created parameters:", params)
 
-    >>> app['s1'] = "0.25 mm"
-    >>> app['s1'].tofloat
-    >>> 0.00025
-    >>> app['s1'].tostring
-    >>> "0.25mm"
+        10. Design Statistics
 
-    or add a new parameter with description:
+        # Get layout statistics with area calculation
+    >>> stats = edb.get_statistics(compute_area=True)
+    >>> print(f"Total nets: {stats.net_count}")
+    >>> print(f"Total components: {stats.component_count}")
 
-    >>> app['s2'] = ["20um", "Spacing between traces"]
-    >>> app['s2'].value
-    >>> 1.9999999999999998e-05
-    >>> app['s2'].description
-    >>> 'Spacing between traces'
+        11. Layout Validation
 
+        # Run DRC check
+    >>> drc_errors = edb.layout_validation.run_drc()
+    >>> print(f"Found {len(drc_errors)} DRC violations")
 
-    Create an ``Edb`` object and open the specified project.
+        12. Differential Pairs
 
-    >>> app = Edb("myfile.aedb")
+        # Create differential pair
+    >>> edb.differential_pairs.create(
+    >>> positive_net="USB_P",
+    >>> negative_net="USB_N",
+    >>> name="USB_DP"
+    >>> )
 
-    Create an ``Edb`` object from GDS and control files.
-    The XML control file resides in the same directory as the GDS file: (myfile.xml).
+        13. Workflow Automation
 
-    >>> app = Edb("/path/to/file/myfile.gds")
+        # Define and run workflow
+    >>> workflow = edb.workflow
+    >>> workflow.add_task("Import", file_path="input.brd")
+    >>> workflow.add_task("Cutout", signal_nets=["PCIe"])
+    >>> workflow.add_task("Export", format="IPC2581")
+    >>> workflow.run()
 
     """
 

pyedb/grpc/database/__init__.py

@@ -1 +0,0 @@
-from __future__ import absolute_import  # noreorder

pyedb/grpc/database/components.py

@@ -2159,3 +2159,113 @@ class Components(object):
             pin.name for pin in list(self.instances[reference_designator].pins.values()) if pin.net_name == net_name
         ]
         return self.create_pin_group(reference_designator, pins, group_name)
+
+    def deactivate_rlc_component(self, component=None, create_circuit_port=False, pec_boundary=False):
+        """Deactivate RLC component with a possibility to convert it to a circuit port.
+
+        Parameters
+        ----------
+        component : str
+            Reference designator of the RLC component.
+
+        create_circuit_port : bool, optional
+            Whether to replace the deactivated RLC component with a circuit port. The default
+            is ``False``.
+        pec_boundary : bool, optional
+            Whether to define the PEC boundary, The default is ``False``. If set to ``True``,
+            a perfect short is created between the pin and impedance is ignored. This
+            parameter is only supported on a port created between two pins, such as
+            when there is no pin group.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb_file = r'C:\my_edb_file.aedb'
+        >>> edb = Edb(edb_file)
+        >>> for cmp in list(edb.components.instances.keys()):
+        >>>     edb.components.deactivate_rlc_component(component=cmp, create_circuit_port=False)
+        >>> edb.save_edb()
+        >>> edb.close_edb()
+        """
+        if not component:
+            return False
+        if isinstance(component, str):
+            component = self.instances[component]
+            if not component:
+                self._logger.error("component %s not found.", component)
+                return False
+        if component.type in ["other", "ic", "io"]:
+            self._logger.info(f"Component {component.refdes} passed to deactivate is not an RLC.")
+            return False
+        component.is_enabled = False
+        return self._pedb.source_excitation.add_port_on_rlc_component(
+            component=component.refdes, circuit_ports=create_circuit_port, pec_boundary=pec_boundary
+        )
+
+    def replace_rlc_by_gap_boundaries(self, component=None):
+        """Replace RLC component by RLC gap boundaries. These boundary types are compatible with 3D modeler export.
+        Only 2 pins RLC components are supported in this command.
+
+        Parameters
+        ----------
+        component : str
+            Reference designator of the RLC component.
+
+        Returns
+        -------
+        bool
+        ``True`` when succeed, ``False`` if it failed.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb(edb_file)
+        >>>  for refdes, cmp in edb.components.capacitors.items():
+        >>>     edb.components.replace_rlc_by_gap_boundaries(refdes)
+        >>> edb.save_edb()
+        >>> edb.close_edb()
+        """
+        if not component:
+            return False
+        if isinstance(component, str):
+            component = self.instances[component]
+            if not component:
+                self._logger.error("component %s not found.", component)
+                return False
+        if component.type in ["other", "ic", "io"]:
+            self._logger.info(f"Component {component.refdes} skipped to deactivate is not an RLC.")
+            return False
+        component.enabled = False
+        return self._pedb.source_excitation.add_rlc_boundary(component.refdes, False)
+
+    def add_rlc_boundary(self, component=None, circuit_type=True):
+        """Add RLC gap boundary on component and replace it with a circuit port.
+        The circuit port supports only 2-pin components.
+
+        . deprecated:: pyedb 0.28.0
+        Use :func:`pyedb.grpc.core.excitations.add_rlc_boundary` instead.
+
+        Parameters
+        ----------
+        component : str
+            Reference designator of the RLC component.
+        circuit_type : bool
+            When ``True`` circuit type are defined, if ``False`` gap type will be used instead (compatible with HFSS 3D
+            modeler). Default value is ``True``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+        """
+        warnings.warn(
+            "`add_rlc_boundary` is deprecated and is now located here "
+            "`pyedb.grpc.core.excitations.add_rlc_boundary` instead.",
+            DeprecationWarning,
+        )
+        return self._pedb.source_excitation.add_rlc_boundary(self, component=component, circuit_type=circuit_type)