pyedb 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

pyedb/dotnet/edb.py

@@ -92,6 +92,7 @@ from pyedb.dotnet.database.utilities.siwave_simulation_setup import (
     SiwaveDCSimulationSetup,
     SiwaveSimulationSetup,
 )
+from pyedb.dotnet.database.utilities.value import Value
 from pyedb.edb_logger import pyedb_logger
 from pyedb.generic.constants import AEDT_UNITS, SolverType, unit_converter
 from pyedb.generic.general_methods import (
@@ -400,6 +401,13 @@ class Edb(Database):
     def pedb_class(self):
         return pyedb.dotnet
 
+    def value(self, val):
+        """Convert a value into a pyedb value."""
+        if isinstance(val, self._edb.Utility.Value):
+            return Value(self, val)
+        else:
+            return Value(self, self.core.utility.value(val))
+
     @property
     def grpc(self):
         """grpc flag."""
@@ -620,9 +628,7 @@ class Edb(Database):
             return None
         if not self.cellname:
             self.cellname = generate_unique_name("Cell")
-        self._active_cell = self.edb_api.cell.create(
-            self.active_db, self.edb_api.cell.CellType.CircuitCell, self.cellname
-        )
+        self._active_cell = self.core.cell.create(self.active_db, self.core.cell.CellType.CircuitCell, self.cellname)
         if self._active_cell:
             self._init_objects()
             return True
@@ -1366,7 +1372,7 @@ class Edb(Database):
         Instance of `Edb.Utility.Value`
 
         """
-        return self.edb_api.utility.value(val)
+        return self.core.utility.value(val)
 
     def point_3d(self, x, y, z=0.0):
         """Compute the Edb 3d Point Data.
@@ -1384,7 +1390,7 @@ class Edb(Database):
         -------
         ``Geometry.Point3DData``.
         """
-        return self.edb_api.geometry.point3d_data(x, y, z)
+        return self.core.geometry.point3d_data(x, y, z)
 
     def point_data(self, x, y=None):
         """Compute the Edb Point Data.
@@ -1402,9 +1408,9 @@ class Edb(Database):
         ``Geometry.PointData``.
         """
         if y is None:
-            return self.edb_api.geometry.point_data(x)
+            return self.core.geometry.point_data(x)
         else:
-            return self.edb_api.geometry.point_data(x, y)
+            return self.core.geometry.point_data(x, y)
 
     def _is_file_existing_and_released(self, filename):
         if os.path.exists(filename):
@@ -1468,7 +1474,7 @@ class Edb(Database):
         warnings.warn("Use new property :func:`close` instead.", DeprecationWarning)
         return self.close()
 
-    def close(self):
+    def close(self, **kwargs):
         """Close EDB and cleanup variables.
 
         Returns
@@ -1589,7 +1595,7 @@ class Edb(Database):
             ``True`` when successful, ``False`` when failed.
 
         """
-        return self.edb_api.utility.utility.Command.Execute(func)
+        return self.core.utility.utility.Command.Execute(func)
 
     def import_cadence_file(self, inputBrd, WorkDir=None, anstranslator_full_path="", use_ppe=False):
         """Import a board file and generate an ``edb.def`` file in the working directory.
@@ -1638,7 +1644,7 @@ class Edb(Database):
     ):
         if extent_type in [
             "Conforming",
-            self.edb_api.geometry.extent_type.Conforming,
+            self.core.geometry.extent_type.Conforming,
             1,
         ]:
             if use_pyaedt_extent:
@@ -1656,7 +1662,7 @@ class Edb(Database):
             else:
                 _poly = self.layout.expanded_extent(
                     net_signals,
-                    self.edb_api.geometry.extent_type.Conforming,
+                    self.core.geometry.extent_type.Conforming,
                     expansion_size,
                     False,
                     use_round_corner,
@@ -1664,12 +1670,12 @@ class Edb(Database):
                 )
         elif extent_type in [
             "Bounding",
-            self.edb_api.geometry.extent_type.BoundingBox,
+            self.core.geometry.extent_type.BoundingBox,
             0,
         ]:
             _poly = self.layout.expanded_extent(
                 net_signals,
-                self.edb_api.geometry.extent_type.BoundingBox,
+                self.core.geometry.extent_type.BoundingBox,
                 expansion_size,
                 False,
                 use_round_corner,
@@ -1690,14 +1696,14 @@ class Edb(Database):
             else:
                 _poly = self.layout.expanded_extent(
                     net_signals,
-                    self.edb_api.geometry.extent_type.Conforming,
+                    self.core.geometry.extent_type.Conforming,
                     expansion_size,
                     False,
                     use_round_corner,
                     1,
                 )
                 _poly_list = convert_py_list_to_net_list([_poly])
-                _poly = self.edb_api.geometry.polygon_data.get_convex_hull_of_polygons(_poly_list)
+                _poly = self.core.geometry.polygon_data.get_convex_hull_of_polygons(_poly_list)
         return _poly
 
     def _create_conformal(
@@ -1772,7 +1778,7 @@ class Edb(Database):
                             pass
                         finally:
                             unite_polys.extend(list(obj_data))
-            _poly_unite = self.edb_api.geometry.polygon_data.unite(unite_polys)
+            _poly_unite = self.core.geometry.polygon_data.unite(unite_polys)
             if len(_poly_unite) == 1:
                 self.logger.info("Correctly computed Extension at first iteration.")
                 return _poly_unite[0]
@@ -1797,20 +1803,20 @@ class Edb(Database):
                 pd = term._edb_object.GetParameters()[1]
                 locations.append([pd.X.ToDouble(), pd.Y.ToDouble()])
         for point in locations:
-            pointA = self.edb_api.geometry.point_data(
+            pointA = self.core.geometry.point_data(
                 self.edb_value(point[0] - expansion_size),
                 self.edb_value(point[1] - expansion_size),
             )
-            pointB = self.edb_api.geometry.point_data(
+            pointB = self.core.geometry.point_data(
                 self.edb_value(point[0] + expansion_size),
                 self.edb_value(point[1] + expansion_size),
             )
 
             points = Tuple[
-                self.edb_api.geometry.geometry.PointData,
-                self.edb_api.geometry.geometry.PointData,
+                self.core.geometry.geometry.PointData,
+                self.core.geometry.geometry.PointData,
             ](pointA, pointB)
-            _polys.append(self.edb_api.geometry.polygon_data.create_from_bbox(points))
+            _polys.append(self.core.geometry.polygon_data.create_from_bbox(points))
         return _polys
 
     def _create_convex_hull(
@@ -1843,7 +1849,7 @@ class Edb(Database):
         if smart_cut:
             objs_data = self._smart_cut(reference_list, expansion_size)
             _polys.extend(objs_data)
-        _poly = self.edb_api.geometry.polygon_data.get_convex_hull_of_polygons(convert_py_list_to_net_list(_polys))
+        _poly = self.core.geometry.polygon_data.get_convex_hull_of_polygons(convert_py_list_to_net_list(_polys))
         _poly = _poly.Expand(expansion_size, tolerance, round_corner, round_extension)[0]
         return _poly
 
@@ -1978,8 +1984,8 @@ class Edb(Database):
         >>> edb.logger.info("Total legacy cutout time in min %s", end_time)
         >>> edb.nets.plot(signal_list, None, color_by_net=True)
         >>> edb.nets.plot(power_list, None, color_by_net=True)
-        >>> edb.save_edb()
-        >>> edb.close_edb()
+        >>> edb.save()
+        >>> edb.close()
 
 
         """
@@ -2051,12 +2057,12 @@ class Edb(Database):
                     )
                     if self.are_port_reference_terminals_connected():
                         if output_aedb_path:
-                            self.save_edb_as(output_aedb_path)
+                            self.save_as(output_aedb_path)
                         else:
-                            self.save_edb_as(legacy_path)
+                            self.save_as(legacy_path)
                         working_cutout = True
                         break
-                    self.close_edb()
+                    self.close()
                     self.edbpath = legacy_path
                     self.open_edb()
                     i += 1
@@ -2091,8 +2097,8 @@ class Edb(Database):
                     inlcude_voids_in_extents=include_voids_in_extents,
                 )
             if result and not open_cutout_at_end and self.edbpath != legacy_path:
-                self.save_edb()
-                self.close_edb()
+                self.save()
+                self.close()
                 self.edbpath = legacy_path
                 self.open_edb()
             return result
@@ -2416,7 +2422,7 @@ class Edb(Database):
                 pins_to_preserve=pins_to_preserve,
                 inlcude_voids_in_extents=inlcude_voids_in_extents,
             )
-            if extent_type in ["Conforming", self.edb_api.geometry.extent_type.Conforming, 1]:
+            if extent_type in ["Conforming", self.core.geometry.extent_type.Conforming, 1]:
                 if extent_defeature > 0:
                     _poly = _poly.Defeature(extent_defeature)
                 _poly1 = _poly.CreateFromArcs(_poly.GetArcData(), True)
@@ -2681,14 +2687,10 @@ class Edb(Database):
             via.pin.Delete()
         if netlist:
             nets = [net.net_obj for net in temp_edb.layout.nets if net.name in netlist]
-            _poly = temp_edb.layout.expanded_extent(
-                nets, self.edb_api.geometry.extent_type.Conforming, 0.0, True, True, 1
-            )
+            _poly = temp_edb.layout.expanded_extent(nets, self.core.geometry.extent_type.Conforming, 0.0, True, True, 1)
         else:
             nets = [net.api_object for net in temp_edb.layout.nets if "gnd" in net.name.lower()]
-            _poly = temp_edb.layout.expanded_extent(
-                nets, self.edb_api.geometry.extent_type.Conforming, 0.0, True, True, 1
-            )
+            _poly = temp_edb.layout.expanded_extent(nets, self.core.geometry.extent_type.Conforming, 0.0, True, True, 1)
             temp_edb.close_edb()
         if _poly:
             return _poly
@@ -2789,9 +2791,7 @@ class Edb(Database):
             p_missing = [i for i in pinstance_to_add if i.id not in ids]
             self.logger.info("Added {} padstack instances after cutout".format(len(p_missing)))
             for p in p_missing:
-                position = self.edb_api.geometry.point_data(
-                    self.edb_value(p.position[0]), self.edb_value(p.position[1])
-                )
+                position = self.core.geometry.point_data(self.edb_value(p.position[0]), self.edb_value(p.position[1]))
                 net = self.nets.find_or_create_net(p.net_name)
                 rotation = self.edb_value(p.rotation)
                 sign_layers = list(self.stackup.signal_layers.keys())
@@ -2808,7 +2808,7 @@ class Edb(Database):
                 for pad in list(self.padstacks.definitions.keys()):
                     if pad == p.padstack_definition:
                         padstack = self.padstacks.definitions[pad].edb_padstack
-                        padstack_instance = self.edb_api.cell.primitive.padstack_instance.create(
+                        padstack_instance = self.core.cell.primitive.padstack_instance.create(
                             _cutout.GetLayout(),
                             net,
                             p.name,
@@ -2831,7 +2831,7 @@ class Edb(Database):
                     center_y,
                     radius,
                 ) = void_circle.primitive_object.GetParameters(0.0, 0.0, 0.0)
-                cloned_circle = self.edb_api.cell.primitive.circle.create(
+                cloned_circle = self.core.cell.primitive.circle.create(
                     layout,
                     void_circle.layer_name,
                     void_circle.net,
@@ -2841,7 +2841,7 @@ class Edb(Database):
                 )
                 cloned_circle.SetIsNegative(True)
             elif void_circle.type == "Polygon":
-                cloned_polygon = self.edb_api.cell.primitive.polygon.create(
+                cloned_polygon = self.core.cell.primitive.polygon.create(
                     layout,
                     void_circle.layer_name,
                     void_circle.net,
@@ -3458,7 +3458,7 @@ class Edb(Database):
                     self.logger.info("Cutout processed.")
                     old_cell = self.active_cell.FindByName(
                         self.db,
-                        self.edb_api.cell.CellType.CircuitCell,
+                        self.core.cell.CellType.CircuitCell,
                         old_cell_name,
                     )
                     if old_cell:

pyedb/generic/design_types.py

@@ -23,6 +23,7 @@ from typing import TYPE_CHECKING, Literal, Union, overload
 import warnings
 
 from pyedb.generic.grpc_warnings import GRPC_GENERAL_WARNING
+from pyedb.misc.misc import list_installed_ansysem
 
 if TYPE_CHECKING:
     from pyedb.dotnet.edb import Edb as EdbDotnet
@@ -257,13 +258,21 @@ def Edb(
 
     """
 
+    if not edbversion:  # pragma: no cover
+        try:
+            version = "20{}.{}".format(list_installed_ansysem()[0][-3:-1], list_installed_ansysem()[0][-1:])
+        except IndexError:
+            raise Exception("No ANSYSEM_ROOTxxx is found.")
+    else:
+        version = edbversion
+
     # Use EDB legacy (default choice)
-    if float(edbversion) >= 2025.2:
+    if float(version) >= 2025.2:
         if not grpc:
             warnings.warn(GRPC_GENERAL_WARNING, UserWarning)
     else:
         if grpc:
-            raise ValueError(f"gRPC flag was enabled however your ANSYS AEDT version {edbversion} is not compatible")
+            raise ValueError(f"gRPC flag was enabled however your ANSYS AEDT version {version} is not compatible")
     if grpc:
         from pyedb.grpc.edb import Edb as app
     else:
@@ -272,7 +281,7 @@ def Edb(
         edbpath=edbpath,
         cellname=cellname,
         isreadonly=isreadonly,
-        edbversion=edbversion,
+        edbversion=version,
         isaedtowned=isaedtowned,
         oproject=oproject,
         student_version=student_version,

pyedb/grpc/database/components.py

@@ -39,7 +39,6 @@ from ansys.edb.core.definition.solder_ball_property import (
 from ansys.edb.core.hierarchy.component_group import ComponentType as GrpcComponentType
 from ansys.edb.core.hierarchy.spice_model import SPICEModel as GrpcSPICEModel
 from ansys.edb.core.utility.rlc import Rlc as GrpcRlc
-from ansys.edb.core.utility.value import Value as GrpcValue
 
 from pyedb.component_libraries.ansys_components import (
     ComponentLib,
@@ -57,6 +56,7 @@ from pyedb.grpc.database.hierarchy.pin_pair_model import PinPairModel
 from pyedb.grpc.database.hierarchy.pingroup import PinGroup
 from pyedb.grpc.database.padstacks import Padstacks
 from pyedb.grpc.database.utility.sources import SourceType
+from pyedb.grpc.database.utility.value import Value
 from pyedb.modeler.geometry_operators import GeometryOperators
 
 
@@ -1098,17 +1098,17 @@ class Components(object):
                 rlc.r_enabled = False
             else:
                 rlc.r_enabled = True
-                rlc.r = GrpcValue(r_value)
+                rlc.r = Value(r_value)
             if l_value is None:
                 rlc.l_enabled = False
             else:
                 rlc.l_enabled = True
-                rlc.l = GrpcValue(l_value)
+                rlc.l = Value(l_value)
             if c_value is None:
                 rlc.c_enabled = False
             else:
                 rlc.c_enabled = True
-                rlc.C = GrpcValue(c_value)
+                rlc.C = Value(c_value)
             if rlc.r_enabled and not rlc.c_enabled and not rlc.l_enabled:
                 new_cmp.component_type = GrpcComponentType.RESISTOR
             elif rlc.c_enabled and not rlc.r_enabled and not rlc.l_enabled:
@@ -1434,12 +1434,12 @@ class Components(object):
             pin1 = list(cmp.pins.values())[0]
             pin_layers = pin1.padstack_def.data.layer_names
             pad_params = self._pedb.padstacks.get_pad_parameters(pin=pin1, layername=pin_layers[0], pad_type=0)
-            _sb_diam = min([abs(GrpcValue(val).value) for val in pad_params[1]])
+            _sb_diam = min([abs(Value(val)) for val in pad_params[1]])
             sball_diam = 0.8 * _sb_diam
         if sball_height:
-            sball_height = round(GrpcValue(sball_height).value, 9)
+            sball_height = Value(sball_height)
         else:
-            sball_height = round(GrpcValue(sball_diam).value, 9) / 2
+            sball_height = Value(sball_diam)
 
         if not sball_mid_diam:
             sball_mid_diam = sball_diam
@@ -1460,17 +1460,17 @@ class Components(object):
             cmp_property.die_property = ic_die_prop
 
         solder_ball_prop = cmp_property.solder_ball_property
-        solder_ball_prop.set_diameter(GrpcValue(sball_diam), GrpcValue(sball_mid_diam))
-        solder_ball_prop.height = GrpcValue(sball_height)
+        solder_ball_prop.set_diameter(Value(sball_diam), Value(sball_mid_diam))
+        solder_ball_prop.height = Value(sball_height)
 
         solder_ball_prop.shape = sball_shape
         cmp_property.solder_ball_property = solder_ball_prop
 
         port_prop = cmp_property.port_property
-        port_prop.reference_height = GrpcValue(reference_height)
+        port_prop.reference_height = Value(reference_height)
         port_prop.reference_size_auto = auto_reference_size
         if not auto_reference_size:
-            port_prop.set_reference_size(GrpcValue(reference_size_x), GrpcValue(reference_size_y))
+            port_prop.set_reference_size(Value(reference_size_x), Value(reference_size_y))
         cmp_property.port_property = port_prop
         cmp.component_property = cmp_property
         return True
@@ -1520,17 +1520,17 @@ class Components(object):
             rlc.is_parallel = isparallel
             if res_value is not None:
                 rlc.r_enabled = True
-                rlc.r = GrpcValue(res_value)
+                rlc.r = Value(res_value)
             else:
                 rlc.r_enabled = False
             if ind_value is not None:
                 rlc.l_enabled = True
-                rlc.l = GrpcValue(ind_value)
+                rlc.l = Value(ind_value)
             else:
                 rlc.l_enabled = False
             if cap_value is not None:
                 rlc.c_enabled = True
-                rlc.c = GrpcValue(cap_value)
+                rlc.c = Value(cap_value)
             else:
                 rlc.CEnabled = False
             pin_pair = (from_pin.name, to_pin.name)
@@ -1838,7 +1838,7 @@ class Components(object):
             transformed_pt_pos = pt_pos
         else:
             transformed_pt_pos = pin.component.transform.transform_point(pt_pos)
-        return [transformed_pt_pos[0].value, transformed_pt_pos[1].value]
+        return [Value(transformed_pt_pos[0]), Value(transformed_pt_pos[1])]
 
     def get_pins_name_from_net(self, net_name: str, pin_list: Optional[List[Any]] = None) -> List[str]:
         """Get pin names from net.
@@ -2021,8 +2021,8 @@ class Components(object):
                 w = min(pars[0], w)
             elif pad.polygon_data:  # pragma: no cover
                 bbox = pad.polygon_data.bbox()
-                lower = [bbox[0].x.value, bbox[0].y.value]
-                upper = [bbox[1].x.value, bbox[1].y.value]
+                lower = [Value(bbox[0].x), Value(bbox[0].y)]
+                upper = [Value(bbox[1].x), Value(bbox[1].y)]
                 pars = [abs(lower[0] - upper[0]), abs(lower[1] - upper[1])]
                 delta_pins.append(max(pars) + min(pars) / 2)
                 w = min(min(pars), w)
@@ -2228,6 +2228,42 @@ class Components(object):
             component=component.refdes, circuit_ports=create_circuit_port, pec_boundary=pec_boundary
         )
 
+    def add_port_on_rlc_component(
+        self, component: Optional[Union[str, Component]] = None, circuit_ports: bool = True, pec_boundary: bool = False
+    ) -> bool:
+        """Deactivate RLC component and replace it with a circuit port.
+        The circuit port supports only two-pin components.
+
+        Parameters
+        ----------
+        component : str
+            Reference designator of the RLC component.
+
+        circuit_ports : bool
+            ``True`` will replace RLC component by circuit ports, ``False`` gap ports compatible with HFSS 3D modeler
+            export.
+
+        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 = Edb()
+        >>> edb.source_excitation.add_port_on_rlc_component("R1")
+        """
+        return self._pedb.source_excitation.add_port_on_rlc_component(
+            component=component, circuit_ports=circuit_ports, pec_boundary=pec_boundary
+        )
+
     def replace_rlc_by_gap_boundaries(self, component: Optional[Union[str, Component]] = None) -> bool:
         """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.