pyedb 0.37.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

pyedb/grpc/database/ports/ports.py

@@ -0,0 +1,396 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+from pyedb.dotnet.database.cell.terminal.terminal import Terminal
+from pyedb.grpc.database.terminal.bundle_terminal import BundleTerminal
+from pyedb.grpc.database.terminal.edge_terminal import EdgeTerminal
+from pyedb.grpc.database.terminal.padstack_instance_terminal import (
+    PadstackInstanceTerminal,
+)
+
+
+class GapPort(EdgeTerminal):
+    """Manages gap port properties.
+
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        EDB object from the ``Edblib`` library.
+    edb_object : Ansys.Ansoft.Edb.Cell.Terminal.EdgeTerminal
+        Edge terminal instance from EDB.
+
+    Examples
+    --------
+    This example shows how to access the ``GapPort`` class.
+    >>> from pyedb import Edb
+    >>> edb = Edb("myaedb.aedb")
+    >>> gap_port = edb.ports["gap_port"]
+    """
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def magnitude(self):
+        """Magnitude.
+
+        Returns
+        -------
+        float
+            Magnitude value.
+        """
+        return self._edb_object.source_amplitude.value
+
+    @property
+    def phase(self):
+        """Phase.
+
+        Returns
+        -------
+        float
+            Phase value.
+        """
+        return self._edb_object.source_phase.value
+
+    @property
+    def renormalize(self):
+        """Whether renormalize is active.
+
+        Returns
+        -------
+        bool
+        """
+        return self._edb_object.port_post_processing_prop.do_renormalize
+
+    @property
+    def deembed(self):
+        """Deembed gap port.
+
+        Returns
+        -------
+        bool
+
+        """
+        return self._edb_object.port_post_processing_prop.do_deembed
+
+    @property
+    def renormalize_z0(self):
+        """Renormalize Z0 value (real, imag).
+
+        Returns
+        -------
+        Tuple(float, float)
+            (Real value, Imaginary value).
+        """
+        return (
+            self._edb_object.port_post_processing_prop.renormalizion_z0[0],
+            self._edb_object.port_post_processing_prop.renormalizion_z0[1],
+        )
+
+
+class CircuitPort(GapPort):
+    """Manages gap port properties.
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        EDB object from the ``Edblib`` library.
+    edb_object : Ansys.Ansoft.Edb.Cell.Terminal.EdgeTerminal
+        Edge terminal instance from EDB.
+    Examples
+    --------
+    This example shows how to access the ``GapPort`` class.
+    """
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+
+class WavePort(EdgeTerminal):
+    """Manages wave port properties.
+
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        EDB object from the ``Edblib`` library.
+    edb_object : Ansys.Ansoft.Edb.Cell.Terminal.EdgeTerminal
+        Edge terminal instance from EDB.
+
+    Examples
+    --------
+    This example shows how to access the ``WavePort`` class.
+
+    >>> from pyedb import Edb
+    >>> edb = Edb("myaedb.aedb")
+    >>> exc = edb.ports
+    """
+
+    def __init__(self, pedb, edb_terminal):
+        super().__init__(pedb, edb_terminal.msg)
+
+    @property
+    def horizontal_extent_factor(self):
+        """Horizontal extent factor.
+
+        Returns
+        -------
+        float
+            Extent value.
+        """
+        return self._hfss_port_property["Horizontal Extent Factor"]
+
+    @horizontal_extent_factor.setter
+    def horizontal_extent_factor(self, value):
+        self.p = p
+        p = self.p
+        p["Horizontal Extent Factor"] = value
+
+    @property
+    def vertical_extent_factor(self):
+        """Vertical extent factor.
+
+        Returns
+        -------
+        float
+            Vertical extent value.
+
+        """
+        return self._hfss_port_property["Vertical Extent Factor"]
+
+    @vertical_extent_factor.setter
+    def vertical_extent_factor(self, value):
+        p = self._hfss_port_property
+        p["Vertical Extent Factor"] = value
+        self._hfss_port_property = p
+
+    @property
+    def pec_launch_width(self):
+        """Launch width for the printed electronic component (PEC).
+
+        Returns
+        -------
+        float
+            Pec launch width value.
+        """
+        return self._hfss_port_property["PEC Launch Width"]
+
+    @pec_launch_width.setter
+    def pec_launch_width(self, value):
+        p = self._hfss_port_property
+        p["PEC Launch Width"] = value
+        self._hfss_port_property = p
+
+    @property
+    def deembed(self):
+        """Whether deembed is active.
+
+        Returns
+        -------
+        bool
+
+        """
+        return self._edb_object.port_post_processing_prop.do_deembed
+
+    @deembed.setter
+    def deembed(self, value):
+        p = self._edb_object.port_post_processing_prop
+        p.DoDeembed = value
+        self._edb_object.port_post_processing_prop = p
+
+    @property
+    def deembed_length(self):
+        """Deembed Length.
+
+        Returns
+        -------
+        float
+            deembed value.
+        """
+        return self._edb_object.port_post_processing_prop.deembed_length.value
+
+    @deembed_length.setter
+    def deembed_length(self, value):
+        p = self._edb_object.port_post_processing_prop
+        p.deembed_length = GrpcValue(value)
+        self._edb_object.port_post_processing_prop = p
+
+
+class ExcitationSources(Terminal):
+    """Manage sources properties.
+
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        Edb object from Edblib.
+    edb_terminal : Ansys.Ansoft.Edb.Cell.Terminal.EdgeTerminal
+        Edge terminal instance from Edb.
+
+
+
+    Examples
+    --------
+    This example shows how to access this class.
+    >>> from pyedb import Edb
+    >>> edb = Edb("myaedb.aedb")
+    >>> all_sources = edb.sources
+    >>> print(all_sources["VSource1"].name)
+
+    """
+
+    def __init__(self, pedb, edb_terminal):
+        Terminal.__init__(self, pedb, edb_terminal)
+
+
+class BundleWavePort(BundleTerminal):
+    """Manages bundle wave port properties.
+
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        EDB object from the ``Edblib`` library.
+    edb_object : Ansys.Ansoft.Edb.Cell.Terminal.BundleTerminal
+        BundleTerminal instance from EDB.
+
+    """
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def _wave_port(self):
+        """ "Wave port.
+
+
+        Returns
+        -------
+        :class:`WavePort <pyedb.grpc.ports.ports.WavePort>`
+
+        """
+        return WavePort(self._pedb, self.terminals[0]._edb_object)
+
+    @property
+    def horizontal_extent_factor(self):
+        """Horizontal extent factor.
+
+        Returns
+        -------
+        float
+            Horizontal extent value.
+        """
+        return self._wave_port.horizontal_extent_factor
+
+    @horizontal_extent_factor.setter
+    def horizontal_extent_factor(self, value):
+        self._wave_port.horizontal_extent_factor = value
+
+    @property
+    def vertical_extent_factor(self):
+        """Vertical extent factor.
+
+        Returns
+        -------
+        float
+            Vertical extent value.
+        """
+        return self._wave_port.vertical_extent_factor
+
+    @vertical_extent_factor.setter
+    def vertical_extent_factor(self, value):
+        self._wave_port.vertical_extent_factor = value
+
+    @property
+    def pec_launch_width(self):
+        """Launch width for the printed electronic component (PEC).
+
+        Returns
+        -------
+        float
+            Width value.
+        """
+        return self._wave_port.pec_launch_width
+
+    @pec_launch_width.setter
+    def pec_launch_width(self, value):
+        self._wave_port.pec_launch_width = value
+
+    @property
+    def deembed(self):
+        """Whether deembed is active.
+
+        Returns
+        -------
+        bool
+        """
+        return self._wave_port.deembed
+
+    @deembed.setter
+    def deembed(self, value):
+        self._wave_port.deembed = value
+
+    @property
+    def deembed_length(self):
+        """Deembed Length.
+
+        Returns
+        -------
+        float
+            Length value.
+        """
+        return self._wave_port.deembed_length
+
+    @deembed_length.setter
+    def deembed_length(self, value):
+        self._wave_port.deembed_length = value
+
+
+class CoaxPort(PadstackInstanceTerminal):
+    """Manages bundle wave port properties.
+
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        EDB object from the ``Edblib`` library.
+    edb_object : Ansys.Ansoft.Edb.Cell.Terminal.PadstackInstanceTerminal
+        PadstackInstanceTerminal instance from EDB.
+
+    """
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def radial_extent_factor(self):
+        """Radial extent factor.
+
+        Returns
+        -------
+        float
+            Radial extent value.
+        """
+        return self._hfss_port_property["Radial Extent Factor"]
+
+    @radial_extent_factor.setter
+    def radial_extent_factor(self, value):
+        p = self._hfss_port_property
+        p["Radial Extent Factor"] = value
+        self._hfss_port_property = p

pyedb/grpc/database/primitive/__init__.py

@@ -0,0 +1,3 @@
+from pathlib import Path
+
+workdir = Path(__file__).parent

pyedb/grpc/database/primitive/bondwire.py

@@ -0,0 +1,181 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from ansys.edb.core.primitive.primitive import (
+    BondwireCrossSectionType as GrpcBondwireCrossSectionType,
+)
+from ansys.edb.core.primitive.primitive import Bondwire as GrpcBondWire
+from ansys.edb.core.primitive.primitive import BondwireType as GrpcBondWireType
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+
+class Bondwire(GrpcBondWire):
+    """Class representing a bond-wire object."""
+
+    def __init__(self, _pedb, edb_object):
+        super().__init__(edb_object.msg)
+        self._pedb = _pedb
+        self._edb_object = edb_object
+
+    @property
+    def material(self):
+        """Bondwire material
+
+        Returns
+        -------
+        str
+            Material name.
+
+        """
+        return self.get_material().value
+
+    @material.setter
+    def material(self, value):
+        self.set_material(value)
+
+    # def __create(self, **kwargs):
+    #     return Bondwire.create(
+    #         self._pedb.layout,
+    #         kwargs.get("net"),
+    #         self._bondwire_type[kwargs.get("bondwire_type")],
+    #         kwargs.get("definition_name"),
+    #         kwargs.get("placement_layer"),
+    #         kwargs.get("width"),
+    #         kwargs.get("material"),
+    #         kwargs.get("start_context"),
+    #         kwargs.get("start_layer_name"),
+    #         kwargs.get("start_x"),
+    #         kwargs.get("start_y"),
+    #         kwargs.get("end_context"),
+    #         kwargs.get("end_layer_name"),
+    #         kwargs.get("end_x"),
+    #         kwargs.get("end_y"),
+    #     )
+
+    @property
+    def type(self):
+        """str: Bondwire-type of a bondwire object. Supported values for setter: `"apd"`, `"jedec4"`, `"jedec5"`,
+        `"num_of_type"`"""
+        return super().type.name.lower()
+
+    @type.setter
+    def type(self, bondwire_type):
+        mapping = {
+            "apd": GrpcBondWireType.APD,
+            "jedec4": GrpcBondWireType.JEDEC4,
+            "jedec5": GrpcBondWireType.JEDEC5,
+            "num_of_type": GrpcBondWireType.NUM_OF_TYPE,
+        }
+        super(Bondwire, self.__class__).type.__set__(self, mapping[bondwire_type])
+
+    @property
+    def cross_section_type(self):
+        """str: Bondwire-cross-section-type of a bondwire object. Supported values for setter: `"round",
+        `"rectangle"`
+
+        Returns
+        -------
+        str
+            cross section type.
+        """
+        return super().cross_section_type.name.lower()
+
+    @cross_section_type.setter
+    def cross_section_type(self, cross_section_type):
+        mapping = {"round": GrpcBondwireCrossSectionType.ROUND, "rectangle": GrpcBondwireCrossSectionType.RECTANGLE}
+        super(Bondwire, self.__class__).cross_section_type.__set__(self, mapping[cross_section_type])
+
+    @property
+    def cross_section_height(self):
+        """float: Bondwire-cross-section height of a bondwire object.
+
+        Returns
+        -------
+        float
+            Cross section height.
+        """
+        return super().cross_section_height.value
+
+    @cross_section_height.setter
+    def cross_section_height(self, cross_section_height):
+        super(Bondwire, self.__class__).cross_section_height.__set__(self, GrpcValue(cross_section_height))
+
+    # @property
+    # def trajectory(self):
+    #     """Get trajectory parameters of a bondwire object.
+    #
+    #     Returns
+    #     -------
+    #     tuple[float, float, float, float]
+    #
+    #     Returns a tuple of the following format:
+    #     **(x1, y1, x2, y2)**
+    #     **x1** : X value of the start point.
+    #     **y1** : Y value of the start point.
+    #     **x1** : X value of the end point.
+    #     **y1** : Y value of the end point.
+    #     """
+    #     return [i.value for i in self.get_traj()]
+    #
+    # @trajectory.setter
+    # def trajectory(self, value):
+    #     values = [GrpcValue(i) for i in value]
+    #     self.set_traj(values[0], values[1], values[2], values[3])
+
+    @property
+    def width(self):
+        """:class:`Value <ansys.edb.utility.Value>`: Width of a bondwire object.
+
+        Returns
+        -------
+        float
+            Width value.
+        """
+        return super().width.value
+
+    @width.setter
+    def width(self, width):
+        super(Bondwire, self.__class__).width.__set__(self, GrpcValue(width))
+
+    # @property
+    # def start_elevation(self):
+    #     layer = self.get_start_elevation(self._pedb.active_cell)
+    #     return layer.name
+    #
+    # @start_elevation.setter
+    # def start_elevation(self, layer):
+    #     if not layer in self._pedb.stackup.layers:
+    #         return
+    #     layer = self._pedb.stackup.layers[layer]
+    #     self.set_start_elevation(self._pedb.active_cell, layer)
+    #
+    # @property
+    # def end_elevation(self):
+    #     layer = self.get_end_elevation(self._pedb.active_cell)
+    #     return layer.name
+    #
+    # @end_elevation.setter
+    # def end_elevation(self, layer):
+    #     if not layer in self._pedb.stackup.layers:
+    #         return
+    #     layer = self._pedb.stackup.layers[layer]
+    #     self.set_end_elevation(self._pedb.active_cell, layer)

pyedb/grpc/database/primitive/circle.py

@@ -0,0 +1,75 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+from ansys.edb.core.primitive.primitive import Circle as GrpcCircle
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+from pyedb.grpc.database.primitive.primitive import Primitive
+
+
+class Circle(GrpcCircle, Primitive):
+    def __init__(self, pedb, edb_object):
+        GrpcCircle.__init__(self, edb_object.msg)
+        Primitive.__init__(self, pedb, edb_object)
+        self._pedb = pedb
+
+    def get_parameters(self):
+        """Returns parameters.
+
+        Returns
+        -------
+        tuple[
+            :class:`.Value`,
+            :class:`.Value`,
+            :class:`.Value`
+        ]
+
+            Returns a tuple in this format:
+
+            **(center_x, center_y, radius)**
+
+            **center_x** : X value of center point.
+
+            **center_y** : Y value of center point.
+
+            **radius** : Radius value of the circle.
+
+
+        """
+        params = super().get_parameters()
+        return params[0].value, params[1].value, params[2].value
+
+    def set_parameters(self, center_x, center_y, radius):
+        """Set parameters.
+
+        Parameters
+        ----------
+        center_x : float
+            Center x value.
+        center_y : float
+            Center y value
+        radius : float
+            Circle radius.
+
+        """
+        super().set_parameters(GrpcValue(center_x), GrpcValue(center_y), GrpcValue(radius))