pyedb 0.11.2__tar.gz → 0.12.0__tar.gz

{pyedb-0.11.2 → pyedb-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyedb
-Version: 0.11.2
+Version: 0.12.0
 Summary: Higher-Level Pythonic Ansys Electronics Data Base
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: PyEDB developers <simon.vandenbrouck@ansys.com>

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/__init__.py

@@ -44,7 +44,7 @@ deprecation_warning()
 #
 
 pyedb_path = os.path.dirname(__file__)
-__version__ = "0.11.2"
+__version__ = "0.12.0"
 version = __version__
 
 #

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/configuration/cfg_boundaries.py

@@ -27,25 +27,25 @@ class CfgBoundaries:
     def __init__(self, pdata, boundaries_dict):
         self._pedb = pdata.pedb
         self._boundaries_dict = boundaries_dict
-        self.open_region = self._boundaries_dict.get("open_region", True)
+        self.open_region = self._boundaries_dict.get("open_region", None)
         self._map_open_region_type()
-        self.pml_visible = self._boundaries_dict.get("pml_visible", False)
-        self.pml_operation_frequency = self._boundaries_dict.get("pml_operation_frequency", "5GHz")
-        self.pml_radiation_factor = self._boundaries_dict.get("pml_radiation_factor", 10)
+        self.pml_visible = self._boundaries_dict.get("pml_visible", None)
+        self.pml_operation_frequency = self._boundaries_dict.get("pml_operation_frequency", None)
+        self.pml_radiation_factor = self._boundaries_dict.get("pml_radiation_factor", None)
         self._map_dielectric_extend_type()
-        self.dielectric_base_polygon = self._boundaries_dict.get("dielectric_base_polygon", "")
-        self.horizontal_padding = self._boundaries_dict.get("horizontal_padding", 0.0)
+        self.dielectric_base_polygon = self._boundaries_dict.get("dielectric_base_polygon", None)
+        self.horizontal_padding = self._boundaries_dict.get("horizontal_padding", None)
         self.honor_primitives_on_dielectric_layers = self._boundaries_dict.get(
             "honor_primitives_on_dielectric_layers", False
         )
         self._map_air_box_extend_type()
-        self.air_box_base_polygon = self._boundaries_dict.get("air_box_base_polygon", "")
+        self.air_box_base_polygon = self._boundaries_dict.get("air_box_base_polygon", None)
         self.air_box_truncate_model_ground_layers = self._boundaries_dict.get(
-            "air_box_truncate_model_ground_layers", False
+            "air_box_truncate_model_ground_layers", None
         )
-        self.air_box_horizontal_padding = self._boundaries_dict.get("air_box_horizontal_padding", 0.15)
-        self.air_box_positive_vertical_padding = self._boundaries_dict.get("air_box_positive_vertical_padding", 1)
-        self.air_box_negative_vertical_padding = self._boundaries_dict.get("air_box_negative_vertical_padding", 1)
+        self.air_box_horizontal_padding = self._boundaries_dict.get("air_box_horizontal_padding", None)
+        self.air_box_positive_vertical_padding = self._boundaries_dict.get("air_box_positive_vertical_padding", None)
+        self.air_box_negative_vertical_padding = self._boundaries_dict.get("air_box_negative_vertical_padding", None)
 
     def _map_air_box_extend_type(self):
         air_box_type = self._boundaries_dict.get("air_box_extents_type", None)
@@ -94,22 +94,32 @@ class CfgBoundaries:
 
     def apply(self):
         """Imports boundary information from JSON."""
-        self._pedb.hfss.hfss_extent_info.use_open_region = self.open_region
+        if self.open_region is not None:
+            self._pedb.hfss.hfss_extent_info.use_open_region = self.open_region
         self._pedb.hfss.hfss_extent_info.open_region_type = self.open_region_type.name.lower()
-        self._pedb.hfss.hfss_extent_info.is_pml_visible = self.pml_visible
-        self._pedb.hfss.hfss_extent_info.operating_freq = self.pml_operation_frequency
-        self._pedb.hfss.hfss_extent_info.radiation_level = self.pml_radiation_factor
+        if self.pml_visible is not None:
+            self._pedb.hfss.hfss_extent_info.is_pml_visible = self.pml_visible
+        if self.pml_operation_frequency:
+            self._pedb.hfss.hfss_extent_info.operating_freq = self.pml_operation_frequency
+        if self.pml_radiation_factor:
+            self._pedb.hfss.hfss_extent_info.radiation_level = self.pml_radiation_factor
         self._pedb.hfss.hfss_extent_info.extent_type = self.dielectric_extents_type.name.lower()
         if self.dielectric_base_polygon:
             self._pedb.hfss.hfss_extent_info.dielectric_base_polygon = self.dielectric_base_polygon
-        self._pedb.hfss.hfss_extent_info.dielectric_extent_size = float(self.horizontal_padding)
-        self._pedb.hfss.hfss_extent_info.honor_user_dielectric = self.honor_primitives_on_dielectric_layers
+        if self.horizontal_padding:
+            self._pedb.hfss.hfss_extent_info.dielectric_extent_size = float(self.horizontal_padding)
+        if self.honor_primitives_on_dielectric_layers is not None:
+            self._pedb.hfss.hfss_extent_info.honor_user_dielectric = self.honor_primitives_on_dielectric_layers
         self._pedb.hfss.hfss_extent_info.extent_type = self.air_box_extents_type.name.lower()
-        self._pedb.hfss.hfss_extent_info.truncate_air_box_at_ground = self.air_box_truncate_model_ground_layers
-        self._pedb.hfss.hfss_extent_info.air_box_horizontal_extent = float(self.air_box_horizontal_padding)
-        self._pedb.hfss.hfss_extent_info.air_box_positive_vertical_extent = float(
-            self.air_box_positive_vertical_padding
-        )
-        self._pedb.hfss.hfss_extent_info.air_box_negative_vertical_extent = float(
-            self.air_box_negative_vertical_padding
-        )
+        if self.air_box_truncate_model_ground_layers is not None:
+            self._pedb.hfss.hfss_extent_info.truncate_air_box_at_ground = self.air_box_truncate_model_ground_layers
+        if self.air_box_horizontal_padding:
+            self._pedb.hfss.hfss_extent_info.air_box_horizontal_extent = float(self.air_box_horizontal_padding)
+        if self.air_box_positive_vertical_padding:
+            self._pedb.hfss.hfss_extent_info.air_box_positive_vertical_extent = float(
+                self.air_box_positive_vertical_padding
+            )
+        if self.air_box_negative_vertical_padding:
+            self._pedb.hfss.hfss_extent_info.air_box_negative_vertical_extent = float(
+                self.air_box_negative_vertical_padding
+            )

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/configuration/cfg_padstacks.py

@@ -54,20 +54,24 @@ class Definition:
     def __init__(self, pdata, definition_dict):
         self._pedb = pdata.pedb
         self._definition_dict = definition_dict
-        self.name = self._definition_dict.get("name", "")
-        self.hole_diameter = self._definition_dict.get("hole_diameter", "")
-        self.hole_plating_thickness = self._definition_dict.get("hole_plating_thickness", "")
-        self.hole_material = self._definition_dict.get("hole_material", "")
-        self.hole_range = self._definition_dict.get("hole_range", "")
+        self.name = self._definition_dict.get("name", None)
+        self.hole_diameter = self._definition_dict.get("hole_diameter", None)
+        self.hole_plating_thickness = self._definition_dict.get("hole_plating_thickness", None)
+        self.hole_material = self._definition_dict.get("hole_material", None)
+        self.hole_range = self._definition_dict.get("hole_range", None)
 
     def apply(self):
         """Apply padstack definition on layout."""
         padstack_defs = self._pedb.padstacks.definitions
         pdef = padstack_defs[self.name]
-        pdef.hole_diameter = self.hole_diameter
-        pdef.hole_plating_thickness = self.hole_plating_thickness
-        pdef.material = self.hole_material
-        pdef.hole_range = self.hole_range
+        if self.hole_diameter:
+            pdef.hole_diameter = self.hole_diameter
+        if self.hole_plating_thickness:
+            pdef.hole_plating_thickness = self.hole_plating_thickness
+        if self.hole_material:
+            pdef.material = self.hole_material
+        if self.hole_range:
+            pdef.hole_range = self.hole_range
 
 
 class Instance:

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/configuration/cfg_ports_sources.py

@@ -41,8 +41,8 @@ class CfgCircuitElement:
         self.neg_term_info = kwargs.get("negative_terminal", None)
 
     @pyedb_function_handler
-    def _create(self):
-        """Create step 1."""
+    def _create_terminals(self):
+        """Create step 1. Collect positive and negative terminals."""
         pos_term_info = self.pos_term_info
         if pos_term_info:
             pos_type, pos_value = [[i, j] for i, j in pos_term_info.items()][0]
@@ -71,16 +71,26 @@ class CfgCircuitElement:
         self.neg_terminal = None
         if neg_term_info:
             neg_type, neg_value = [[i, j] for i, j in neg_term_info.items()][0]
-            if neg_type == "pin_group":
-                pin_group = {neg_value: self.pedb.siwave.pin_groups[neg_value]}
+            if neg_type == "nearest_pin":
+                ref_net = neg_value.get("reference_net", "GND")
+                search_radius = neg_value.get("search_radius", "5e-3")
+                temp = dict()
+                for i, j in pos_objs.items():
+                    temp[i] = self._pdata.pedb.padstacks.get_reference_pins(j, ref_net, search_radius, max_limit=1)[0]
+                self.neg_terminal = {
+                    i: j.create_terminal(i + "_ref") if not j.terminal else j.terminal for i, j in temp.items()
+                }
             else:
-                # Get pins
-                pins = self._get_pins(neg_type, neg_value)  # terminal type pin or net
-                # create pin group
-                pin_group = self._create_pin_group(pins, True)
-            self.neg_terminal = [j.create_terminal(i) if not j.terminal else j.terminal for i, j in pin_group.items()][
-                0
-            ]
+                if neg_type == "pin_group":
+                    pin_group = {neg_value: self.pedb.siwave.pin_groups[neg_value]}
+                else:
+                    # Get pins
+                    pins = self._get_pins(neg_type, neg_value)  # terminal type pin or net
+                    # create pin group
+                    pin_group = self._create_pin_group(pins, True)
+                self.neg_terminal = [
+                    j.create_terminal(i) if not j.terminal else j.terminal for i, j in pin_group.items()
+                ][0]
 
     @pyedb_function_handler
     def _get_pins(self, terminal_type, terminal_value):
@@ -125,11 +135,14 @@ class CfgPort(CfgCircuitElement):
     @pyedb_function_handler
     def create(self):
         """Create port."""
-        self._create()
+        self._create_terminals()
         is_circuit_port = True if self.type == "circuit" else False
         circuit_elements = []
-        for _, j in self.pos_terminals.items():
-            elem = self.pedb.create_port(j, self.neg_terminal, is_circuit_port)
+        for name, j in self.pos_terminals.items():
+            if isinstance(self.neg_terminal, dict):
+                elem = self.pedb.create_port(j, self.neg_terminal[name], is_circuit_port)
+            else:
+                elem = self.pedb.create_port(j, self.neg_terminal, is_circuit_port)
             if not self.distributed:
                 elem.name = self.name
             circuit_elements.append(elem)
@@ -148,12 +161,15 @@ class CfgSources(CfgCircuitElement):
     @pyedb_function_handler
     def create(self):
         """Create sources."""
-        self._create()
+        self._create_terminals()
         is_circuit_port = True if self.type == "circuit" else False
         circuit_elements = []
         method = self.pedb.create_current_source if self.type == "current" else self.pedb.create_voltage_source
-        for _, j in self.pos_terminals.items():
-            elem = method(j, self.neg_terminal)
+        for name, j in self.pos_terminals.items():
+            if isinstance(self.neg_terminal, dict):
+                elem = method(j, self.neg_terminal[name])
+            else:
+                elem = method(j, self.neg_terminal)
             if not self.distributed:
                 elem.name = self.name
                 elem.magnitude = self.magnitude

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/dotnet/edb.py

@@ -3702,12 +3702,10 @@ class Edb(Database):
             self.logger.error("Setup name already used in the layout")
             return False
         version = self.edbversion.split(".")
-        if int(version[0]) == 2024 and int(version[-1]) >= 2 or int(version[0]) > 2024:
-            setup = HFSSPISimulationSetup(self).create(name)
-            return setup
-        else:
+        if float(self.edbversion) < 2024.2:
             self.logger.error("HFSSPI simulation only supported with Ansys release 2024R2 and higher")
             return False
+        return HFSSPISimulationSetup(self).create(name)
 
     @pyedb_function_handler()
     def create_siwave_syz_setup(self, name=None):

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/dotnet/edb_core/edb_data/hfss_simulation_setup_data.py

@@ -977,19 +977,18 @@ class ViaSettings(object):
         -------
         bool
         """
-        if self._parent._pedb.version[0] >= 10:
-            return self._via_settings.ViaMeshPlating
-        else:
+        if float(self._parent._pedb.edbversion) < 2024.1:
             self._parent._pedb.logger.error("Property only supported on Ansys release 2024R1 and later")
             return False
+        return self._via_settings.ViaMeshPlating
 
     @via_mesh_plating.setter
     def via_mesh_plating(self, value):
-        if self._parent._pedb.version[0] >= 10:
+        if float(self._parent._pedb.edbversion) < 2024.1:
+            self._parent._pedb.logger.error("Property only supported on Ansys release 2024R1 and later")
+        else:
             self._via_settings.ViaMeshPlating = value
             self._parent._update_setup()
-        else:
-            self._parent._pedb.logger.error("Property only supported on Ansys release 2024R1 and later")
 
     @property
     def via_material(self):

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/dotnet/edb_core/edb_data/padstacks_data.py

@@ -1183,7 +1183,7 @@ class EDBPadstackInstance(EDBPrimitivesMain):
         -------
         :class:`pyedb.dotnet.edb_core.edb_data.terminals`
         """
-
+        warnings.warn("Use new property :func:`terminal` instead.", DeprecationWarning)
         if create_new_terminal:
             term = self._create_terminal(name)
         else:
@@ -1195,6 +1195,14 @@ class EDBPadstackInstance(EDBPrimitivesMain):
         if not term.is_null:
             return term
 
+    @property
+    def terminal(self):
+        """Terminal."""
+        from pyedb.dotnet.edb_core.edb_data.terminals import PadstackInstanceTerminal
+
+        term = PadstackInstanceTerminal(self._pedb, self._edb_object.GetPadstackInstanceTerminal())
+        return term if not term.is_null else None
+
     @pyedb_function_handler()
     def _create_terminal(self, name=None):
         """Create a padstack instance terminal"""

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/dotnet/edb_core/siwave.py

@@ -1259,6 +1259,7 @@ class EdbSiwave(object):
         )
 
         if edb_pingroup.IsNull():  # pragma: no cover
+            self._logger.error(f"Failed to create pin group {group_name}.")
             return False
         else:
             names = [i for i in pins if i.GetNet().GetName()]

{pyedb-0.11.2 → pyedb-0.12.0}/src/pyedb/dotnet/edb_core/utilities/simulation_setup.py

@@ -36,6 +36,7 @@ class BaseSimulationSetup(object):
         EDB object.
     """
 
+    @pyedb_function_handler
     def __init__(self, pedb, edb_setup=None):
         self._pedb = pedb
         self._edb_object = edb_setup
@@ -59,7 +60,7 @@ class BaseSimulationSetup(object):
         }
 
         version = self._pedb.edbversion.split(".")
-        if int(version[0]) == 2024 and int(version[1]) == 2 or int(version[0]) > 2024:
+        if float(self._pedb.edbversion) >= 2024.2:
             self._setup_type_mapping.update(
                 {
                     "kRaptorX": self._pedb.simsetupdata.RaptorX.RaptorXSimulationSettings,