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

pyedb/grpc/database/hierarchy/model.py

@@ -0,0 +1,31 @@
+# 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.hierarchy.model import Model as GrpcModel
+
+
+class Model(GrpcModel):
+    """Manages model :class:`Model <ansys.edb.core.hierarchy.model.Model>`."""
+
+    def __init__(self, pedb):
+        super().__init__(self.msg)
+        self._pedb = pedb

pyedb/grpc/database/hierarchy/netlist_model.py

@@ -0,0 +1,30 @@
+# 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.hierarchy.netlist_model import NetlistModel as GrpcNetlistModel
+
+
+class NetlistModel(GrpcNetlistModel):
+    """Manage :class:`NetlistModel <ansys.edb.core.hierarchy.netlist_model.NetlistModel>`."""
+
+    def __init__(self):
+        super().__init__(self.msg)

pyedb/grpc/database/hierarchy/pin_pair_model.py

@@ -0,0 +1,128 @@
+# 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.hierarchy.pin_pair_model import PinPairModel
+from ansys.edb.core.hierarchy.pin_pair_model import PinPairModel as GrpcPinPairModel
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+
+class PinPairModel(GrpcPinPairModel):
+    """Manage pin pair model."""
+
+    def __init__(self, pedb, edb_object):
+        self._pedb_comp = pedb
+        super().__init__(edb_object.msg)
+
+    @property
+    def rlc(self):
+        """Rlc mdodel.
+
+        Returns
+        -------
+        Tuple
+
+        """
+        return super().rlc(self.pin_pairs()[0])
+
+    @property
+    def rlc_enable(self):
+        """Enable model.
+
+        Returns
+        -------
+        List[Renabled(bool), Lenabled(bool), Cenabled(bool)].
+
+        """
+        return [self.rlc.r_enabled, self.rlc.l_enabled, self.rlc.c_enabled]
+
+    @rlc_enable.setter
+    def rlc_enable(self, value):
+        self.rlc.r_enabled = GrpcValue(value[0])
+        self.rlc.l_enabled = GrpcValue(value[1])
+        self.rlc.c_enabled = GrpcValue(value[2])
+
+    @property
+    def resistance(self):
+        """Resistance.
+
+        Returns
+        -------
+        float
+            Resistance value.
+
+        """
+        return self.rlc.r.value
+
+    @resistance.setter
+    def resistance(self, value):
+        self.rlc.r = GrpcValue(value)
+
+    @property
+    def inductance(self):
+        """Inductance.
+
+        Returns
+        -------
+        float
+            Inductance value.
+
+        """
+        return self.rlc.l.value
+
+    @inductance.setter
+    def inductance(self, value):
+        self.rlc.l = GrpcValue(value)
+
+    @property
+    def capacitance(self):
+        """Capacitance.
+
+        Returns
+        -------
+        float
+            Capacitance value.
+
+        """
+        return self.rlc.c.value
+
+    @capacitance.setter
+    def capacitance(self, value):
+        self.rlc.c = GrpcValue(value)
+
+    @property
+    def rlc_values(self):  # pragma: no cover
+        """Rlc value.
+
+        Returns
+        -------
+        List[float, float, float]
+            [R value, L value, C value].
+
+        """
+        return [self.rlc.r.value, self.rlc.l.value, self.rlc.c.value]
+
+    @rlc_values.setter
+    def rlc_values(self, values):  # pragma: no cover
+        self.rlc.r = GrpcValue(values[0])
+        self.rlc.l = GrpcValue(values[1])
+        self.rlc.c = GrpcValue(values[2])

pyedb/grpc/database/hierarchy/pingroup.py

@@ -0,0 +1,245 @@
+# 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.hierarchy.pin_group import PinGroup as GrpcPinGroup
+from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+from pyedb.generic.general_methods import generate_unique_name
+from pyedb.grpc.database.hierarchy.component import Component
+from pyedb.grpc.database.net.net import Net
+from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
+from pyedb.grpc.database.terminal.pingroup_terminal import PinGroupTerminal
+
+
+class PinGroup(GrpcPinGroup):
+    """Manages pin groups."""
+
+    def __init__(self, pedb, edb_pin_group=None):
+        if edb_pin_group:
+            super().__init__(edb_pin_group.msg)
+        self._pedb = pedb
+
+    @property
+    def _active_layout(self):
+        """Active layout.
+
+        Returns
+        -------
+        :class:`Layout <ansys.edb.core.layout.layout.Layout>`
+            Active layout.
+
+        """
+        return self._pedb.active_layout
+
+    @property
+    def component(self):
+        """Component.
+
+        Return
+        ------
+        :class:`Component <pyedb.grpc.database.hierarchy.component.Component>`
+            Pin group component.
+        """
+        return Component(self._pedb, super().component)
+
+    @component.setter
+    def component(self, value):
+        if isinstance(value, Component):
+            super(PinGroup, self.__class__).component.__set__(self, value)
+
+    @property
+    def pins(self):
+        """Pin group pins.
+
+        Returns
+        -------
+        List[:class:`PadstackInstance <pyedb.grpc.database.primitive.padstack_instance.PadstackInstance>`].
+        """
+        return [PadstackInstance(self._pedb, i) for i in super().pins]
+
+    @property
+    def net(self):
+        """Net.
+
+        Returns
+        -------
+        :class:`Net <ansys.edb.core.net.net.Net>`.
+        """
+        return Net(self._pedb, super().net)
+
+    @net.setter
+    def net(self, value):
+        if isinstance(value, Net):
+            super(PinGroup, self.__class__).net.__set__(self, value)
+
+    @property
+    def net_name(self):
+        """Net name.
+
+        Returns
+        -------
+        str
+            Net name.
+
+        """
+        return self.net.name
+
+    # @property
+    # def terminal(self):
+    #     """Terminal."""
+    #     term = PinGroupTerminal(self._pedb, self.get_pin_group_terminal())  # TODO check method is missing
+    #     return term if not term.is_null else None
+
+    def create_terminal(self, name=None):
+        """Create a terminal.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the terminal.
+
+        Returns
+        -------
+        :class:`PinGroupTerminal <pyedb.grpc.database.terminal.pingroup_terminal.PinGroupTerminal>`.
+            Pin group terminal.
+
+        """
+        if not name:
+            name = generate_unique_name(self.name)
+        term = PinGroupTerminal.create(
+            layout=self._active_layout, name=name, pin_group=self, net=self.net, is_ref=False
+        )
+        return PinGroupTerminal(self._pedb, term)
+
+    def _json_format(self):
+        """Format json.
+
+        Returns
+        -------
+        Dict
+        """
+        dict_out = {"component": self.component, "name": self.name, "net": self.net, "node_type": self.node_type}
+        return dict_out
+
+    def create_current_source_terminal(self, magnitude=1.0, phase=0, impedance=1e6):
+        """Create current source terminal.
+
+        Parameters
+        ----------
+        magnitude : float or int, optional
+            Source magnitude, default value ``1.0``.
+        phase : float or int, optional
+            Source phase, default value ``0.0``.
+        impedance : float, optional
+            Source impedance, default value ``1e6``.
+
+        Returns
+        -------
+        :class:`PinGroupTerminal <pyedb.grpc.database.terminal.pingroup_terminal.PinGroupTerminal>`.
+            Pin group terminal.
+
+        """
+        terminal = self.create_terminal()
+        terminal.boundary_type = GrpcBoundaryType.CURRENT_SOURCE
+        terminal.source_amplitude = GrpcValue(magnitude)
+        terminal.source_phase = GrpcValue(phase)
+        terminal.impedance = GrpcValue(impedance)
+        return terminal
+
+    def create_voltage_source_terminal(self, magnitude=1, phase=0, impedance=0.001):
+        """Create voltage source terminal.
+
+        Parameters
+        ----------
+        magnitude : float or int, optional
+            Source magnitude, default value ``1.0``.
+        phase : float or int, optional
+            Source phase, default value ``0.0``.
+        impedance : float, optional
+            Source impedance, default value ``1e-3``.
+
+        Returns
+        -------
+        :class:`PinGroupTerminal <pyedb.grpc.database.terminal.pingroup_terminal.PinGroupTerminal>`.
+            Pin group terminal.
+
+        """
+        terminal = self.create_terminal()
+        terminal.boundary_type = GrpcBoundaryType.VOLTAGE_SOURCE
+        terminal.source_amplitude = GrpcValue(magnitude)
+        terminal.source_phase = GrpcValue(phase)
+        terminal.impedance = GrpcValue(impedance)
+        return terminal
+
+    def create_voltage_probe_terminal(self, impedance=1e6):
+        """Create voltage probe terminal.
+
+        Parameters
+        ----------
+        impedance : float, optional
+            Probe impedance, default value ``1e6``.
+
+        Returns
+        -------
+        :class:`PinGroupTerminal <pyedb.grpc.database.terminal.pingroup_terminal.PinGroupTerminal>`.
+            Pin group terminal.
+
+        """
+        terminal = self.create_terminal()
+        terminal.boundary_type = GrpcBoundaryType.VOLTAGE_PROBE
+        terminal.impedance = GrpcValue(impedance)
+        return terminal
+
+    def create_port_terminal(self, impedance=50):
+        """Create port terminal.
+
+        Parameters
+        ----------
+        impedance : float, optional
+            Port impedance, default value ``50``.
+
+        Returns
+        -------
+        :class:`PinGroupTerminal <pyedb.grpc.database.terminal.pingroup_terminal.PinGroupTerminal>`.
+            Pin group terminal.
+
+        """
+        terminal = self.create_terminal()
+        terminal.boundary_type = GrpcBoundaryType.PORT
+        terminal.impedance = GrpcValue(impedance)
+        terminal.is_circuit_port = True
+        return terminal
+
+    # def delete(self):
+    #     """Delete active pin group.
+    #
+    #     Returns
+    #     -------
+    #     bool
+    #
+    #     """
+    #     terminal = self.get_pin_group_terminal()  # TODO check method exists in grpc
+    #     self.delete()
+    #     terminal.delete()
+    #     return True

pyedb/grpc/database/hierarchy/s_parameter_model.py

@@ -0,0 +1,33 @@
+# 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.hierarchy.sparameter_model import (
+    SParameterModel as GrpcSParameterModel,
+)
+
+
+class SparamModel(GrpcSParameterModel):  # pragma: no cover
+    """Manage :class:`SParameterModel <ansys.edb.core.hierarchy.sparameter_model.SParameterModel>`"""
+
+    def __init__(self, edb_model):
+        super().__init__(self.msg)
+        self._edb_model = edb_model

pyedb/grpc/database/hierarchy/spice_model.py

@@ -0,0 +1,48 @@
+# 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.hierarchy.spice_model import SPICEModel as GrpcSpiceModel
+
+
+class SpiceModel(GrpcSpiceModel):  # pragma: no cover
+    """Manage :class:`SpiceModel <ansys.edb.core.hierarchy.spice_model.SpiceModel>`"""
+
+    def __init__(self, edb_object=None, name=None, file_path=None, sub_circuit=None):
+        if edb_object:
+            super().__init__(edb_object)
+        elif name and file_path:
+            if not sub_circuit:
+                sub_circuit = name
+            edb_object = GrpcSpiceModel.create(name=name, path=file_path, sub_circuit=sub_circuit)
+            super().__init__(edb_object.msg)
+
+    @property
+    def name(self):
+        """Model name.
+
+        Returns
+        -------
+        str
+            Model name.
+
+        """
+        return self.model_name

pyedb/grpc/database/layers/layer.py

@@ -0,0 +1,57 @@
+# 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 __future__ import absolute_import
+
+from ansys.edb.core.layer.layer import Layer as GrpcLayer
+from ansys.edb.core.layer.layer import LayerType as GrpcLayerType
+
+
+class Layer(GrpcLayer):
+    """Manages Layer."""
+
+    def __init__(self, pedb, edb_object=None, name="", layer_type="undefined", **kwargs):
+        super().__init__(edb_object.msg)
+        self._pedb = pedb
+        self._name = name
+        self._color = ()
+        self._type = ""
+        if edb_object:
+            self._cloned_layer = self.clone()
+        else:
+            layer_type_mapping = {
+                "conducting_layer": GrpcLayerType.CONDUCTING_LAYER,
+                "air_lines_layer": GrpcLayerType.AIRLINES_LAYER,
+                "errors_layer": GrpcLayerType.ERRORS_LAYER,
+                "symbol_layer": GrpcLayerType.SYMBOL_LAYER,
+                "measure_layer": GrpcLayerType.MEASURE_LAYER,
+                "assembly_layer": GrpcLayerType.ASSEMBLY_LAYER,
+                "silkscreen_layer": GrpcLayerType.SILKSCREEN_LAYER,
+                "solder_mask_layer": GrpcLayerType.SOLDER_MASK_LAYER,
+                "solder_paste_layer": GrpcLayerType.SOLDER_PASTE_LAYER,
+                "glue_layer": GrpcLayerType.GLUE_LAYER,
+                "wirebond_layer": GrpcLayerType.WIREBOND_LAYER,
+                "user_layer": GrpcLayerType.USER_LAYER,
+                "siwave_hfss_solver_regions": GrpcLayerType.SIWAVE_HFSS_SOLVER_REGIONS,
+                "postprocessing_layer": GrpcLayerType.POST_PROCESSING_LAYER,
+                "outline_layer": GrpcLayerType.OUTLINE_LAYER,
+                "layer_types_count": GrpcLayerType.LAYER_TYPES_COUNT,
+                "undefined_layer_type": GrpcLayerType.UNDEFINED_LAYER_TYPE,
+            }
+            if layer_type in layer_type_mapping:
+                self.create(name=name, lyr_type=layer_type_mapping[layer_type])
+                self.update(**kwargs)
+
+    def update(self, **kwargs):
+        for k, v in kwargs.items():
+            if k in dir(self):
+                self.__setattr__(k, v)
+            else:
+                self._pedb.logger.error(f"{k} is not a valid layer attribute")
+
+    @property
+    def _layer_name_mapping_reversed(self):
+        return {j: i for i, j in self._layer_name_mapping.items()}