pyedb 0.7.1__py3-none-any.whl → 0.8.1__py3-none-any.whl

pyedb/dotnet/edb_core/materials.py

@@ -73,6 +73,19 @@ DC_ATTRIBUTES = [
 ]
 
 
+def get_line_float_value(line):
+    """Retrieve the float value expected in the line of an AMAT file.
+
+    The associated string is expected to follow one of the following cases:
+    - simple('permittivity', 12.)
+    - permittivity='12'.
+    """
+    try:
+        return float(re.split(",|=", line)[-1].strip("'\n)"))
+    except ValueError:
+        return None
+
+
 class MaterialProperties(BaseModel):
     """Store material properties."""
 
@@ -400,7 +413,7 @@ class Material(object):
             for attribute in ATTRIBUTES:
                 if attribute in input_dict:
                     setattr(self, attribute, input_dict[attribute])
-            if "loss_tangent" in input_dict:
+            if "loss_tangent" in input_dict:  # pragma: no cover
                 setattr(self, "loss_tangent", input_dict["loss_tangent"])
 
             # Update DS model
@@ -521,7 +534,7 @@ class Materials(object):
         material_def = self.__edb_definition.MaterialDef.Create(self.__edb.active_db, name)
         material = Material(self.__edb, material_def)
         attributes_input_dict = {key: val for (key, val) in kwargs.items() if key in ATTRIBUTES + DC_ATTRIBUTES}
-        if "loss_tangent" in kwargs:
+        if "loss_tangent" in kwargs:  # pragma: no cover
             warnings.warn(
                 "This key is deprecated in versions >0.7.0 and will soon be removed. "
                 "Use key dielectric_loss_tangent instead.",
@@ -550,14 +563,10 @@ class Materials(object):
         :class:`pyedb.dotnet.edb_core.materials.Material`
 
         """
-        if name in self.__materials:
-            raise ValueError(f"Material {name} already exists in material library.")
-
         extended_kwargs = {key: value for (key, value) in kwargs.items()}
         extended_kwargs["conductivity"] = conductivity
         material = self.add_material(name, **extended_kwargs)
 
-        self.__materials[name] = material
         return material
 
     @pyedb_function_handler()
@@ -577,15 +586,11 @@ class Materials(object):
         -------
         :class:`pyedb.dotnet.edb_core.materials.Material`
         """
-        if name in self.__materials:
-            raise ValueError(f"Material {name} already exists in material library.")
-
         extended_kwargs = {key: value for (key, value) in kwargs.items()}
         extended_kwargs["permittivity"] = permittivity
         extended_kwargs["dielectric_loss_tangent"] = dielectric_loss_tangent
         material = self.add_material(name, **extended_kwargs)
 
-        self.__materials[name] = material
         return material
 
     @pyedb_function_handler()
@@ -632,7 +637,7 @@ class Materials(object):
             material = self.__add_dielectric_material_model(name, material_model)
             for key, value in kwargs.items():
                 setattr(material, key, value)
-            if "loss_tangent" in kwargs:
+            if "loss_tangent" in kwargs:  # pragma: no cover
                 warnings.warn(
                     "This key is deprecated in versions >0.7.0 and will soon be removed. "
                     "Use key dielectric_loss_tangent instead.",
@@ -698,7 +703,7 @@ class Materials(object):
             material = self.__add_dielectric_material_model(name, material_model)
             for key, value in kwargs.items():
                 setattr(material, key, value)
-            if "loss_tangent" in kwargs:
+            if "loss_tangent" in kwargs:  # pragma: no cover
                 warnings.warn(
                     "This key is deprecated in versions >0.7.0 and will soon be removed. "
                     "Use key dielectric_loss_tangent instead.",
@@ -761,7 +766,7 @@ class Materials(object):
             material = self.__add_dielectric_material_model(name, material_model)
             for key, value in kwargs.items():
                 setattr(material, key, value)
-            if "loss_tangent" in kwargs:
+            if "loss_tangent" in kwargs:  # pragma: no cover
                 warnings.warn(
                     "This key is deprecated in versions >0.7.0 and will soon be removed. "
                     "Use key dielectric_loss_tangent instead.",
@@ -837,7 +842,7 @@ class Materials(object):
 
         material = self[material_name]
         attributes_input_dict = {key: val for (key, val) in input_dict.items() if key in ATTRIBUTES + DC_ATTRIBUTES}
-        if "loss_tangent" in input_dict:
+        if "loss_tangent" in input_dict:  # pragma: no cover
             warnings.warn(
                 "This key is deprecated in versions >0.7.0 and will soon be removed. "
                 "Use key dielectric_loss_tangent instead.",
@@ -852,26 +857,6 @@ class Materials(object):
     @pyedb_function_handler()
     def load_material(self, material):
         """Load material."""
-        if self.materials:
-            mat_keys = [i.lower() for i in self.materials.keys()]
-            mat_keys_case = [i for i in self.materials.keys()]
-        else:
-            mat_keys = []
-            mat_keys_case = []
-
-        if not material:
-            return
-        if material["name"].lower() not in mat_keys:
-            if "conductivity" not in material:
-                self.add_dielectric_material(material["name"], material["permittivity"], material["loss_tangent"])
-            elif material["conductivity"] > 1e4:
-                self.add_conductor_material(material["name"], material["conductivity"])
-            else:
-                self.add_dielectric_material(material["name"], material["permittivity"], material["loss_tangent"])
-            self.materials[material["name"]]._load(material)
-        else:
-            self.materials[mat_keys_case[mat_keys.index(material["name"].lower())]]._load(material)
-
         if material:
             material_name = material["name"]
             material_conductivity = material.get("conductivity", None)
@@ -879,7 +864,7 @@ class Materials(object):
                 self.add_conductor_material(material_name, material_conductivity)
             else:
                 material_permittivity = material["permittivity"]
-                if "loss_tangent" in material:
+                if "loss_tangent" in material:  # pragma: no cover
                     warnings.warn(
                         "This key is deprecated in versions >0.7.0 and will soon be removed. "
                         "Use key dielectric_loss_tangent instead.",
@@ -953,7 +938,7 @@ class Materials(object):
                 if "tangent_delta" in material_properties:
                     material_properties["dielectric_loss_tangent"] = material_properties["tangent_delta"]
                     del material_properties["tangent_delta"]
-                elif "loss_tangent" in material_properties:
+                elif "loss_tangent" in material_properties:  # pragma: no cover
                     warnings.warn(
                         "This key is deprecated in versions >0.7.0 and will soon be removed. "
                         "Use key dielectric_loss_tangent instead.",
@@ -966,9 +951,83 @@ class Materials(object):
                 self.__edb.logger.warning(f"Material {material_name} already exist and was not loaded from AMAT file.")
         return True
 
-    @staticmethod
     @pyedb_function_handler()
-    def read_materials(amat_file):
+    def iterate_materials_in_amat(self, amat_file=None):
+        """Iterate over material description in an AMAT file.
+
+        Parameters
+        ----------
+        amat_file : str
+            Full path to the AMAT file to read.
+
+        Yields
+        ------
+        dict
+        """
+        if amat_file is None:
+            amat_file = os.path.join(self.__edb.base_path, "syslib", "Materials.amat")
+
+        begin_regex = re.compile(r"^\$begin '(.+)'")
+        end_regex = re.compile(r"^\$end '(.+)'")
+        material_properties = ATTRIBUTES.copy()
+        # Remove cases manually handled
+        material_properties.remove("conductivity")
+
+        with open(amat_file, "r") as amat_fh:
+            in_material_def = False
+            material_description = {}
+            for line in amat_fh:
+                if in_material_def:
+                    # Yield material definition
+                    if end_regex.search(line):
+                        in_material_def = False
+                        yield material_description
+                        material_description = {}
+                    # Extend material definition if possible
+                    else:
+                        for material_property in material_properties:
+                            if material_property in line:
+                                value = get_line_float_value(line)
+                                if value is not None:
+                                    material_description[material_property] = value
+                                break
+                        # Extra case to cover bug in syslib AMAT file (see #364)
+                        if "thermal_expansion_coeffcient" in line:
+                            value = get_line_float_value(line)
+                            if value is not None:
+                                material_description["thermal_expansion_coefficient"] = value
+                        # Extra case to avoid confusion ("conductivity" is included in "thermal_conductivity")
+                        if "conductivity" in line and "thermal_conductivity" not in line:
+                            value = get_line_float_value(line)
+                            if value is not None:
+                                material_description["conductivity"] = value
+                        # Extra case to avoid confusion ("conductivity" is included in "thermal_conductivity")
+                        if (
+                            "loss_tangent" in line
+                            and "dielectric_loss_tangent" not in line
+                            and "magnetic_loss_tangent" not in line
+                        ):
+                            warnings.warn(
+                                "This key is deprecated in versions >0.7.0 and will soon be removed. "
+                                "Use key dielectric_loss_tangent instead.",
+                                DeprecationWarning,
+                            )
+                            value = get_line_float_value(line)
+                            if value is not None:
+                                material_description["dielectric_loss_tangent"] = value
+                # Check if we reach the beginning of a material description
+                else:
+                    match = begin_regex.search(line)
+                    if match:
+                        material_name = match.group(1)
+                        # Skip unwanted data
+                        if material_name in ("$index$", "$base_index$"):
+                            continue
+                        material_description["name"] = match.group(1)
+                        in_material_def = True
+
+    @pyedb_function_handler()
+    def read_materials(self, amat_file):
         """Read materials from an AMAT file.
 
         Parameters
@@ -981,76 +1040,39 @@ class Materials(object):
         dict
             {material name: dict of material properties}.
         """
+        res = {}
+        for material in self.iterate_materials_in_amat(amat_file):
+            material_name = material["name"]
+            res[material_name] = {}
+            for material_property, value in material.items():
+                if material_property != "name":
+                    res[material_name][material_property] = value
 
-        def get_line_float_value(line):
-            """Retrieve the float value expected in the line of an AMAT file.
-
-            The associated string is expected to follow one of the following cases:
-            - simple('permittivity', 12.)
-            - permittivity='12'.
-            """
-            try:
-                return float(re.split(",|=", line)[-1].strip(")'"))
-            except ValueError:
-                return None
+        return res
 
-        res = {}
-        _begin_search = re.compile(r"^\$begin '(.+)'")
-        _end_search = re.compile(r"^\$end '(.+)'")
-        material_properties = [
-            "thermal_conductivity",
-            "permittivity",
-            "dielectric_loss_tangent",
-            "permeability",
-            "magnetic_loss_tangent",
-            "thermal_expansion_coeffcient",
-            "specific_heat",
-            "mass_density",
-        ]
+    @pyedb_function_handler()
+    def read_syslib_material(self, material_name):
+        """Read a specific material from syslib AMAT file.
 
-        with open(amat_file, "r") as amat_fh:
-            raw_lines = amat_fh.read().splitlines()
-            material_name = ""
-            for line in raw_lines:
-                b = _begin_search.search(line)
-                if b:  # walk down a level
-                    material_name = b.group(1)
-                    res.setdefault(material_name, {})
-                    if len(res) > 165:
-                        pass
-                if material_name:
-                    for material_property in material_properties:
-                        if material_property in line:
-                            value = get_line_float_value(line)
-                            if value is not None:
-                                res[material_name][material_property] = value
-                            break
-                    # Extra case to avoid confusion ("conductivity" is included in "thermal_conductivity")
-                    if "conductivity" in line and "thermal_conductivity" not in line:
-                        value = get_line_float_value(line)
-                        if value is not None:
-                            res[material_name]["conductivity"] = value
-                    # Extra case to avoid confusion ("conductivity" is included in "thermal_conductivity")
-                    if (
-                        "loss_tangent" in line
-                        and "dielectric_loss_tangent" not in line
-                        and "magnetic_loss_tangent" not in line
-                    ):
-                        warnings.warn(
-                            "This key is deprecated in versions >0.7.0 and will soon be removed. "
-                            "Use key dielectric_loss_tangent instead.",
-                            DeprecationWarning,
-                        )
-                        value = get_line_float_value(line)
-                        if value is not None:
-                            res[material_name]["dielectric_loss_tangent"] = value
-                end = _end_search.search(line)
-                if end:
-                    material_name = ""
-
-        # Clean unwanted data
-        for key in ("$index$", "$base_index$"):
-            if key in res:
-                del res[key]
+        Parameters
+        ----------
+        material_name : str
+            Name of the material.
 
+        Returns
+        -------
+        dict
+            {material name: dict of material properties}.
+        """
+        res = {}
+        amat_file = os.path.join(self.__edb.base_path, "syslib", "Materials.amat")
+        for material in self.iterate_materials_in_amat(amat_file):
+            iter_material_name = material["name"]
+            if iter_material_name == material_name:
+                for material_property, value in material.items():
+                    if material_property != "name":
+                        res[material_property] = value
+                return res
+
+        self.__edb.logger.error(f"Material {material_name} does not exist in syslib AMAT file.")
         return res

pyedb/dotnet/edb_core/nets.py

@@ -472,7 +472,7 @@ class EdbNets(object):
     @pyedb_function_handler()
     def get_plot_data(
         self,
-        nets,
+        nets=None,
         layers=None,
         color_by_net=False,
         outline=None,
@@ -483,8 +483,8 @@ class EdbNets(object):
 
         Parameters
         ----------
-        nets : str, list
-            Name of the net or list of nets to plot. If `None` all nets will be plotted.
+        nets : str, list, optional
+            Name of the net or list of nets to plot. If `None` (default value) all nets will be plotted.
         layers : str, list, optional
             Name of the layers to include in the plot. If `None` all the signal layers will be considered.
         color_by_net : bool, optional

pyedb/dotnet/edb_core/obj_base.py

@@ -0,0 +1,94 @@
+# 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 pyedb.dotnet.clr_module import Tuple
+from pyedb.dotnet.edb_core.geometry.point_data import PointData
+
+
+class BBox:
+    """Bounding box."""
+
+    def __init__(self, pedb, edb_object=None, point_1=None, point_2=None):
+        self._pedb = pedb
+        if edb_object:
+            self._edb_object = edb_object
+        else:
+            point_1 = PointData(self._pedb, x=point_1[0], y=point_1[1])
+            point_2 = PointData(self._pedb, x=point_2[0], y=point_2[1])
+            self._edb_object = Tuple[self._pedb.edb_api.Geometry.PointData, self._pedb.edb_api.Geometry.PointData](
+                point_1._edb_object, point_2._edb_object
+            )
+
+    @property
+    def point_1(self):
+        return [self._edb_object.Item1.X.ToDouble(), self._edb_object.Item1.Y.ToDouble()]
+
+    @property
+    def point_2(self):
+        return [self._edb_object.Item2.X.ToDouble(), self._edb_object.Item2.Y.ToDouble()]
+
+    @property
+    def corner_points(self):
+        return [self.point_1, self.point_2]
+
+
+class ObjBase(object):
+    """Manages EDB functionalities for a base object."""
+
+    def __init__(self, pedb, edb_object):
+        self._pedb = pedb
+        self._edb_object = edb_object
+
+    @property
+    def is_null(self):
+        """Flag indicating if this object is null."""
+        return self._edb_object.IsNull()
+
+    @property
+    def type(self):
+        """Type of the edb object."""
+        try:
+            return self._edb_object.GetType()
+        except AttributeError:  # pragma: no cover
+            return None
+
+    @property
+    def name(self):
+        """Name of the definition."""
+        return self._edb_object.GetName()
+
+    @name.setter
+    def name(self, value):
+        self._edb_object.SetName(value)
+
+    @property
+    def bounding_box(self):
+        """Bounding box.
+
+        Returns
+        -------
+        List[float]
+            List of coordinates for the component's bounding box, with the list of
+            coordinates in this order: [X lower left corner, Y lower left corner,
+            X upper right corner, Y upper right corner].
+        """
+        return BBox(self._pedb, self._edb_object.GetBBox()).corner_points

pyedb/dotnet/edb_core/siwave.py

@@ -1196,8 +1196,8 @@ class EdbSiwave(object):
 
         Parameters
         ----------
-        pins : list[Edb.Primitive.PadstackInstance]
-             List of EDB pins, length must be 2, since only 2 pins component are currently supported.
+        pins : list[Edb.Cell.Primitive.PadstackInstance]
+             List of EDB pins.
 
         component_name : str
             Component name.
@@ -1454,3 +1454,34 @@ class EdbSiwave(object):
         p_terminal = self._pedb.get_point_terminal(name, positive_net_name, positive_location, positive_layer)
         n_terminal = self._pedb.get_point_terminal(name + "_ref", negative_net_name, negative_location, negative_layer)
         return self._pedb.create_voltage_probe(p_terminal, n_terminal)
+
+    @property
+    def icepak_use_minimal_comp_defaults(self):
+        """Icepak default setting. If "True", only resistor are active in Icepak simulation.
+        The power dissipation of the resistors are calculated from DC results.
+        """
+        siwave_id = self._pedb.edb_api.ProductId.SIWave
+        cell = self._pedb.active_cell._active_cell
+        _, value = cell.GetProductProperty(siwave_id, 422, "")
+        return bool(value)
+
+    @icepak_use_minimal_comp_defaults.setter
+    def icepak_use_minimal_comp_defaults(self, value):
+        value = "True" if bool(value) else ""
+        siwave_id = self._pedb.edb_api.ProductId.SIWave
+        cell = self._pedb.active_cell._active_cell
+        cell.SetProductProperty(siwave_id, 422, value)
+
+    @property
+    def icepak_component_file(self):
+        """Icepak component file path."""
+        siwave_id = self._pedb.edb_api.ProductId.SIWave
+        cell = self._pedb.active_cell._active_cell
+        _, value = cell.GetProductProperty(siwave_id, 420, "")
+        return value
+
+    @icepak_component_file.setter
+    def icepak_component_file(self, value):
+        siwave_id = self._pedb.edb_api.ProductId.SIWave
+        cell = self._pedb.active_cell._active_cell
+        cell.SetProductProperty(siwave_id, 420, value)