pyedb 0.31.0__py3-none-any.whl → 0.34.1__py3-none-any.whl

pyedb/configuration/cfg_components.py

@@ -21,81 +21,242 @@
 # SOFTWARE.
 
 from pyedb.configuration.cfg_common import CfgBase
-
-
-class CfgRlcModel(CfgBase):
-    def __init__(self, **kwargs):
-        self.resistance = kwargs.get("resistance", None)
-        self.inductance = kwargs.get("inductance", None)
-        self.capacitance = kwargs.get("capacitance", None)
-        self.type = kwargs.get("type", None)
-        self.p1 = kwargs.get("p1", None)
-        self.p2 = kwargs.get("p2", None)
+from pyedb.dotnet.edb_core.general import pascal_to_snake, snake_to_pascal
 
 
 class CfgComponent(CfgBase):
-    def __init__(self, **kwargs):
+    def __init__(self, pedb, pedb_object, **kwargs):
+        self._pedb = pedb
+        self._pyedb_obj = pedb_object
+
         self.enabled = kwargs.get("enabled", None)
         self.reference_designator = kwargs.get("reference_designator", None)
         self.definition = kwargs.get("definition", None)
         self.type = kwargs["part_type"].lower() if kwargs.get("part_type") else None
+        self.placement_layer = kwargs.get("placement_layer", None)
+        self.pins = kwargs.get("pins", [])
+
         self.port_properties = kwargs.get("port_properties", {})
         self.solder_ball_properties = kwargs.get("solder_ball_properties", {})
         self.ic_die_properties = kwargs.get("ic_die_properties", {})
-        self.pin_pair_model = kwargs.get("pin_pair_model", None)
-        self.spice_model = kwargs.get("spice_model", None)
-        self.s_parameter_model = kwargs.get("s_parameter_model", None)
+        self.pin_pair_model = kwargs.get("pin_pair_model", [])
+        self.spice_model = kwargs.get("spice_model", {})
+        self.s_parameter_model = kwargs.get("s_parameter_model", {})
+        self.netlist_model = kwargs.get("netlist_model", {})
+
+    def retrieve_model_properties_from_edb(self):
+        c_p = self._pyedb_obj.component_property
+        model = c_p.GetModel().Clone()
+
+        if model.GetModelType().ToString() == "NetlistModel":
+            self.netlist_model["netlist"] = model.GetNetlist()
+        elif model.GetModelType().ToString() == "PinPairModel":
+            temp = {}
+            for i in model.PinPairs:
+                temp["first_pin"] = i.FirstPin
+                temp["second_pin"] = i.SecondPin
+                rlc = model.GetPinPairRlc(i)
+                temp["is_parallel"] = rlc.IsParallel
+                temp["resistance"] = rlc.R.ToString()
+                temp["resistance_enabled"] = rlc.REnabled
+                temp["inductance"] = rlc.L.ToString()
+                temp["inductance_enabled"] = rlc.LEnabled
+                temp["capacitance"] = rlc.C.ToString()
+                temp["capacitance_enabled"] = rlc.CEnabled
+                self.pin_pair_model.append(temp)
+        elif model.GetModelType().ToString() == "SParameterModel":
+            self.s_parameter_model["reference_net"] = model.GetReferenceNet()
+            self.s_parameter_model["model_name"] = model.GetComponentModelName()
+        elif model.GetModelType().ToString() == "SPICEModel":
+            self.spice_model["model_name"] = model.GetModelName()
+            self.spice_model["model_path"] = model.GetModelPath()
+            self.spice_model["sub_circuit"] = model.GetSubCkt()
+            self.spice_model["terminal_pairs"] = [[i, j] for i, j in dict(model.GetTerminalPinPairs()).items()]
+
+    def _set_model_properties_to_edb(self):
+        c_p = self._pyedb_obj.component_property
+        if self.netlist_model:
+            m = self._pedb._edb.Cell.Hierarchy.SParameterModel()
+            m.SetNetlist(self.netlist_model["netlist"])
+            c_p.SetModel(m)
+            self.component_property = c_p
+        elif self.pin_pair_model:
+            m = self._pedb._edb.Cell.Hierarchy.PinPairModel()
+            for i in self.pin_pair_model:
+                p = self._pedb._edb.Utility.PinPair(str(i["first_pin"]), str(i["second_pin"]))
+                rlc = self._pedb._edb.Utility.Rlc(
+                    self._pedb.edb_value(i["resistance"]),
+                    i["resistance_enabled"],
+                    self._pedb.edb_value(i["inductance"]),
+                    i["inductance_enabled"],
+                    self._pedb.edb_value(i["capacitance"]),
+                    i["capacitance_enabled"],
+                    i["is_parallel"],
+                )
+                m.SetPinPairRlc(p, rlc)
+            c_p.SetModel(m)
+            self._pyedb_obj.component_property = c_p
+        elif self.s_parameter_model:
+            m = self._pedb._edb.Cell.Hierarchy.SParameterModel()
+            m.SetComponentModelName(self.s_parameter_model["model_name"])
+            m.SetReferenceNet(self.s_parameter_model["reference_net"])
+            c_p.SetModel(m)
+            self.component_property = c_p
+        elif self.spice_model:
+            self._pyedb_obj.assign_spice_model(
+                self.spice_model["model_path"],
+                self.spice_model["model_name"],
+                self.spice_model["sub_circuit"],
+                self.spice_model["terminal_pairs"],
+            )
+
+    def _retrieve_ic_die_properties_from_edb(self):
+        temp = dict()
+        cp = self._pyedb_obj.component_property
+        ic_die_prop = cp.GetDieProperty().Clone()
+        die_type = pascal_to_snake(ic_die_prop.GetType().ToString())
+        temp["type"] = die_type
+        if not die_type == "no_die":
+            temp["orientation"] = pascal_to_snake(ic_die_prop.GetOrientation().ToString())
+            if die_type == "wire_bond":
+                temp["height"] = ic_die_prop.GetHeightValue().ToString()
+        self.ic_die_properties = temp
+
+    def _set_ic_die_properties_to_edb(self):
+        cp = self._pyedb_obj.component_property
+        ic_die_prop = cp.GetDieProperty().Clone()
+        die_type = self.ic_die_properties.get("type")
+        ic_die_prop.SetType(getattr(self._pedb._edb.Definition.DieType, snake_to_pascal(die_type)))
+        if not die_type == "no_die":
+            orientation = self.ic_die_properties.get("orientation")
+            if orientation:
+                ic_die_prop.SetOrientation(
+                    getattr(self._pedb._edb.Definition.DieOrientation, snake_to_pascal(orientation))
+                )
+            if die_type == "wire_bond":
+                height = self.ic_die_properties.get("height")
+                if height:
+                    ic_die_prop.SetHeight(self._pedb.edb_value(height))
+        cp.SetDieProperty(ic_die_prop)
+        self._pyedb_obj.component_property = cp
+
+    def _retrieve_solder_ball_properties_from_edb(self):
+        temp = dict()
+        cp = self._pyedb_obj.component_property
+        solder_ball_prop = cp.GetSolderBallProperty().Clone()
+        _, diam, mid_diam = solder_ball_prop.GetDiameterValue()
+        height = solder_ball_prop.GetHeightValue().ToString()
+        shape = solder_ball_prop.GetShape().ToString()
+        uses_solder_ball = solder_ball_prop.UsesSolderball()
+        temp["uses_solder_ball"] = uses_solder_ball
+        temp["shape"] = pascal_to_snake(shape)
+        temp["diameter"] = diam.ToString()
+        temp["mid_diameter"] = mid_diam.ToString()
+        temp["height"] = height
+        self.solder_ball_properties = temp
+
+    def _set_solder_ball_properties_to_edb(self):
+        cp = self._pyedb_obj.component_property
+        solder_ball_prop = cp.GetSolderBallProperty().Clone()
+        shape = self.solder_ball_properties.get("shape")
+        if shape:
+            solder_ball_prop.SetShape(getattr(self._pedb._edb.Definition.SolderballShape, snake_to_pascal(shape)))
+        else:
+            return
+
+        if shape == "cylinder":
+            diameter = self.solder_ball_properties["diameter"]
+            solder_ball_prop.SetDiameter(self._pedb.edb_value(diameter), self._pedb.edb_value(diameter))
+        elif shape == "spheroid":
+            diameter = self.solder_ball_properties["diameter"]
+            mid_diameter = self.solder_ball_properties["mid_diameter"]
+            solder_ball_prop.SetDiameter(self._pedb.edb_value(diameter), self._pedb.edb_value(mid_diameter))
+        else:
+            raise ValueError("Solderball shape must be either cylinder or spheroid")
+        solder_ball_prop.SetHeight(self._pedb.edb_value(self.solder_ball_properties["height"]))
+        cp.SetSolderBallProperty(solder_ball_prop)
+        self._pyedb_obj.component_property = cp
+
+    def _retrieve_port_properties_from_edb(self):
+        temp = dict()
+        cp = self._pyedb_obj.component_property
+        c_type = self.type.lower()
+        if c_type not in ["ic", "io", "other"]:
+            return
+        else:
+            port_prop = cp.GetPortProperty().Clone()
+            reference_height = port_prop.GetReferenceHeightValue().ToString()
+            reference_size_auto = port_prop.GetReferenceSizeAuto()
+            _, reference_size_x, reference_size_y = port_prop.GetReferenceSize()
+            temp["reference_height"] = reference_height
+            temp["reference_size_auto"] = reference_size_auto
+            temp["reference_size_x"] = str(reference_size_x)
+            temp["reference_size_y"] = str(reference_size_y)
+            self.port_properties = temp
+
+    def _set_port_properties_to_edb(self):
+        cp = self._pyedb_obj.component_property
+        port_prop = cp.GetPortProperty().Clone()
+        height = self.port_properties.get("reference_height")
+        if height:
+            port_prop.SetReferenceHeight(self._pedb.edb_value(height))
+        reference_size_auto = self.port_properties.get("reference_size_auto")
+        if reference_size_auto:
+            port_prop.SetReferenceSizeAuto(reference_size_auto)
+        reference_size_x = self.port_properties.get("reference_size_x", 0)
+        reference_size_y = self.port_properties.get("reference_size_y", 0)
+        port_prop.SetReferenceSize(self._pedb.edb_value(reference_size_x), self._pedb.edb_value(reference_size_y))
+        cp.SetPortProperty(port_prop)
+        self._pyedb_obj.component_property = cp
+
+    def set_parameters_to_edb(self):
+        if self.enabled:
+            self._pyedb_obj.enabled = self.enabled
+        if self.type:
+            self._pyedb_obj.type = self.type
+
+        self._set_model_properties_to_edb()
+        if self._pyedb_obj.type.lower() == "ic":
+            self._set_ic_die_properties_to_edb()
+            self._set_port_properties_to_edb()
+        elif self._pyedb_obj.type.lower() in ["io", "other"]:
+            self._set_solder_ball_properties_to_edb()
+            self._set_port_properties_to_edb()
+
+    def retrieve_parameters_from_edb(self):
+        self.type = self._pyedb_obj.type
+        self.definition = self._pyedb_obj.part_name
+        self.reference_designator = self._pyedb_obj.name
+        self.retrieve_model_properties_from_edb()
+        if self._pyedb_obj.type.lower() == "ic":
+            self._retrieve_ic_die_properties_from_edb()
+            self._retrieve_port_properties_from_edb()
+        elif self._pyedb_obj.type.lower() in ["io", "other"]:
+            self._retrieve_solder_ball_properties_from_edb()
+            self._retrieve_port_properties_from_edb()
 
 
 class CfgComponents:
     def __init__(self, pedb, components_data):
         self._pedb = pedb
-        self.components = [CfgComponent(**comp) for comp in components_data]
+        self.components = []
+
+        if components_data:
+            for comp in components_data:
+                obj = self._pedb.layout.find_component_by_name(comp["reference_designator"])
+                self.components.append(CfgComponent(self._pedb, obj, **comp))
+
+    def clean(self):
+        self.components = []
 
     def apply(self):
-        comps_in_db = self._pedb.components
         for comp in self.components:
-            c_db = comps_in_db.instances[comp.reference_designator]
-            if comp.definition:
-                c_db.definition = comp.definition
-            if comp.type:
-                c_db.type = comp.type
-            if comp.solder_ball_properties:
-                c_db.solder_ball_properties = comp.solder_ball_properties
-            if comp.port_properties:
-                c_db.port_properties = comp.port_properties
-            if comp.ic_die_properties:
-                c_db.ic_die_properties = comp.ic_die_properties
-            if comp.pin_pair_model:
-                c_db.model_properties = {"pin_pair_model": comp.pin_pair_model}
-            if comp.spice_model:
-                c_db.model_properties = {"spice_model": comp.spice_model}
-            if comp.s_parameter_model:
-                c_db.model_properties = {"s_parameter_model": comp.s_parameter_model}
-
-    def _load_data_from_db(self):
-        self.components = []
+            comp.set_parameters_to_edb()
+
+    def retrieve_parameters_from_edb(self):
+        self.clean()
         comps_in_db = self._pedb.components
         for _, comp in comps_in_db.instances.items():
-            cfg_comp = CfgComponent(
-                enabled=comp.enabled,
-                reference_designator=comp.name,
-                part_type=comp.type,
-                pin_pair_model=comp.model_properties.get("pin_pair_model"),
-                spice_model=comp.model_properties.get("spice_model"),
-                s_parameter_model=comp.model_properties.get("s_parameter_model"),
-                definition=comp.component_def,
-                location=comp.location,
-                placement_layer=comp.placement_layer,
-                solder_ball_properties=comp.solder_ball_properties,
-                ic_die_properties=comp.ic_die_properties,
-                port_properties=comp.port_properties,
-            )
+            cfg_comp = CfgComponent(self._pedb, comp)
+            cfg_comp.retrieve_parameters_from_edb()
             self.components.append(cfg_comp)
-
-    def get_data_from_db(self):
-        self._load_data_from_db()
-        data = []
-        for comp in self.components:
-            data.append(comp.get_attributes())
-        return data

pyedb/configuration/cfg_data.py

@@ -22,8 +22,10 @@
 
 
 from pyedb.configuration.cfg_boundaries import CfgBoundaries
+from pyedb.configuration.cfg_common import CfgVariables
 from pyedb.configuration.cfg_components import CfgComponents
 from pyedb.configuration.cfg_general import CfgGeneral
+from pyedb.configuration.cfg_modeler import CfgModeler
 from pyedb.configuration.cfg_nets import CfgNets
 from pyedb.configuration.cfg_operations import CfgOperations
 from pyedb.configuration.cfg_package_definition import CfgPackageDefinitions
@@ -72,3 +74,7 @@ class CfgData(object):
 
         self.package_definitions = CfgPackageDefinitions(self._pedb, data=kwargs.get("package_definitions", []))
         self.operations = CfgOperations(self._pedb, data=kwargs.get("operations", []))
+
+        self.modeler = CfgModeler(self._pedb, data=kwargs.get("modeler", {}))
+
+        self.variables = CfgVariables(self._pedb, data=kwargs.get("variables", []))

pyedb/configuration/cfg_modeler.py

@@ -0,0 +1,139 @@
+# 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.configuration.cfg_components import CfgComponent
+from pyedb.configuration.cfg_padstacks import CfgPadstackDefinition, CfgPadstackInstance
+from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstack
+
+
+class CfgTrace:
+    def __init__(self, **kwargs):
+        self.name = kwargs.get("name", "")
+        self.layer = kwargs["layer"]
+        self.path = kwargs["path"]
+        self.width = kwargs["width"]
+        self.net_name = kwargs.get("net_name", "")
+        self.start_cap_style = kwargs.get("start_cap_style", "round")
+        self.end_cap_style = kwargs.get("end_cap_style", "round")
+        self.corner_style = kwargs.get("corner_style", "sharp")
+
+
+class CfgPlane:
+    def __init__(self, **kwargs):
+        self.name = kwargs.get("name", "")
+        self.layer = kwargs["layer"]
+        self.net_name = kwargs.get("net_name", "")
+        self.type = kwargs.get("type", "rectangle")
+
+        # rectangle
+        self.lower_left_point = kwargs.get("lower_left_point", [])
+        self.upper_right_point = kwargs.get("upper_right_point", [])
+        self.corner_radius = kwargs.get("corner_radius", 0)
+        self.rotation = kwargs.get("rotation", 0)
+        self.voids = kwargs.get("voids", [])
+
+        # polygon
+        self.points = kwargs.get("points", [])
+
+
+class CfgModeler:
+    """Manage configuration general settings."""
+
+    def __init__(self, pedb, data):
+        self._pedb = pedb
+        self.traces = [CfgTrace(**i) for i in data.get("traces", [])]
+        self.padstack_defs = [
+            CfgPadstackDefinition(self._pedb, None, **i) for i in data.get("padstack_definitions", [])
+        ]
+        self.padstack_instances = [
+            CfgPadstackInstance(self._pedb, None, **i) for i in data.get("padstack_instances", [])
+        ]
+        self.planes = [CfgPlane(**i) for i in data.get("planes", [])]
+        self.components = [CfgComponent(self._pedb, None, **i) for i in data.get("components", [])]
+
+    def apply(self):
+        if self.traces:
+            for t in self.traces:
+                obj = self._pedb.modeler.create_trace(
+                    path_list=t.path,
+                    layer_name=t.layer,
+                    net_name=t.net_name,
+                    width=t.width,
+                    start_cap_style=t.start_cap_style,
+                    end_cap_style=t.end_cap_style,
+                    corner_style=t.corner_style,
+                )
+                obj.aedt_name = t.name
+
+        if self.padstack_defs:
+            for p in self.padstack_defs:
+                pdata = self._pedb._edb.Definition.PadstackDefData.Create()
+                pdef = self._pedb._edb.Definition.PadstackDef.Create(self._pedb.active_db, p.name)
+                pdef.SetData(pdata)
+                pdef = EDBPadstack(pdef, self._pedb.padstacks)
+                p._pyedb_obj = pdef
+                p.set_parameters_to_edb()
+
+        if self.padstack_instances:
+            for p in self.padstack_instances:
+                p_inst = self._pedb.padstacks.place(
+                    via_name=p.name,
+                    position=p.position,
+                    definition_name=p.definition,
+                )
+                p._pyedb_obj = p_inst
+                p.set_parameters_to_edb()
+
+        if self.planes:
+            for p in self.planes:
+                if p.type == "rectangle":
+                    obj = self._pedb.modeler.create_rectangle(
+                        layer_name=p.layer,
+                        net_name=p.net_name,
+                        lower_left_point=p.lower_left_point,
+                        upper_right_point=p.upper_right_point,
+                        corner_radius=p.corner_radius,
+                        rotation=p.rotation,
+                    )
+                    obj.aedt_name = p.name
+                elif p.type == "polygon":
+                    obj = self._pedb.modeler.create_polygon(
+                        main_shape=p.points, layer_name=p.layer, net_name=p.net_name
+                    )
+                    obj.aedt_name = p.name
+
+                for v in p.voids:
+                    for i in self._pedb.layout.primitives:
+                        if i.aedt_name == v:
+                            self._pedb.modeler.add_void(obj, i)
+
+        if self.components:
+            pedb_p_inst = self._pedb.padstacks.instances_by_name
+            for c in self.components:
+                obj = self._pedb.components.create(
+                    [pedb_p_inst[i] for i in c.pins],
+                    component_name=c.reference_designator,
+                    placement_layer=c.placement_layer,
+                    component_part_name=c.definition,
+                )
+                c._pyedb_obj = obj
+                c.set_parameters_to_edb()

pyedb/configuration/cfg_operations.py

@@ -60,10 +60,11 @@ class CfgCutout(CfgBase):
 
                 net_names = []
                 for name, obj in self._pedb.nets.nets.items():
-                    if obj.primitives[0].layer.name == "pyedb_cutout":
-                        continue
-                    if len(obj.primitives) > 0:
-                        net_names.append(name)
+                    if obj.primitives:
+                        if obj.primitives[0].layer.name == "pyedb_cutout":
+                            continue
+                        else:
+                            net_names.append(name)
 
                 self.reference_list = []
                 self.signal_list = net_names