Visualise ports in KLayout preview when simulation is exported

Author: AbdullahKazi500

klayout_package/python/kqcircuits/simulations/simulation.py

@@ -902,6 +902,9 @@ def create_simulation_layers(self):
             if part.visualise:
                 self.visualise_region(part.region, part.name, f"part_reg_{part.name}")
 
+        # Finally, visualise all ports
+        self.visualise_ports()
+
     def produce_layers(self, parts):
         """Finalizes and partitions self.layers.
 
@@ -1455,3 +1458,77 @@ def visualise_region(
         else:
             for i, p in enumerate(points):
                 self.cell.shapes(visualisation_layer).insert(pya.DText(f"{label}_{i+1}", p.x, p.y))
+
+    def visualise_ports(self, edge_port_thickness=500):
+        """Visualise all ports in a dedicated 'simulation_ports' layer using get_port_data().
+
+        Args:
+            edge_port_thickness (float): Extra outward extension (µm) for EdgePorts to make them more visible.
+        """
+        dbu = self.layout.dbu
+        port_json = self.get_port_data()
+
+        for port in self.ports:
+            # Initialize visualise_point at the start of each iteration
+            visualise_point = None
+
+            # Try to find a matching entry in port_json
+            port_data_list = [p for p in port_json if p.get("number") == port.number]
+            if not port_data_list:
+                logging.warning(f"Port {port.number} not found in get_port_data() output, skipping visualisation.")
+                continue
+            port_data = port_data_list[0]
+
+            # Label based on port type
+            if isinstance(port, EdgePort):
+                label = f"edge_port_{port.number}"
+            elif isinstance(port, InternalPort):
+                label = f"internal_port_{port.number}"
+            else:
+                logging.warning(f"Unsupported port type {type(port).__name__} for port {port.number}")
+                continue
+
+            # Construct 2D polygon from port_data["polygon"] (ignoring z coordinate)
+            if "polygon" in port_data and port_data["polygon"]:
+                points_2d = [pya.DPoint(p[0], p[1]) for p in port_data["polygon"]]
+
+                if isinstance(port, EdgePort) and edge_port_thickness > 0:
+                    direction = None
+                    if port.signal_location.x == self.box.p1.x:
+                        # Port on left border of simulation box
+                        direction = pya.DPoint(-edge_port_thickness, 0)
+                    elif port.signal_location.x == self.box.p2.x:
+                        # on right border
+                        direction = pya.DPoint(edge_port_thickness, 0)
+                    elif port.signal_location.y == self.box.p1.y:
+                        # on bottom border
+                        direction = pya.DPoint(0, -edge_port_thickness)
+                    elif port.signal_location.y == self.box.p2.y:
+                        # on top border
+                        direction = pya.DPoint(0, edge_port_thickness)
+
+                    if not direction:
+                        # draw
+                        poly = pya.DPolygon(points_2d)
+                    else:
+                        # Some points are duplicates when projected to 2D. Ensure you get two different points
+                        points_2d = list(set(points_2d))
+                        p1 = points_2d[0]
+                        p2 = points_2d[1]
+                        # Build a thick polygon from shifted points
+                        poly = pya.DPolygon(
+                            [
+                                p1,
+                                p2,
+                                p2 + direction,
+                                p1 + direction,
+                            ]
+                        )
+                        visualise_point = port.signal_location
+                else:
+                    poly = pya.DPolygon(points_2d)
+
+                region = pya.Region(poly.to_itype(dbu))
+                self.visualise_region(region, label, "simulation_ports", visualise_point)
+            else:
+                logging.warning(f"Port {port.number} has no polygon data in get_port_data(), skipping visualisation.")