pyedb 0.42.0__py3-none-any.whl → 0.44.0__py3-none-any.whl

pyedb/grpc/database/primitive/primitive.py

@@ -22,7 +22,7 @@
 
 from ansys.edb.core.database import ProductIdType as GrpcProductIdType
 from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
-from ansys.edb.core.primitive.primitive import Circle as GrpcCircle
+from ansys.edb.core.primitive.circle import Circle as GrpcCircle
 from ansys.edb.core.primitive.primitive import Primitive as GrpcPrimitive
 
 from pyedb.misc.utilities import compute_arc_points

pyedb/grpc/database/primitive/rectangle.py

@@ -21,10 +21,10 @@
 # SOFTWARE.
 
 
-from ansys.edb.core.primitive.primitive import (
+from ansys.edb.core.primitive.rectangle import (
     RectangleRepresentationType as GrpcRectangleRepresentationType,
 )
-from ansys.edb.core.primitive.primitive import Rectangle as GrpcRectangle
+from ansys.edb.core.primitive.rectangle import Rectangle as GrpcRectangle
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 from pyedb.grpc.database.primitive.primitive import Primitive

pyedb/grpc/database/simulation_setup/hfss_simulation_setup.py

@@ -293,7 +293,14 @@ class HfssSimulationSetup(GrpcHfssSimulationSetup):
         return mesh_operation
 
     def add_sweep(
-        self, name=None, distribution="linear", start_freq="0GHz", stop_freq="20GHz", step="10MHz", discrete=False
+        self,
+        name=None,
+        distribution="linear",
+        start_freq="0GHz",
+        stop_freq="20GHz",
+        step="10MHz",
+        discrete=False,
+        frequency_set=None,
     ):
         """Add a HFSS frequency sweep.
 
@@ -317,39 +324,75 @@ class HfssSimulationSetup(GrpcHfssSimulationSetup):
             distribution. Must be integer in that case.
         discrete : bool, optional
             Whether the sweep is discrete. The default is ``False``.
+        frequency_set : List, optional
+            Frequency set is a list adding one or more frequency sweeps. If ``frequency_set`` is provided, the other
+            arguments are ignored except ``discrete``. Default value is ``None``.
+            example of frequency_set : [['linear_scale', '50MHz', '200MHz', '10MHz']].
 
         Returns
         -------
         bool
         """
         init_sweep_count = len(self.sweep_data)
-        start_freq = self._pedb.number_with_units(start_freq, "Hz")
-        stop_freq = self._pedb.number_with_units(stop_freq, "Hz")
-        step = str(step)
-        if distribution.lower() == "linear":
-            distribution = "LIN"
-        elif distribution.lower() == "linear_count":
-            distribution = "LINC"
-        elif distribution.lower() == "exponential":
-            distribution = "ESTP"
-        elif distribution.lower() == "decade_count":
-            distribution = "DEC"
-        elif distribution.lower() == "octave_count":
-            distribution = "OCT"
+        if frequency_set:
+            for sweep in frequency_set:
+                if "linear_scale" in sweep:
+                    distribution = "LIN"
+                elif "linear_count" in sweep:
+                    distribution = "LINC"
+                elif "exponential" in sweep:
+                    distribution = "ESTP"
+                elif "log_scale" in sweep:
+                    distribution = "DEC"
+                elif "octave_count" in sweep:
+                    distribution = "OCT"
+                else:
+                    distribution = "LIN"
+                start_freq = self._pedb.number_with_units(sweep[1], "Hz")
+                stop_freq = self._pedb.number_with_units(sweep[2], "Hz")
+                step = str(sweep[3])
+                if not name:
+                    name = f"sweep_{init_sweep_count + 1}"
+                sweep_data = [
+                    SweepData(
+                        self._pedb, name=name, distribution=distribution, start_f=start_freq, end_f=stop_freq, step=step
+                    )
+                ]
+                if discrete:
+                    sweep_data[0].type = sweep_data[0].type.DISCRETE_SWEEP
+                for sweep in self.sweep_data:
+                    sweep_data.append(sweep)
+                self.sweep_data = sweep_data
         else:
-            distribution = "LIN"
-        if not name:
-            name = f"sweep_{init_sweep_count + 1}"
-        sweep_data = [
-            SweepData(self._pedb, name=name, distribution=distribution, start_f=start_freq, end_f=stop_freq, step=step)
-        ]
-        if discrete:
-            sweep_data[0].type = sweep_data[0].type.DISCRETE_SWEEP
-        for sweep in self.sweep_data:
-            sweep_data.append(sweep)
-        self.sweep_data = sweep_data
-        if len(self.sweep_data) == init_sweep_count + 1:
-            return True
-        else:
-            self._pedb.logger.error("Failed to add frequency sweep data")
-            return False
+            start_freq = self._pedb.number_with_units(start_freq, "Hz")
+            stop_freq = self._pedb.number_with_units(stop_freq, "Hz")
+            step = str(step)
+            if distribution.lower() == "linear":
+                distribution = "LIN"
+            elif distribution.lower() == "linear_count":
+                distribution = "LINC"
+            elif distribution.lower() == "exponential":
+                distribution = "ESTP"
+            elif distribution.lower() == "decade_count":
+                distribution = "DEC"
+            elif distribution.lower() == "octave_count":
+                distribution = "OCT"
+            else:
+                distribution = "LIN"
+            if not name:
+                name = f"sweep_{init_sweep_count + 1}"
+            sweep_data = [
+                SweepData(
+                    self._pedb, name=name, distribution=distribution, start_f=start_freq, end_f=stop_freq, step=step
+                )
+            ]
+            if discrete:
+                sweep_data[0].type = sweep_data[0].type.DISCRETE_SWEEP
+            for sweep in self.sweep_data:
+                sweep_data.append(sweep)
+            self.sweep_data = sweep_data
+            if len(self.sweep_data) == init_sweep_count + 1:
+                return True
+            else:
+                self._pedb.logger.error("Failed to add frequency sweep data")
+                return False

pyedb/grpc/database/source_excitations.py

@@ -20,14 +20,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from typing import Union
+from typing import List, Set, Union
 
 from ansys.edb.core.database import ProductIdType as GrpcProductIdType
 from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
 from ansys.edb.core.geometry.polygon_data import PolygonData as GrpcPolygonData
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
-from ansys.edb.core.terminal.terminals import EdgeTerminal as GrpcEdgeTerminal
-from ansys.edb.core.terminal.terminals import PrimitiveEdge as GrpcPrimitiveEdge
+from ansys.edb.core.terminal.edge_terminal import EdgeTerminal as GrpcEdgeTerminal
+from ansys.edb.core.terminal.edge_terminal import PrimitiveEdge as GrpcPrimitiveEdge
+from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 from ansys.edb.core.utility.rlc import Rlc as GrpcRlc
 from ansys.edb.core.utility.value import Value as GrpcValue
 
@@ -267,8 +267,8 @@ class SourceExcitation:
         return term or False
 
     def _get_pins_for_ports(
-        self, pins: Union[int, str, PadstackInstance, list[Union[int, str, PadstackInstance]]], comp: Component
-    ) -> list[PadstackInstance]:
+        self, pins: Union[int, str, PadstackInstance, List[Union[int, str, PadstackInstance]]], comp: Component
+    ) -> List[PadstackInstance]:
         if not isinstance(pins, list):
             pins = [pins]
         result = []
@@ -506,7 +506,7 @@ class SourceExcitation:
         return True
 
     @staticmethod
-    def _normalize_net_list(net_list) -> set[str]:
+    def _normalize_net_list(net_list) -> Set[str]:
         if not isinstance(net_list, list):
             net_list = [net_list]
         nets = set()

pyedb/grpc/database/stackup.py

@@ -170,11 +170,19 @@ class LayerCollection(GrpcLayerCollection):
         if "thickness" in kwargs:
             thickness = GrpcValue(kwargs["thickness"])
         elevation = GrpcValue(0.0)
-        _layer_type = GrpcLayerType.SIGNAL_LAYER
-        if layer_type.lower() == "dielectric":
-            _layer_type = GrpcLayerType.DIELECTRIC_LAYER
+        if "type" in kwargs:
+            _l_map = {"signal": GrpcLayerType.SIGNAL_LAYER, "dielectric": GrpcLayerType.DIELECTRIC_LAYER}
+            _layer_type = _l_map[kwargs["type"]]
+        else:
+            _layer_type = GrpcLayerType.SIGNAL_LAYER
+            if layer_type.lower() == "dielectric":
+                _layer_type = GrpcLayerType.DIELECTRIC_LAYER
+        if "material" in kwargs:
+            material = kwargs["material"]
+        else:
+            material = "copper"
         layer = GrpcStackupLayer.create(
-            name=name, layer_type=_layer_type, thickness=thickness, material="copper", elevation=elevation
+            name=name, layer_type=_layer_type, thickness=thickness, material=material, elevation=elevation
         )
         return self._layer_collection.add_layer_below(layer, base_layer_name)
 
@@ -695,8 +703,8 @@ class Stackup(LayerCollection):
 
         """
         new_layer_collection = LayerCollection.create()
-        for lyr in self.layers:
-            if not (lyr.name == name):
+        for layer_name, lyr in self.layers.items():
+            if not (layer_name == name):
                 new_layer_collection.add_layer_bottom(lyr)
 
         self._pedb.layout.layer_collection = new_layer_collection

pyedb/grpc/database/terminal/bundle_terminal.py

@@ -20,11 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from ansys.edb.core.terminal.terminals import (
+from ansys.edb.core.terminal.bundle_terminal import BundleTerminal as GrpcBundleTerminal
+from ansys.edb.core.terminal.terminal import (
     SourceTermToGroundType as GrpcSourceTermToGroundType,
 )
-from ansys.edb.core.terminal.terminals import BundleTerminal as GrpcBundleTerminal
-from ansys.edb.core.terminal.terminals import HfssPIType as GrpcHfssPIType
+from ansys.edb.core.terminal.terminal import HfssPIType as GrpcHfssPIType
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 from pyedb.grpc.database.hierarchy.component import Component

pyedb/grpc/database/terminal/edge_terminal.py

@@ -20,8 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from ansys.edb.core.terminal.terminals import BundleTerminal as GrpcBundleTerminal
-from ansys.edb.core.terminal.terminals import EdgeTerminal as GrpcEdgeTerminal
+from ansys.edb.core.terminal.bundle_terminal import BundleTerminal as GrpcBundleTerminal
+from ansys.edb.core.terminal.edge_terminal import EdgeTerminal as GrpcEdgeTerminal
 
 
 class EdgeTerminal(GrpcEdgeTerminal):

pyedb/grpc/database/terminal/padstack_instance_terminal.py

@@ -20,10 +20,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from ansys.edb.core.terminal.terminals import (
+from ansys.edb.core.terminal.padstack_instance_terminal import (
     PadstackInstanceTerminal as GrpcPadstackInstanceTerminal,
 )
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
+from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
+
+from pyedb.misc.misc import deprecated_property
 
 
 class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
@@ -45,6 +47,18 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         pos_x, pos_y, rotation = self.padstack_instance.get_position_and_rotation()
         return [pos_x.value, pos_y.value]
 
+    @property
+    def padstack_instance(self):
+        from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
+
+        return PadstackInstance(self._pedb, super().padstack_instance)
+
+    @property
+    def component(self):
+        from pyedb.grpc.database.hierarchy.component import Component
+
+        return Component(self._pedb, super().component)
+
     @property
     def location(self):
         """Terminal position.
@@ -169,3 +183,29 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
             "pec": GrpcBoundaryType.PEC,
         }
         super(PadstackInstanceTerminal, self.__class__).boundary_type.__set__(self, mapping[value.name.lower()])
+
+    @property
+    def is_port(self):
+        if self.boundary_type == "port":
+            return True
+        return False
+
+    @property
+    @deprecated_property
+    def ref_terminal(self):
+        """Return reference terminal.
+
+        ..deprecated:: 0.43.0
+           Use: func:`reference_terminal` property instead.
+        """
+        self._pedb.logger.warning("ref_terminal property is deprecated, use reference_terminal property instead.")
+        return self.reference_terminal
+
+    @ref_terminal.setter
+    def ref_terminal(self, value):
+        if isinstance(value, PadstackInstanceTerminal):
+            self.reference_terminal = value
+
+    @property
+    def terminal_type(self):
+        return "PadstackInstanceTerminal"

pyedb/grpc/database/terminal/pingroup_terminal.py

@@ -20,10 +20,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
-from ansys.edb.core.terminal.terminals import PinGroupTerminal as GrpcPinGroupTerminal
+from ansys.edb.core.terminal.pin_group_terminal import (
+    PinGroupTerminal as GrpcPinGroupTerminal,
+)
+from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 
 from pyedb.grpc.database.net.net import Net
+from pyedb.misc.misc import deprecated_property
 
 
 class PinGroupTerminal(GrpcPinGroupTerminal):
@@ -56,6 +59,12 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
             value = GrpcBoundaryType.VOLTAGE_PROBE
         super(PinGroupTerminal, self.__class__).boundary_type.__set__(self, value)
 
+    @property
+    def is_port(self):
+        if self.boundary_type == "port":
+            return True
+        return False
+
     @property
     def magnitude(self):
         """Source magnitude.
@@ -160,3 +169,27 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         from pyedb.grpc.database.hierarchy.pingroup import PinGroup
 
         return PinGroup(self._pedb, super().pin_group)
+
+    @property
+    def terminal_type(self):
+        return "PinGroupTerminal"
+
+    @property
+    @deprecated_property
+    def ref_terminal(self):
+        """Property keeping DotNet compatibility
+
+        ..deprecated:: 0.43.0
+           Use: func:`reference_terminal` property instead.
+
+        """
+        self._pedb.logger.warning("ref_terminal property is deprecated, use reference_terminal property instead.")
+        return self.reference_terminal
+
+    @ref_terminal.setter
+    def ref_terminal(self, value):
+        self.reference_terminal = value
+
+    @property
+    def hfss_type(self):
+        return "circuit"

pyedb/grpc/database/terminal/point_terminal.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
-from ansys.edb.core.terminal.terminals import PointTerminal as GrpcPointTerminal
+from ansys.edb.core.terminal.point_terminal import PointTerminal as GrpcPointTerminal
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 
@@ -97,3 +97,12 @@ class PointTerminal(GrpcPointTerminal):
     @reference_terminal.setter
     def reference_terminal(self, value):
         super(PointTerminal, self.__class__).reference_terminal.__set__(self, value)
+
+    @property
+    def terminal_type(self):
+        return "PointTerminal"
+
+    @property
+    def is_port(self):
+        """Adding DotNet compatibility."""
+        return True

pyedb/grpc/database/terminal/terminal.py

@@ -22,10 +22,10 @@
 
 import re
 
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
-from ansys.edb.core.terminal.terminals import EdgeType as GrpcEdgeType
-from ansys.edb.core.terminal.terminals import Terminal as GrpcTerminal
-from ansys.edb.core.terminal.terminals import TerminalType as GrpcTerminalType
+from ansys.edb.core.terminal.edge_terminal import EdgeType as GrpcEdgeType
+from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
+from ansys.edb.core.terminal.terminal import Terminal as GrpcTerminal
+from ansys.edb.core.terminal.terminal import TerminalType as GrpcTerminalType
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance

pyedb/grpc/database/utility/hfss_extent_info.py

@@ -20,7 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from ansys.edb.core.utility.hfss_extent_info import (
+    HFSSExtentInfoType as GrpcHfssExtentInfoType,
+)
 from ansys.edb.core.utility.hfss_extent_info import HfssExtentInfo as GrpcHfssExtentInfo
+from ansys.edb.core.utility.hfss_extent_info import OpenRegionType as GrpcOpenRegionType
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 
@@ -37,14 +41,14 @@ class HfssExtentInfo(GrpcHfssExtentInfo):
         self._pedb = pedb
         super().__init__()
         self.extent_type_mapping = {
-            "bounding_box": GrpcHfssExtentInfo.HFSSExtentInfoType.BOUNDING_BOX,
-            "conforming": GrpcHfssExtentInfo.HFSSExtentInfoType.CONFORMING,
-            "convex_hull": GrpcHfssExtentInfo.HFSSExtentInfoType.CONVEX_HUL,
-            "polygon": GrpcHfssExtentInfo.HFSSExtentInfoType.POLYGON,
+            "bounding_box": GrpcHfssExtentInfoType.BOUNDING_BOX,
+            "conforming": GrpcHfssExtentInfoType.CONFORMING,
+            "convex_hull": GrpcHfssExtentInfoType.CONVEX_HUL,
+            "polygon": GrpcHfssExtentInfoType.POLYGON,
         }
         self._open_region_type = {
-            "radiation": GrpcHfssExtentInfo.OpenRegionType.RADIATION,
-            "pml": GrpcHfssExtentInfo.OpenRegionType.PML,
+            "radiation": GrpcOpenRegionType.RADIATION,
+            "pml": GrpcOpenRegionType.PML,
         }
         self.hfss_extent_type = self._hfss_extent_info.extent_type
 
@@ -258,13 +262,13 @@ class HfssExtentInfo(GrpcHfssExtentInfo):
         hfss_extent = self._hfss_extent_info
         if isinstance(value, str):
             if value.lower() == "bounding_box":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.BOUNDING_BOX
+                value = GrpcHfssExtentInfoType.BOUNDING_BOX
             elif value.lower() == "conforming":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.CONFORMING
+                value = GrpcHfssExtentInfoType.CONFORMING
             elif value.lower() == "convex_hul":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.CONVEX_HUL
+                value = GrpcHfssExtentInfoType.CONVEX_HUL
             elif value.lower() == "polygon":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.POLYGON
+                value = GrpcHfssExtentInfoType.POLYGON
             else:
                 raise f"Invalid extent type : {value}"
         hfss_extent.extent_type = value

pyedb/grpc/edb.py

@@ -1085,7 +1085,7 @@ class Edb(EdbInit):
         :class:`Circle <pyedb.grpc.database.primitive.circle.Circle>`,
         :class:`Polygon <pyedb.grpc.database.primitive.polygon.Polygon>`]
         """
-        from ansys.edb.core.terminal.terminals import (
+        from ansys.edb.core.terminal.padstack_instance_terminal import (
             PadstackInstanceTerminal as GrpcPadstackInstanceTerminal,
         )
 
@@ -2324,7 +2324,7 @@ class Edb(EdbInit):
             ids.append(lobj.id)
         if include_partial_instances:
             from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
-            from ansys.edb.core.primitive.primitive import (
+            from ansys.edb.core.primitive.padstack_instance import (
                 PadstackInstance as GrpcPadstackInstance,
             )
 
@@ -3384,15 +3384,15 @@ class Edb(EdbInit):
         list: [:class:`GapPort <pyedb.grpc.database.ports.ports.GapPort`>,
             :class:`WavePort <pyedb.grpc.database.ports.ports.WavePort>`].
         """
-        from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
+        from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 
-        if isinstance(terminal.boundary_type, GrpcBoundaryType):
+        if terminal.boundary_type == "port":
             terminal.boundary_type = GrpcBoundaryType.PORT
         terminal.is_circuit_port = is_circuit_port
-
-        if isinstance(ref_terminal.boundary_type, GrpcBoundaryType):
-            ref_terminal.boundary_type = GrpcBoundaryType.PORT
-        terminal.ref_terminal = ref_terminal
+        if ref_terminal:
+            if ref_terminal.boundary_type == "port":
+                ref_terminal.boundary_type = GrpcBoundaryType.PORT
+            terminal.reference_terminal = ref_terminal
         if name:
             terminal.name = name
         return self.ports[terminal.name]

pyedb/misc/misc.py

@@ -87,3 +87,16 @@ def current_student_version():
         if "SV" in version_key:
             return version_key
     return ""
+
+
+def deprecated_property(func):
+    """
+    This decorator marks a property as deprecated.
+    It will emit a warning when the property is accessed.
+    """
+
+    def wrapper(*args, **kwargs):
+        warnings.warn(f"Access to deprecated property {func.__name__}.", category=DeprecationWarning, stacklevel=2)
+        return func(*args, **kwargs)
+
+    return wrapper

{pyedb-0.42.0.dist-info → pyedb-0.44.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyedb
-Version: 0.42.0
+Version: 0.44.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>