Merge pull request #62 from ansys-internal/maint/integrate_prs_from_pyaedt

Integrate PRS from pyaedt

Author: SMoraisAnsys

.github/workflows/legacy_tests.yml

@@ -47,12 +47,8 @@ jobs:
 
       - name: "Executing legacy unit tests"
         run: |
-          pytest -m "legacy and unit" -n 6 -v
+          pytest -m "legacy and unit" -n auto -v
 
       - name: "Executing legacy system tests (distributing on multiple CPUs)"
         run: |
           pytest -m "legacy and system and not no_xdist" -n auto -v
-
-      - name: "Executing legacy system tests that cannot be distributed"
-        run: |
-          pytest -m "legacy and system and no_xdist" -v

doc/source/conf.py

@@ -318,6 +318,7 @@ def setup(app):
 # specify the location of your github repo
 html_theme_options = {
     "github_url": "https://github.com/ansys/pyaedt",
+    "navigation_with_keys": False,
     "show_prev_next": False,
     "show_breadcrumbs": True,
     "collapse_navigation": True,

examples/legacy/01_edb_example.py

@@ -133,7 +133,7 @@
 edb.siwave.create_current_source_on_net("IC2", "NetD3_2", "IC2", "GND", 1.0, 0, "I1")
 setup = edb.siwave.add_siwave_dc_analysis("myDCIR_4")
 setup.use_dc_custom_settings = True
-setup.dc_slider_position = 0
+setup.set_dc_slider = 0
 setup.add_source_terminal_to_ground("V1", 1)
 
 

pyproject.toml

@@ -153,6 +153,7 @@ show_missing = true
 
 [tool.pytest.ini_options]
 minversion = "7.1"
+xfail_strict = false
 filterwarnings = [
     "ignore::DeprecationWarning",
 ]
@@ -165,7 +166,7 @@ markers = [
     "no_licence: mark test that do not need a licence.",
 ]
 testpaths = "tests"
-addopts = "-ra --cov=src/pyedb --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv"
+#addopts = "-ra --cov=src/pyedb --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv"
 
 [tool.numpydoc_validation]
 checks = [

src/pyedb/grpc/components.py

@@ -1010,7 +1010,7 @@ def deactivate_rlc_component(self, component=None, create_circuit_port=False):
         >>> from pyedb.grpc.edb import Edb
         >>> edb_file = r'C:\my_edb_file.aedb'
         >>> edb = Edb(edb_file)
-        >>> for cmp in list(edb.components.components.keys()):
+        >>> for cmp in list(edb.components.instances.keys()):
         >>>     edb.components.deactivate_rlc_component(component=cmp, create_circuit_port=False)
         >>> edb.save_edb()
         >>> edb.close_edb()
@@ -1031,12 +1031,10 @@ def deactivate_rlc_component(self, component=None, create_circuit_port=False):
             self._logger.info("Component %s passed to deactivate is not an RLC.", component.refdes)
             return False
         component.is_enabled = False
-        if create_circuit_port:
-            return self.add_port_on_rlc_component(component.refdes)
-        return True
+        return self.add_port_on_rlc_component(component=component.refdes, circuit_ports=create_circuit_port)
 
     @pyedb_function_handler()
-    def add_port_on_rlc_component(self, component=None):
+    def add_port_on_rlc_component(self, component=None, circuit_ports=True):
         """Deactivate RLC component and replace it with a circuit port.
         The circuit port supports only 2-pin components.
 
@@ -1045,6 +1043,10 @@ def add_port_on_rlc_component(self, component=None):
         component : str
             Reference designator of the RLC component.
 
+        circuit_ports : bool
+            ``True`` will replace RLC component by circuit ports, ``False`` gap ports compatible with HFSS 3D modeler
+            export.
+
         Returns
         -------
         bool
@@ -1063,31 +1065,38 @@ def add_port_on_rlc_component(self, component=None):
             pin_layers = self._padstack._get_pin_layer_range(pins[0])
             pos_pin_term = terminal.PointTerminal.create(self._active_layout, pins[0].GetNet(),
                                                 "{}_{}".format(component.refdes, pins[0].GetName()),
-                                                pt,
+                                                pins[0],
                                                 pin_layers[0],
+                                                False,
                                                 )
             if not pos_pin_term:  # pragma: no cover
                 return False
             neg_pin_loc = self.get_pin_position(pins[1])
             pt = self._pedb.point_data(*neg_pin_loc)
 
-            neg_pin_term = terminal.PointTerminal.create(
+            neg_pin_term = terminal.PadstackInstanceTerminal.create(
                 self._active_layout,
                 pins[1].net,
                 "{}_{}_ref".format(component.refdes, pins[1].GetName()),
-                pt,
+                pins[1],
                 pin_layers[0],
+                False,
             )
             if not neg_pin_term:  # pragma: no cover
                 return False
             pos_pin_term.boundary_type = terminal.BoundaryType.PORT
-            pos_pin_term.is_circuit_port = True
             pos_pin_term.name = component.refdes
             neg_pin_term.boundary_type = terminal.BoundaryType.PORT
-            neg_pin_term.is_circuit_port = True
             pos_pin_term.reference_terminal = neg_pin_term
+            if circuit_ports:
+                pos_pin_term.is_circuit_port = True
+                neg_pin_term.is_circuit_port = True
+            else:
+                pos_pin_term.is_circuit_port = False
+                neg_pin_term.is_circuit_port = False
             self._logger.info("Component {} has been replaced by port".format(component.refdes))
             return True
+        return False
 
     @pyedb_function_handler()
     def add_rlc_boundary(self, component=None, circuit_type=True):

src/pyedb/grpc/edb.py

@@ -259,7 +259,6 @@ def _clean_variables(self):
         self._siwave = None
         self._hfss = None
         self._nets = None
-        self._setups = {}
         self._layout_instance = None
         self._variables = None
         self._active_cell = None
@@ -2869,7 +2868,7 @@ def build_simulation_project(self, simulation_setup):
                 self.edbpath = legacy_name
                 self.open_edb()
             return True
-        except:  # pragma: no cover
+        except:
             return False
 
     @pyedb_function_handler()
@@ -3027,7 +3026,7 @@ def siwave_dc_setups(self):
         -------
         Dict[str, :class:`pyaedt.edb_core.edb_data.siwave_simulation_setup_data.SiwaveDCSimulationSetup`]
         """
-        return {name: i for name, i in self.setups.items() if i.setup_type == "kSIWaveDCIR"}
+        return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveDCSimulationSetup)}
 
     @property
     def siwave_ac_setups(self):
@@ -3037,10 +3036,12 @@ def siwave_ac_setups(self):
         -------
         Dict[str, :class:`pyaedt.edb_core.edb_data.siwave_simulation_setup_data.SiwaveSYZSimulationSetup`]
         """
-        return {name: i for name, i in self.setups.items() if i.setup_type == "kSIWave"}
+        return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSYZSimulationSetup)}
+
 
     def create_hfss_setup(self, name=None):
-        """Create a setup from a template.
+        """Create an HFSS simulation setup from a template.
+
 
         Parameters
         ----------
@@ -3058,8 +3059,7 @@ def create_hfss_setup(self, name=None):
         """
         if name in self.setups:
             return False
-        setup = HfssSimulationSetup(self, name)
-        self._setups[name] = setup
+        setup = HfssSimulationSetup(self).create(name)
         return setup
 
     @pyedb_function_handler()
@@ -3115,8 +3115,7 @@ def create_siwave_dc_setup(self, name=None):
             name = generate_unique_name("Siwave_DC")
         if name in self.setups:
             return False
-        setup = SiwaveDCSimulationSetup(self, name)
-        self._setups[name] = setup
+        setup = SiwaveDCSimulationSetup(self).create(name)
         return setup
 
     @pyedb_function_handler()

src/pyedb/grpc/edb_core/edb_data/primitives_data.py

@@ -844,6 +844,108 @@ def create_edge_port(
         else:
             return self._app.hfss.create_edge_port_vertical(self.id, pos, name, 50, reference_layer)
 
+    @pyedb_function_handler()
+    def create_via_fence(self, distance, gap, padstack_name):
+        """Create via fences on both sides of the trace.
+        Parameters
+        ----------
+        distance: str, float
+            Distance between via fence and trace center line.
+        gap: str, float
+            Gap between vias.
+        padstack_name: str
+            Name of the via padstack.
+        Returns
+        -------
+        """
+
+        def getAngle(v1, v2):  # pragma: no cover
+            v1_mag = math.sqrt(v1[0] ** 2 + v1[1] ** 2)
+            v2_mag = math.sqrt(v2[0] ** 2 + v2[1] ** 2)
+            dotsum = v1[0] * v2[0] + v1[1] * v2[1]
+            if v1[0] * v2[1] - v1[1] * v2[0] > 0:
+                scale = 1
+            else:
+                scale = -1
+            dtheta = scale * math.acos(dotsum / (v1_mag * v2_mag))
+
+            return dtheta
+
+        def getLocations(line, gap):  # pragma: no cover
+            location = [line[0]]
+            residual = 0
+
+            for n in range(len(line) - 1):
+                x0, y0 = line[n]
+                x1, y1 = line[n + 1]
+                length = math.sqrt((x1 - x0) ** 2 + (y1 - y0) ** 2)
+                dx, dy = (x1 - x0) / length, (y1 - y0) / length
+                x = x0 - dx * residual
+                y = y0 - dy * residual
+                length = length + residual
+                while length >= gap:
+                    x += gap * dx
+                    y += gap * dy
+                    location.append((x, y))
+                    length -= gap
+
+                residual = length
+            return location
+
+        def getParalletLines(pts, distance):  # pragma: no cover
+            leftline = []
+            rightline = []
+
+            x0, y0 = pts[0]
+            x1, y1 = pts[1]
+            vector = (x1 - x0, y1 - y0)
+            orientation1 = getAngle((1, 0), vector)
+
+            leftturn = orientation1 + math.pi / 2
+            righrturn = orientation1 - math.pi / 2
+            leftPt = (x0 + distance * math.cos(leftturn), y0 + distance * math.sin(leftturn))
+            leftline.append(leftPt)
+            rightPt = (x0 + distance * math.cos(righrturn), y0 + distance * math.sin(righrturn))
+            rightline.append(rightPt)
+
+            for n in range(1, len(pts) - 1):
+                x0, y0 = pts[n - 1]
+                x1, y1 = pts[n]
+                x2, y2 = pts[n + 1]
+
+                v1 = (x1 - x0, y1 - y0)
+                v2 = (x2 - x1, y2 - y1)
+                dtheta = getAngle(v1, v2)
+                orientation1 = getAngle((1, 0), v1)
+
+                leftturn = orientation1 + dtheta / 2 + math.pi / 2
+                righrturn = orientation1 + dtheta / 2 - math.pi / 2
+
+                distance2 = distance / math.sin((math.pi - dtheta) / 2)
+                leftPt = (x1 + distance2 * math.cos(leftturn), y1 + distance2 * math.sin(leftturn))
+                leftline.append(leftPt)
+                rightPt = (x1 + distance2 * math.cos(righrturn), y1 + distance2 * math.sin(righrturn))
+                rightline.append(rightPt)
+
+            x0, y0 = pts[-2]
+            x1, y1 = pts[-1]
+
+            vector = (x1 - x0, y1 - y0)
+            orientation1 = getAngle((1, 0), vector)
+            leftturn = orientation1 + math.pi / 2
+            righrturn = orientation1 - math.pi / 2
+            leftPt = (x1 + distance * math.cos(leftturn), y1 + distance * math.sin(leftturn))
+            leftline.append(leftPt)
+            rightPt = (x1 + distance * math.cos(righrturn), y1 + distance * math.sin(righrturn))
+            rightline.append(rightPt)
+            return leftline, rightline
+
+        distance = self._pedb.edb_value(distance).ToDouble()
+        gap = self._pedb.edb_value(gap).ToDouble()
+        center_line = self.get_center_line()
+        leftline, rightline = getParalletLines(center_line, distance)
+        for x, y in getLocations(rightline, gap) + getLocations(leftline, gap):
+            self._pedb.padstacks.place([x, y], padstack_name)
 
 class EdbRectangle(EDBPrimitives):
     def __init__(self, raw_primitive, core_app):

src/pyedb/grpc/stackup.py

@@ -1526,7 +1526,7 @@ def _import_csv(self, file_path):
 
         Parameters
         ----------
-        fpath : str
+        file_path : str
             File path to the CSV file.
         """
         if not pd:
@@ -1539,17 +1539,17 @@ def _import_csv(self, file_path):
                 logger.error("{} doesn't exist in csv".format(name))
                 return False
 
-        for name, l in df.iterrows():
-            layer_type = l.Type
+        for name, layer_info in df.iterrows():
+            layer_type = layer_info.Type
             if name in self.layers:
                 layer = self.layers[name]
                 layer.type = layer_type
             else:
                 layer = self.add_layer(name, layer_type=layer_type, material="copper", fillMaterial="copper")
 
-            layer.material = l.Material
-            layer.thickness = l.Thickness
-            layer.dielectric_fill = l.Dielectric_Fill
+            layer.material = layer_info.Material
+            layer.thickness = layer_info.Thickness
+            layer.dielectric_fill = layer_info.Dielectric_Fill
 
         lc_new = layer_collection.LayerCollection()
         for name, _ in df.iterrows():