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

pyedb/grpc/database/control_file.py

@@ -35,23 +35,156 @@ 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).
 
-    Parameters
-    ----------
-    tech_file : str
-        Full path to technology file.
-    edbversion : str, optional
-        EDB version to use. If ``None``, uses latest available version.
-    control_file : str, optional
-        Output control file path. If ``None``, uses same path and name as ``tech_file``.
-
-    Returns
-    -------
-    str or bool
-        Full path to created control file if successful, ``False`` otherwise.
-
-    Notes
-    -----
-    This function is only supported on Linux systems.
+        Parameters
+        ----------
+        tech_file : str
+            Full path to technology file.
+        edbversion : str, optional
+            EDB version to use. If ``None``, uses latest available version.
+        control_file : str, optional
+            Output control file path. If ``None``, uses same path and name as ``tech_file``.
+
+        Returns
+        -------
+        str or bool
+            Full path to created control file if successful, ``False`` otherwise.
+
+        Notes
+        -----
+        This function is only supported on Linux systems.
+
+        Example
+        -------
+        # Example 1: Converting a technology file to control file
+    >>> converted_file = convert_technology_file(
+    >>> tech_file="/path/to/tech.t",
+    >>> edbversion="2025.2",
+    >>> control_file="/path/to/output.xml"
+    >>> )
+    >>> if converted_file:
+    >>> print(f"Converted to: {converted_file}")
+
+        # Example 2: Creating a material
+    >>> from pyedb import ControlFileMaterial
+    >>> material = ControlFileMaterial(
+    >>> "Copper",
+    >>> {"Permittivity": 1.0, "Conductivity": 5.8e7}
+    >>> )
+
+        # Example 3: Creating a dielectric layer
+    >>> from pyedb import ControlFileDielectric
+    >>> dielectric = ControlFileDielectric(
+    >>> "Core",
+    >>> {"Thickness": "0.2mm", "Material": "FR4"}
+    >>> )
+
+        # Example 4: Creating a signal layer
+    >>> from pyedb import ControlFileLayer
+    >>> signal_layer = ControlFileLayer(
+    >>> "TopLayer",
+    >>> {"Type": "signal", "Material": "Copper", "Thickness": "0.035mm"}
+    >>> )
+
+        # Example 5: Creating a via layer
+    >>> from pyedb import ControlFileVia
+    >>> via_layer = ControlFileVia(
+    >>> "Via1",
+    >>> {"StartLayer": "TopLayer", "StopLayer": "BottomLayer"}
+    >>> )
+    >>> via_layer.create_via_group = True
+    >>> via_layer.tolerance = "0.1mm"
+
+        # Example 6: Managing stackup
+    >>> from pyedb import ControlFileStackup
+    >>> stackup = ControlFileStackup(units="mm")
+    >>> stackup.add_material("FR4", permittivity=4.4, dielectric_loss_tg=0.02)
+    >>> stackup.add_layer("L1", elevation=0, material="Copper", thickness=0.035)
+    >>> stackup.add_dielectric("Diel1", material="FR4", thickness=0.2)
+    >>> stackup.add_via("Via1", start_layer="L1", stop_layer="L2")
+
+        # Example 7: Configuring import options
+    >>> from pyedb import ControlFileImportOptions
+    >>> import_ops = ControlFileImportOptions()
+    >>> import_ops.auto_close = True
+    >>> import_ops.defeature_tolerance = 0.001
+
+        # Example 8: Setting up simulation extents
+    >>> from pyedb import ControlExtent
+    >>> extent = ControlExtent(
+    >>> type="Conforming",
+    >>> diel_hactor=0.3,
+    >>> airbox_hfactor=0.5
+    >>> )
+
+        # Example 9: Creating circuit ports
+    >>> from pyedb import ControlCircuitPt
+    >>> port = ControlCircuitPt("Port1", 0, 0, "TopLayer", 1, 0, "TopLayer", 50)
+
+        # Example 10: Managing components
+    >>> from pyedb import ControlFileComponent
+    >>> comp = ControlFileComponent()
+    >>> comp.refdes = "U1"
+    >>> comp.add_pin("Pin1", 0.5, 0.5, "TopLayer")
+    >>> comp.add_port("Port1", 50, "Pin1", refpin="GND")
+
+        # Example 11: Component management
+    >>> from pyedb import ControlFileComponents
+    >>> components = ControlFileComponents()
+    >>> ic = components.add_component("U1", "BGA", "IC", die_type="Flip chip")
+    >>> ic.add_pin("A1", 1.0, 1.0, "TopLayer")
+
+         # Example 12: Boundary setup
+    >>> from pyedb import ControlFileBoundaries
+    >>> boundaries = ControlFileBoundaries()
+    >>> boundaries.add_port("Port1", 0, 0, "L1", 1, 0, "L1", 50)
+    >>> boundaries.add_extent(diel_hactor=0.3)
+
+        # Example 13: Frequency sweep configuration
+    >>> from pyedb import ControlFileSweep
+    >>> sweep = ControlFileSweep(
+    >>> "Sweep1", "1GHz", "10GHz", "0.1GHz",
+    >>> "Interpolating", "LinearStep", True
+    >>> )
+
+        # Example 14: Mesh operation setup
+    >>> from pyedb import ControlFileMeshOp
+    >>> mesh_op = ControlFileMeshOp(
+    >>> "FineMesh", "Region1", "MeshOperationSkinDepth",
+    >>> {"Net1": "TopLayer"}
+    >>> )
+    >>> mesh_op.skin_depth = "1um"
+
+        # Example 15: Simulation setup configuration
+    >>> from pyedb import ControlFileSetup
+    >>> setup = ControlFileSetup("SimSetup1")
+    >>> setup.frequency = "5GHz"
+    >>> setup.add_sweep("Sweep1", "1GHz", "10GHz", "0.5GHz")
+    >>> setup.add_mesh_operation("Mesh1", "Chip", "MeshOperationLength", {"PWR": "Top"})
+
+        # Example 16: Setup management
+    >>> from pyedb import ControlFileSetups
+    >>> setups = ControlFileSetups()
+    >>> sim_setup = setups.add_setup("MySetup", "10GHz")
+    >>> sim_setup.add_sweep("Swp1", "1GHz", "20GHz", 100, step_type="LinearCount")
+
+        # Example 17: Main control file creation
+    >>> from pyedb import ControlFile
+
+        # Create from scratch
+    >>> ctrl = ControlFile()
+    >>> ctrl.stackup.add_material("Copper", conductivity=5.8e7)
+    >>> ctrl.stackup.add_layer("Signal", thickness=0.035, material="Copper")
+    >>> ctrl.boundaries.add_port("Input", 0, 0, "Signal", 1, 0, "Signal", 50)
+    >>> ctrl.write_xml("/path/to/control.xml")
+
+        # Parse existing file
+    >>> ctrl = ControlFile(xml_input="/path/to/existing.xml")
+
+        # Convert technology file
+    >>> ctrl = ControlFile(tecnhology="/path/to/tech.t")
+
+        # Apply layer mapping
+    >>> ctrl.parse_layer_map("/path/to/layer_map.txt")
     """
     if is_linux:  # pragma: no cover
         if not edbversion:

pyedb/grpc/database/definition/materials.py

@@ -228,14 +228,14 @@ class Material(GrpcMaterialDef):
 
         """
         try:
-            return self.dielectric_material_model.dc_relative_permitivity
+            return self.dielectric_material_model.dc_relative_permittivity
         except:
             return None
 
     @dc_permittivity.setter
     def dc_permittivity(self, value):
         if self.dielectric_material_model:
-            self.dielectric_material_model.dc_relative_permitivity = float(value)
+            self.dielectric_material_model.dc_relative_permittivity = float(value)
 
     @property
     def loss_tangent_at_frequency(self) -> float:
@@ -289,14 +289,14 @@ class Material(GrpcMaterialDef):
 
         """
         try:
-            return self.dielectric_material_model.relative_permitivity_at_frequency
+            return self.dielectric_material_model.relative_permittivity_at_frequency
         except:
             return None
 
     @permittivity_at_frequency.setter
     def permittivity_at_frequency(self, value):
         if self.dielectric_material_model:
-            self.dielectric_material_model.relative_permitivity_at_frequency = float(value)
+            self.dielectric_material_model.relative_permittivity_at_frequency = float(value)
 
     @property
     def permittivity(self) -> float:
@@ -771,14 +771,14 @@ class Materials(object):
             raise ValueError(f"Material names are case-insensitive and {name.lower()} already exists.")
 
         material_model = GrpcDjordjecvicSarkarModel.create()
-        material_model.relative_permitivity_at_frequency = permittivity_at_frequency
+        material_model.relative_permittivity_at_frequency = permittivity_at_frequency
         material_model.loss_tangent_at_frequency = loss_tangent_at_frequency
         material_model.frequency = dielectric_model_frequency
         if dc_conductivity is not None:
             material_model.dc_conductivity = dc_conductivity
             material_model.use_dc_relative_conductivity = True
         if dc_permittivity is not None:
-            material_model.dc_relative_permitivity = dc_permittivity
+            material_model.dc_relative_permittivity = dc_permittivity
         try:
             material = self.__add_dielectric_material_model(name, material_model)
             for key, value in kwargs.items():
@@ -841,7 +841,7 @@ class Materials(object):
         material_model = GrpcDebyeModel.create()
         material_model.frequency_range = (lower_freqency, higher_frequency)
         material_model.loss_tangent_at_high_low_frequency = (loss_tangent_low, loss_tangent_high)
-        material_model.relative_permitivity_at_high_low_frequency = (permittivity_low, permittivity_high)
+        material_model.relative_permittivity_at_high_low_frequency = (permittivity_low, permittivity_high)
         try:
             material = self.__add_dielectric_material_model(name, material_model)
             for key, value in kwargs.items():

pyedb/grpc/database/definitions.py

@@ -34,12 +34,30 @@ class Definitions:
 
     @property
     def component(self) -> dict[str, ComponentDef]:
-        """Component definitions"""
+        """Component definitions
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> component_defs = edb.definitions.component
+        >>> for name, comp_def in component_defs.items():
+        ...     print(f"Component: {name}, Part: {comp_def.part}")
+        """
         return {l.name: ComponentDef(self._pedb, l) for l in self._pedb.active_db.component_defs}
 
     @property
     def package(self) -> dict[str, PackageDef]:
-        """Package definitions."""
+        """Package definitions.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> package_defs = edb.definitions.package
+        >>> for name, pkg_def in package_defs.items():
+        ...     print(f"Package: {name}, Boundary: {pkg_def.exterior_boundary}")
+        """
         return {l.name: PackageDef(self._pedb, l) for l in self._pedb.active_db.package_defs}
 
     def add_package_def(self, name, component_part_name=None, boundary_points=None) -> Union[PackageDef, bool]:
@@ -57,6 +75,22 @@ class Definitions:
         Returns
         -------
         PackageDef object.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+
+        Example 1: Create package using component's bounding box
+        >>> comp_def = edb.definitions.add_package_def("QFP64", "QFP64_COMPONENT")
+        >>> if comp_def:  # Check if created successfully
+        ...     print(f"Created package: {comp_def.name}")
+
+        Example 2: Create package with custom boundary
+        >>> boundary = [[0, 0], [10e-3, 0], [10e-3, 10e-3], [0, 10e-3]]
+        >>> custom_pkg = edb.definitions.add_package_def("CustomIC", boundary_points=boundary)
+        >>> if custom_pkg:
+        ...     print(f"Custom package boundary: {custom_pkg.exterior_boundary}")
         """
         if not name in self.package:
             package_def = PackageDef.create(self._pedb.active_db, name=name)

pyedb/grpc/database/hfss.py

@@ -200,6 +200,12 @@ class Hfss(object):
         -------
         dict
             Dictionary mapping net names to smallest trace widths.
+
+        Examples
+        --------
+        >>> widths = edb.hfss.get_trace_width_for_traces_with_ports()
+        >>> for net_name, width in widths.items():
+        ...     print(f"Net '{net_name}': Smallest width = {width}")
         """
         nets = {}
         for net in self._pedb.excitations_nets:
@@ -925,6 +931,15 @@ class Hfss(object):
         -------
         list
             [min_x, min_y, max_x, max_y] coordinates.
+
+        Examples
+        --------
+        >>> bbox = edb.hfss.get_layout_bounding_box()
+        >>> print(f"Layout Bounding Box: {bbox}")
+        >>>
+        >>> # With custom parameters
+        >>> custom_layout = edb.layouts["MyLayout"]
+        >>> bbox = edb.hfss.get_layout_bounding_box(custom_layout, 5)
         """
         if not layout:
             layout = self._active_layout

pyedb/grpc/database/hierarchy/component.py

@@ -132,7 +132,7 @@ class Component(GrpcComponentGroup):
         self.enabled = value
 
     @property
-    def ic_die_properties(self) -> ICDieProperty:
+    def ic_die_properties(self) -> any:
         """IC Die property.
 
         returns
@@ -877,12 +877,20 @@ class Component(GrpcComponentGroup):
     def numpins(self) -> int:
         """Number of Pins of Component.
 
+        ..deprecated:: 0.51.0
+           Use: func:`num_pins` instead.
         Returns
         -------
         int
             Component pins number.
         """
-        return self.num_pins
+
+        warnings.warn("Use num_pins instead.", DeprecationWarning)
+        try:
+            return self.num_pins
+        except Exception as e:
+            self._pedb.logger.error(f"{e}")
+            return 0
 
     @property
     def partname(self) -> str:

pyedb/grpc/database/hierarchy/pin_pair_model.py

@@ -27,7 +27,7 @@ from ansys.edb.core.utility.value import Value as GrpcValue
 
 
 class PinPairModel(GrpcPinPairModel):
-    """Manage pin pair model."""
+    """Manage pin-pair model."""
 
     def __init__(self, pedb, edb_object):
         self._pedb_comp = pedb

pyedb/grpc/database/layout_validation.py

@@ -55,10 +55,12 @@ class LayoutValidation:
 
         Examples
         --------
-
         >>> edb = Edb("edb_file")
-        >>> dc_shorts = edb.layout_validation.dc_shorts()
-
+        >>> # Find shorts without fixing
+        >>> shorts = edb.layout_validation.dc_shorts()
+        >>>
+        >>> # Find and fix shorts on specific nets
+        >>> fixed_shorts = edb.layout_validation.dc_shorts(net_list=["GND", "VCC"], fix=True)
         """
         if not net_list:
             net_list = list(self._pedb.nets.nets.keys())
@@ -154,8 +156,17 @@ class LayoutValidation:
 
         Examples
         --------
-
-        >>> renamed_nets = edb.layout_validation.disjoint_nets(["GND","Net2"])
+        >>> edb = Edb("edb_file")
+        >>> # Find disjoint nets on all nets
+        >>> new_nets = edb.layout_validation.disjoint_nets()
+        >>>
+        >>> # Clean disjoints on specific nets with advanced options
+        >>> cleaned = edb.layout_validation.disjoint_nets(
+        ...     net_list=["GND"],
+        ...     keep_only_main_net=True,
+        ...     clean_disjoints_less_than=1e-6,
+        ...     order_by_area=True
+        ... ))
         """
         timer_start = self._pedb.logger.reset_timer()
 
@@ -274,6 +285,15 @@ class LayoutValidation:
         Returns
         -------
         bool
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Fix self-intersections on all nets
+        >>> edb.layout_validation.fix_self_intersections()
+        >>>
+        >>> # Fix self-intersections on specific nets
+        >>> edb.layout_validation.fix_self_intersections(net_list=["RF_line"])
         """
         if not net_list:
             net_list = list(self._pedb.nets.nets.keys())
@@ -290,7 +310,17 @@ class LayoutValidation:
         return True
 
     def illegal_net_names(self, fix=False):
-        """Find and fix illegal net names."""
+        """Find and fix illegal net names.
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Identify illegal net names
+        >>> edb.layout_validation.illegal_net_names()
+        >>>
+        >>> # Find and automatically fix illegal names
+        >>> edb.layout_validation.illegal_net_names(fix=True)
+        """
         pattern = r"[\(\)\\\/:;*?<>\'\"|`~$]"
 
         nets = self._pedb.nets.nets
@@ -307,7 +337,17 @@ class LayoutValidation:
         return
 
     def illegal_rlc_values(self, fix=False) -> list[str]:
-        """Find and fix RLC illegal values."""
+        """Find and fix RLC illegal values.
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Identify components with illegal RLC values
+        >>> bad_components = edb.layout_validation.illegal_rlc_values()
+        >>>
+        >>> # Automatically fix invalid inductor values
+        >>> edb.layout_validation.illegal_rlc_values(fix=True)
+        """
         inductors = self._pedb.components.inductors
 
         temp = []
@@ -321,6 +361,17 @@ class LayoutValidation:
         return temp
 
     def padstacks_no_name(self, fix=False):
+        """Identify and fix padstacks without names.
+
+        Examples
+        --------
+        >>> edb = Edb("edb_file")
+        >>> # Report unnamed padstacks
+        >>> edb.layout_validation.padstacks_no_name()
+        >>>
+        >>> # Automatically assign names to unnamed padstacks
+        >>> edb.layout_validation.padstacks_no_name(fix=True)
+        """
         pds = self._pedb.layout.padstack_instances
         counts = 0
         via_count = 1

pyedb/grpc/database/net/differential_pair.py

@@ -85,10 +85,11 @@ class DifferentialPairs:
         -------
         list
             A list containing identified differential pair names.
+
         Examples
         --------
         >>> from pyedb import Edb
-        >>> edbapp = Edb("myaedbfolder", edbversion="2023.1")
+        >>> edbapp = Edb("myaedbfolder", edbversion="2025.2")
         >>> edb_nets = edbapp.differential_pairs.auto_identify()
         """
         nets = self._pedb.nets.nets