pyedb 0.52.0__py3-none-any.whl → 0.53.0__py3-none-any.whl

pyedb/configuration/cfg_stackup.py

@@ -19,272 +19,85 @@
 # 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 typing import List, Optional, Union
 
-from pyedb import Edb
-from pyedb.configuration.cfg_common import CfgBase
+from pydantic import BaseModel, Field
 
 
-class CfgMaterialPropertyThermalModifier:
-    def __init__(self, **kwargs):
-        self.property_name = kwargs["property_name"]
-        self.basic_quadratic_c1 = kwargs.get("basic_quadratic_c1", 0)
-        self.basic_quadratic_c2 = kwargs.get("basic_quadratic_c2", 0)
-        self.basic_quadratic_temperature_reference = kwargs.get("basic_quadratic_temperature_reference", 22)
-        self.advanced_quadratic_lower_limit = kwargs.get("advanced_quadratic_lower_limit", -273.15)
-        self.advanced_quadratic_upper_limit = kwargs.get("advanced_quadratic_upper_limit", 1000)
+class CfgMaterialPropertyThermalModifier(BaseModel):
+    property_name: str
+    basic_quadratic_c1: float = 0
+    basic_quadratic_c2: float = 0
+    basic_quadratic_temperature_reference: float = 22
+    advanced_quadratic_lower_limit: float = -273.15
+    advanced_quadratic_upper_limit: float = 1000
+    advanced_quadratic_auto_calculate: bool = True
+    advanced_quadratic_lower_constant: float = 1
+    advanced_quadratic_upper_constant: float = 1
 
-        self.advanced_quadratic_auto_calculate = kwargs.get("advanced_quadratic_auto_calculate", True)
-        self.advanced_quadratic_lower_constant = kwargs.get("advanced_quadratic_lower_constant", 1)
-        self.advanced_quadratic_upper_constant = kwargs.get("advanced_quadratic_upper_constant", 1)
 
-    def to_dict(self):
-        return {
-            "property_name": self.property_name,
-            "basic_quadratic_c1": self.basic_quadratic_c1,
-            "basic_quadratic_c2": self.basic_quadratic_c2,
-            "basic_quadratic_temperature_reference": self.basic_quadratic_temperature_reference,
-            "advanced_quadratic_lower_limit": self.advanced_quadratic_lower_limit,
-            "advanced_quadratic_upper_limit": self.advanced_quadratic_upper_limit,
-            "advanced_quadratic_auto_calculate": self.advanced_quadratic_auto_calculate,
-            "advanced_quadratic_lower_constant": self.advanced_quadratic_lower_constant,
-            "advanced_quadratic_upper_constant": self.advanced_quadratic_upper_constant,
-        }
+class MaterialProperties(BaseModel):
+    """Store material properties."""
 
+    conductivity: Optional[Union[str, float]] = None
+    dielectric_loss_tangent: Optional[Union[str, float]] = None
+    magnetic_loss_tangent: Optional[Union[str, float]] = None
+    mass_density: Optional[Union[str, float]] = None
+    permittivity: Optional[Union[str, float]] = None
+    permeability: Optional[Union[str, float]] = None
+    poisson_ratio: Optional[Union[str, float]] = None
+    specific_heat: Optional[Union[str, float]] = None
+    thermal_conductivity: Optional[Union[str, float]] = None
+    youngs_modulus: Optional[Union[str, float]] = None
+    thermal_expansion_coefficient: Optional[Union[str, float]] = None
+    dc_conductivity: Optional[Union[str, float]] = None
+    dc_permittivity: Optional[Union[str, float]] = None
+    dielectric_model_frequency: Optional[Union[str, float]] = None
+    loss_tangent_at_frequency: Optional[Union[str, float]] = None
+    permittivity_at_frequency: Optional[Union[str, float]] = None
 
-class CfgMaterial(CfgBase):
-    def __init__(self, **kwargs):
-        self.name = kwargs.get("name", None)
-        self.permittivity = kwargs.get("permittivity", None)
-        self.conductivity = kwargs.get("conductivity", None)
-        self.dielectric_loss_tangent = kwargs.get("dielectric_loss_tangent", None)
-        self.magnetic_loss_tangent = kwargs.get("magnetic_loss_tangent", None)
-        self.mass_density = kwargs.get("mass_density", None)
-        self.permeability = kwargs.get("permeability", None)
-        self.poisson_ratio = kwargs.get("poisson_ratio", None)
-        self.specific_heat = kwargs.get("specific_heat", None)
-        self.thermal_conductivity = kwargs.get("thermal_conductivity", None)
 
-        thermal_modifiers = kwargs.get("thermal_modifiers")
-        if thermal_modifiers:
-            self.thermal_modifiers = [CfgMaterialPropertyThermalModifier(**i) for i in thermal_modifiers]
+class CfgMaterial(MaterialProperties):
+    name: str
+    thermal_modifiers: Optional[list[CfgMaterialPropertyThermalModifier]] = None
 
 
-class CfgLayer(CfgBase):
-    def __init__(self, **kwargs):
-        self.name = kwargs.get("name", None)
-        self.type = kwargs.get("type", None)
-        self.material = kwargs.get("material", None)
-        self.fill_material = kwargs.get("fill_material", None)
-        self.thickness = kwargs.get("thickness", None)
-        self.roughness = kwargs.get("roughness", None)
-        self.etching = kwargs.get("etching", None)
+class RoughnessSideModel(BaseModel):
+    model: str
+    nodule_radius: Optional[str] = None  # e.g., '0.1um'
+    surface_ratio: Optional[str] = None  # e.g., '1'
+    roughness: Optional[str] = None  # e.g., '2um' for non-huray
 
 
-class CfgStackup:
-    class Grpc:
-        def __init__(self, parent):
-            self.parent = parent
-            self._pedb = parent._pedb
+class RoughnessModel(BaseModel):
+    enabled: Optional[bool] = False
+    top: Optional[RoughnessSideModel] = None
+    bottom: Optional[RoughnessSideModel] = None
+    side: Optional[RoughnessSideModel] = None
 
-        def apply(self):
-            """Apply configuration settings to the current design"""
-            if len(self.parent.materials):
-                self.__apply_materials()
 
-            input_signal_layers = [i for i in self.parent.layers if i.type.lower() == "signal"]
+class EtchingModel(BaseModel):
+    factor: Optional[Union[float, str]] = 0.5
+    etch_power_ground_nets: Optional[bool] = False
+    enabled: Optional[bool] = False
 
-            if len(self.parent.layers):
-                if len(self._pedb.stackup.signal_layers) == 0:
-                    self.__create_stackup()
-                elif not len(input_signal_layers) == len(self._pedb.stackup.signal_layers):
-                    raise Exception(f"Input signal layer count do not match.")
-                else:
-                    self.__apply_layers()
 
-        def __create_stackup(self):
-            layers = list()
-            layers.extend(self.parent.layers)
-            for l_attrs in layers:
-                attrs = l_attrs.get_attributes()
-                self._pedb.stackup.add_layer_bottom(**attrs)
+class CfgLayer(BaseModel):
+    name: Optional[str] = None
+    type: Optional[str] = None
+    material: Optional[str] = None
+    fill_material: Optional[str] = None
+    thickness: Optional[Union[float, str]] = None
+    roughness: Optional[RoughnessModel] = None
+    etching: Optional[EtchingModel] = None
 
-        def __apply_layers(self):
-            """Apply layer settings to the current design"""
-            layers = list()
-            layers.extend(self.parent.layers)
 
-            removal_list = []
-            lc_signal_layers = []
-            for name, obj in self._pedb.stackup.all_layers.items():
-                if obj.type == "dielectric":
-                    removal_list.append(name)
-                elif obj.type == "signal":
-                    lc_signal_layers.append(obj.id)
-            for l in removal_list:
-                self._pedb.stackup.remove_layer(l)
+class CfgStackup(BaseModel):
+    materials: List[CfgMaterial] = Field(default_factory=list)
+    layers: List[CfgLayer] = Field(default_factory=list)
 
-            # update all signal layers
-            id_name = {i[0]: i[1] for i in self._pedb.stackup.layers_by_id}
-            signal_idx = 0
-            for l in layers:
-                if l.type == "signal":
-                    layer_id = lc_signal_layers[signal_idx]
-                    layer_name = id_name[layer_id]
-                    attrs = l.get_attributes()
-                    self._pedb.stackup.layers[layer_name].update(**attrs)
-                    signal_idx = signal_idx + 1
+    def add_material(self, name, **kwargs):
+        self.materials.append(CfgMaterial(name=name, **kwargs))
 
-            # add all dielectric layers. Dielectric layers must be added last. Otherwise,
-            # dielectric layer will occupy signal and document layer id.
-            prev_layer_clone = None
-            l = layers.pop(0)
-            if l.type == "signal":
-                prev_layer_clone = self._pedb.stackup.layers[l.name]
-            else:
-                attrs = l.get_attributes()
-                prev_layer_clone = self._pedb.stackup.add_layer_top(**attrs)
-            for idx, l in enumerate(layers):
-                if l.type == "dielectric":
-                    attrs = l.get_attributes()
-                    prev_layer_clone = self._pedb.stackup.add_layer_below(
-                        base_layer_name=prev_layer_clone.name, **attrs
-                    )
-                elif l.type == "signal":
-                    prev_layer_clone = self._pedb.stackup.layers[l.name]
-
-        def __apply_materials(self):
-            """Apply material settings to the current design"""
-            materials_in_db = {i.lower(): i for i, _ in self._pedb.materials.materials.items()}
-            for mat_in_cfg in self.parent.materials:
-                if mat_in_cfg.name.lower() in materials_in_db:
-                    self._pedb.materials.delete_material(materials_in_db[mat_in_cfg.name.lower()])
-
-                attrs = mat_in_cfg.get_attributes()
-                mat = self._pedb.materials.add_material(**attrs)
-
-                for i in attrs.get("thermal_modifiers", []):
-                    mat.set_thermal_modifier(**i.to_dict())
-
-        def get_materials_from_db(self):
-            materials = []
-            for name, p in self._pedb.materials.materials.items():
-                mat = {}
-                for p_name in CfgMaterial().__dict__:
-                    mat[p_name] = getattr(p, p_name, None)
-                materials.append(mat)
-            return materials
-
-        def get_layers_from_db(self):
-            layers = []
-            for name, obj in self._pedb.stackup.all_layers.items():
-                layers.append(obj.properties)
-            return layers
-
-        def get_data_from_db(self):
-            """Get configuration data from layout.
-
-            Returns
-            -------
-            dict
-            """
-            stackup = {}
-            materials = self.get_materials_from_db()
-            stackup["materials"] = materials
-            layers = self.get_layers_from_db()
-            stackup["layers"] = layers
-            return stackup
-
-    class DotNet(Grpc):
-        def __init__(self, parent):
-            super().__init__(parent)
-
-        def __apply_layers(self):
-            """Apply layer settings to the current design"""
-            layers = list()
-            layers.extend(self.parent.layers)
-
-            removal_list = []
-            lc_signal_layers = []
-            for name, obj in self._pedb.stackup.all_layers.items():
-                if obj.type == "dielectric":
-                    removal_list.append(name)
-                elif obj.type == "signal":
-                    lc_signal_layers.append(obj.id)
-            for l in removal_list:
-                self._pedb.stackup.remove_layer(l)
-
-            # update all signal layers
-            id_name = {i[0]: i[1] for i in self._pedb.stackup.layers_by_id}
-            signal_idx = 0
-            for l in layers:
-                if l.type == "signal":
-                    layer_id = lc_signal_layers[signal_idx]
-                    layer_name = id_name[layer_id]
-                    attrs = l.get_attributes()
-                    self._pedb.stackup.layers[layer_name].update(**attrs)
-                    signal_idx = signal_idx + 1
-
-            # add all dielectric layers. Dielectric layers must be added last. Otherwise,
-            # dielectric layer will occupy signal and document layer id.
-            prev_layer_clone = None
-            l = layers.pop(0)
-            if l.type == "signal":
-                prev_layer_clone = self._pedb.stackup.layers[l.name]
-            else:
-                attrs = l.get_attributes()
-                prev_layer_clone = self._pedb.stackup.add_layer_top(**attrs)
-            for idx, l in enumerate(layers):
-                if l.type == "dielectric":
-                    attrs = l.get_attributes()
-                    prev_layer_clone = self._pedb.stackup.add_layer_below(
-                        base_layer_name=prev_layer_clone.name, **attrs
-                    )
-                elif l.type == "signal":
-                    prev_layer_clone = self._pedb.stackup.layers[l.name]
-
-    def __init__(self, pedb: Edb, data):
-        self._pedb = pedb
-        if self._pedb.grpc:
-            self.api = self.Grpc(self)
-        else:
-            self.api = self.DotNet(self)
-        self.materials = [CfgMaterial(**mat) for mat in data.get("materials", [])]
-        self.layers = [CfgLayer(**lay) for lay in data.get("layers", [])]
-
-        materials = [m.name for m in self.materials]
-        for i in self.layers:
-            if i.type == "signal":
-                if i.material not in materials:
-                    self.materials.append(
-                        CfgMaterial(name=i.material, **self._pedb.materials.default_conductor_property_values)
-                    )
-                    materials.append(i.material)
-                if i.fill_material not in materials:
-                    self.materials.append(
-                        CfgMaterial(name=i.fill_material, **self._pedb.materials.default_dielectric_property_values)
-                    )
-                    materials.append(i.fill_material)
-            elif i.type == "dielectric":
-                if i.material not in materials:
-                    self.materials.append(
-                        CfgMaterial(name=i.material, **self._pedb.materials.default_dielectric_property_values)
-                    )
-                    materials.append(i.material)
-
-    def apply(self):
-        self.api.apply()
-
-    def get_materials_from_db(self):
-        return self.api.get_materials_from_db()
-
-    def get_layers_from_db(self):
-        return self.api.get_layers_from_db()
-
-    def get_data_from_db(self):
-        """Get configuration data from layout.
-
-        Returns
-        -------
-        dict
-        """
-        return self.api.get_data_from_db()
+    def add_layer_at_bottom(self, name, **kwargs):
+        self.layers.append(CfgLayer(name=name, **kwargs))