Compare commits

..
97 changed files with 849 additions and 2554 deletions
+4 -4
View File
@@ -1,12 +1,12 @@
# CLAUDE.md
Guidance for Claude Code working in the `rpmroute` repository.
Guidance for Claude Code working in the `freeroute` repository.
## What this is
A native Python PCB autorouter: a Java-free reimplementation of the
[FreeRouting](https://github.com/freerouting/freerouting) engine. Specctra DSN
in, Specctra SES out, no JVM anywhere. Published on PyPI as `rpmroute`
in, Specctra SES out, no JVM anywhere. Published on PyPI as `freeroute`
(GPL-3.0-or-later, CalVer).
## Commands
@@ -16,7 +16,7 @@ uv sync
uv run pytest -m "not oracle" # the fast suite (this is what you run)
uv run pytest -m oracle # differential tests against the real JAR (needs Java)
uv run ruff check src/ tests/
uv run rpmroute board.dsn --engine room --pack -do board.ses
uv run freeroute board.dsn --engine room --pack -do board.ses
```
## The three non-negotiable invariants
@@ -67,7 +67,7 @@ route/ grid_router | exact_router | room_router, shove, pipeline, cli
decomposed into convex rooms joined by doors, so it routes off-grid channels
the grid literally cannot see. DRC-clean. Supports `--pack` and `--shove`.
The engine/option matrix lives in `rpmroute.cli.ENGINE_OPTIONS` and is
The engine/option matrix lives in `freeroute.cli.ENGINE_OPTIONS` and is
importable, so consumers can assert against it. **An unsupported combination is
a hard error (exit 2), never a silent no-op.** Downstream code (`mckicad`) reads
this matrix to avoid sending an invalid pair.
+17 -26
View File
@@ -1,23 +1,14 @@
# rpmroute
# freeroute
A native Python PCB autorouter. Specctra DSN in, Specctra SES out, no JVM
anywhere in the pipeline.
It began as a Java-free port of the
[FreeRouting](https://github.com/freerouting/freerouting) engine and has grown
its own router since: negotiated congestion before routing, multi-pin nets
routed as trees, every route checked against exact pad and copper shapes, and
pin escapes along the pad's own axis for parts placed at an angle. On dense
boards it now finishes more connections than the FreeRouting JAR, with no
rule violations.
It was called `freeroute` until 2026-10-07; that command still works.
A native Python PCB autorouter: a Java-free reimplementation of the
[FreeRouting](https://github.com/freerouting/freerouting) engine. Specctra DSN
in, Specctra SES out, no JVM anywhere in the pipeline.
## Why
Toolchains that autoroute (`kicad-mcp` among them) do it by shelling out to
`freerouting.jar`, which drags a JVM into every install and container image.
`rpmroute` reimplements the routing engine in pure Python, with no dependencies
`freeroute` reimplements the routing engine in pure Python, with no dependencies
beyond the standard library, so the JAR step becomes a `pip install`.
## The contract
@@ -25,31 +16,31 @@ beyond the standard library, so the JAR step becomes a `pip install`.
The entire integration surface is two Specctra files:
```
board.dsn ──▶ rpmroute ──▶ board.ses
board.dsn ──▶ freeroute ──▶ board.ses
(unrouted) (routed session: traces + vias)
```
`kicad-cli` already exports `.dsn` and imports `.ses`, so `rpmroute` drops in
`kicad-cli` already exports `.dsn` and imports `.ses`, so `freeroute` drops in
wherever `java -jar freerouting.jar` was invoked, and nothing else in the pipeline
changes. The `-de` / `-do` / `-mp` flags are the JAR's, on purpose.
## Install
```bash
uv tool install rpmroute # or: pipx install rpmroute
uv tool install freeroute # or: pipx install freeroute
```
## Usage
```bash
# a KiCad board: the exact engine, with the board's copper-to-edge rule
rpmroute board.dsn --engine exact --shove --edge-clearance 0.5 -do board.ses
freeroute board.dsn --engine exact --shove --edge-clearance 0.5 -do board.ses
rpmroute -de board.dsn -do board.ses # the FreeRouting JAR spelling (grid engine)
rpmroute board.dsn --engine room --pack --shove -do board.ses
freeroute -de board.dsn -do board.ses # the FreeRouting JAR spelling (grid engine)
freeroute board.dsn --engine room --pack --shove -do board.ses
```
With no `-do` / `-o`, the SES goes to stdout. Connections rpmroute could not
With no `-do` / `-o`, the SES goes to stdout. Connections freeroute could not
make are listed on stderr; the SES is still written and the exit code stays 0,
as with the JAR. Connections whose two ends sit in one zone of their net are
listed separately, as left to that zone's fill.
@@ -108,7 +99,7 @@ What the opt-in passes buy you:
- **`--diagonal`** (exact): a still-dropped 2-pin net is retried as a 45° trace
covered by an exact integer octagon.
## What rpmroute reads from a KiCad DSN
## What freeroute reads from a KiCad DSN
These were each checked against KiCad itself, pad by pad or with its DRC:
@@ -134,7 +125,7 @@ SES coordinates are written in resolution units, exactly as the JAR writes them.
## Library use
```python
from rpmroute.route import route
from freeroute.route import route
ses_text = route(dsn_text, engine="exact", shove=True, edge_clearance_mm=0.5)
```
@@ -145,13 +136,13 @@ Alpha. Measured on two real KiCad 10 boards (the TerraHawk charge node's power
stage and sense board, 2026-09-27), with every track stripped, then routed, then
checked with `kicad-cli pcb drc --refill-zones`:
| board | rpmroute exact | FreeRouting JAR | DRC errors from rpmroute |
| board | freeroute exact | FreeRouting JAR | DRC errors from freeroute |
|---|---|---|---|
| power stage (40 x 30 mm) | 7 unconnected, ~5 s | 12 | 0 |
| sense board (55 x 25 mm, 0.5 mm pitch MCU) | 41 unconnected, ~2.5 min | 32 | 0 |
In the board owner's production flow (hand-routed power lanes kept, pours added
after routing), rpmroute completed the power stage with no unconnected items.
after routing), freeroute completed the power stage with no unconnected items.
What it is **not**, stated plainly:
@@ -173,7 +164,7 @@ What it is **not**, stated plainly:
For maximum completion on a dense board today, the JAR is still the stronger
router. For routing without a JVM (CI, containers, an MCP server, a library
call), rpmroute routes legally and says what it could not do.
call), freeroute routes legally and says what it could not do.
## Development
+5 -5
View File
@@ -37,8 +37,8 @@ import tempfile
import threading
import time
NOT_ROUTED = re.compile(r"rpmroute: (\d+) connection\(s\) not routed")
TO_ZONE = re.compile(r"rpmroute: (\d+) more connection\(s\) left to a zone fill")
NOT_ROUTED = re.compile(r"freeroute: (\d+) connection\(s\) not routed")
TO_ZONE = re.compile(r"freeroute: (\d+) more connection\(s\) left to a zone fill")
def parse_boards(path: Path) -> list[tuple[str, Path, list[str]]]:
@@ -61,8 +61,8 @@ def parse_variant(spec: str) -> tuple[str, str | None, list[str]]:
if not sep or not head:
raise SystemExit(f"variant {spec!r}: want NAME=FLAGS or NAME@SRC=FLAGS")
name, _, src = head.partition("@")
if src and not (Path(src) / "rpmroute").is_dir():
raise SystemExit(f"variant {name}: {src} has no rpmroute package")
if src and not (Path(src) / "freeroute").is_dir():
raise SystemExit(f"variant {name}: {src} has no freeroute package")
return name, src or None, shlex.split(flags)
@@ -74,7 +74,7 @@ def run_one(board, variant, seed: int, timeout: float) -> dict:
env["PYTHONPATH"] = src + os.pathsep + env.get("PYTHONPATH", "")
with tempfile.TemporaryDirectory() as tmp:
cmd = [
sys.executable, "-m", "rpmroute.cli", str(dsn), "-do", f"{tmp}/out.ses",
sys.executable, "-m", "freeroute.cli", str(dsn), "-do", f"{tmp}/out.ses",
*board_flags, *flags, "--seed", str(seed),
]
start = time.monotonic()
+10 -24
View File
@@ -23,19 +23,17 @@ import json
from pathlib import Path
import sys
from rpmroute.board import build_board
from rpmroute.board.search_tree import ShapeSearchTree
from rpmroute.dsn import parse_dsn
from rpmroute.geometry.octagon import overlaps_2d
from rpmroute.route import grid_router
from rpmroute.route.exact_router import route_board_exact
from rpmroute.route.grid_router import GridRouter, _ends_of
from rpmroute.route.pipeline import (
from freeroute.board import build_board
from freeroute.board.search_tree import ShapeSearchTree
from freeroute.dsn import parse_dsn
from freeroute.geometry.octagon import overlaps_2d
from freeroute.route import grid_router
from freeroute.route.exact_router import route_board_exact
from freeroute.route.grid_router import GridRouter, _ends_of
from freeroute.route.pipeline import (
_mm_to_board,
_net_widths_board,
_rule_clearance_dsn,
_rule_width_dsn,
_via_drill_board,
_via_half_board,
)
@@ -185,8 +183,7 @@ def _flood(router: GridRouter, pin, net_no: int, conns) -> tuple[int, Counter]:
def diagnose(
dsn_text: str, edge_clearance_mm: float | None, resolution: int = 2, shove: bool = False,
access_cost: float = 0.0, hole_to_hole_mm: float = 0.25, seed: int | None = None,
negotiate: int = 0,
access_cost: float = 0.0,
) -> dict:
dsn = parse_dsn(dsn_text)
names = {i + 1: n.name for i, n in enumerate(dsn.nets)}
@@ -202,12 +199,6 @@ def diagnose(
resolution=resolution,
shove=shove,
access_cost=access_cost,
seed=seed,
negotiate=negotiate,
# the product's configuration: net-class widths and hole spacing
net_widths=_net_widths_board(dsn, scale),
via_drill=_via_drill_board(dsn, scale),
hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
)
routed = seen["router"]
best = routed._diag_best
@@ -215,8 +206,6 @@ def diagnose(
# the board as the best pass left it
state = _fresh(seen)
# pins on turned pads leave along their pad's axis: replay with the same exits
state._axis_exits = dict(routed._axis_exits)
conns = state._conns
for idx, (path, a_end, b_end) in best.items():
conns[idx].a_end, conns[idx].b_end = a_end, b_end
@@ -281,14 +270,11 @@ def main(argv: list[str] | None = None) -> int:
ap.add_argument("--grid-resolution", type=int, default=2, metavar="K")
ap.add_argument("--shove", action="store_true", help="as mckicad routes")
ap.add_argument("--access-cost", type=float, default=0.0)
ap.add_argument("--seed", type=int, help="route in this shuffled order, as bench.py does")
ap.add_argument("--negotiate", type=int, default=0, metavar="N", help="as the router's --negotiate")
ap.add_argument("--hole-to-hole", type=float, default=0.25, metavar="MM")
ap.add_argument("--json", type=Path, help="also write the full table here")
args = ap.parse_args(argv)
report = diagnose(args.dsn.read_text(), args.edge_clearance, args.grid_resolution, args.shove,
args.access_cost, args.hole_to_hole, args.seed, args.negotiate)
args.access_cost)
for row in report["failures"]:
extra = ""
for w in row.get("walled", []):
-67
View File
@@ -1,67 +0,0 @@
#!/usr/bin/env bash
# Route one KiCad board with rpmroute and judge the result with KiCad's DRC.
#
# bench/drc_check.sh [--keep] <board.kicad_pcb> <out-dir> [rpmroute args...]
#
# Copies the board (and its .kicad_pro) into <out-dir>, strips its tracks and
# vias unless --keep is given (then they reach the router as fixed wiring),
# exports the DSN through mckicad, routes, applies the session, and runs DRC
# with zones refilled at every severity. Prints one line: time, copper added,
# shorts, opens, hole problems (whatever severity the board gives them) and
# the other errors. The source board is never touched.
#
# RPMROUTE (or the older FREEROUTE; default: this checkout's .venv/bin/rpmroute) and MCK (default
# ~/claude/mckicad) pick the builds to judge.
set -euo pipefail
keep=0
if [[ "${1:-}" == "--keep" ]]; then keep=1; shift; fi
src="$1"; out="$2"; shift 2
here="$(cd "$(dirname "$0")/.." && pwd)"
RPMROUTE="${RPMROUTE:-${FREEROUTE:-$here/.venv/bin/rpmroute}}"
MCK="${MCK:-$HOME/claude/mckicad}"
rm -rf "$out"; mkdir -p "$out"
cp "${src%.kicad_pcb}.kicad_pro" "$out/board.kicad_pro" 2>/dev/null || true
if [[ $keep == 1 ]]; then
cp "$src" "$out/board.kicad_pcb"
else
(cd "$MCK" && uv run --no-sync python - "$src" "$out/board.kicad_pcb" <<'EOF'
import sys
from mckicad.utils.sexp_tree import parse
text = open(sys.argv[1]).read()
spans = sorted((c.span for c in parse(text).children if c.tag in ("segment", "arc", "via")), reverse=True)
for a, b in spans:
text = text[:a] + text[b:]
open(sys.argv[2], "w").write(text)
EOF
)
fi
(cd "$MCK" && uv run --no-sync python -c "
from mckicad.utils.freerouting import FreeRoutingEngine
assert FreeRoutingEngine().export_dsn_from_kicad('$out/board.kicad_pcb', '$out/board.dsn', {})") \
>/dev/null 2>&1 || { echo "$out: DSN export failed"; exit 1; }
start=$(date +%s.%N)
"$RPMROUTE" "$out/board.dsn" -do "$out/board.ses" "$@" >"$out/route.log" 2>&1 || true
secs=$(python3 -c "print(round($(date +%s.%N)-$start,1))")
[[ -s "$out/board.ses" ]] || { echo "$out: no session ($(tail -1 "$out/route.log"))"; exit 1; }
(cd "$MCK" && uv run --no-sync python -c "
from mckicad.utils.ses_apply import apply_ses_to_board as a
r = a('$out/board.kicad_pcb', '$out/board.ses', '$out/board.kicad_pcb')
print(r['segments_added'], r['vias_added'])" 2>/dev/null) >"$out/apply.txt"
kicad-cli pcb drc --refill-zones --format json --severity-all \
-o "$out/drc.json" "$out/board.kicad_pcb" >/dev/null 2>&1 || true
python3 - "$out" "$secs" <<'EOF'
import collections, json, sys
out, secs = sys.argv[1:]
seg, via = open(f"{out}/apply.txt").read().split()
d = json.load(open(f"{out}/drc.json"))
errors = collections.Counter(v["type"] for v in d["violations"] if v.get("severity") == "error")
other = collections.Counter(v["type"] for v in d["violations"] if v.get("severity") != "error")
holes = {k: errors.pop(k, 0) + other.get(k, 0) for k in ("holes_co_located", "hole_to_hole")}
print(f"{out}: {secs}s {seg} seg {via} via shorts {errors.pop('shorting_items', 0)} "
f"opens {len(d.get('unconnected_items', []))} holes {holes} errors {dict(errors)}")
EOF
+3 -3
View File
@@ -90,7 +90,7 @@ this is the structure the Python `reader.py` mirrors):
**Python port status:** items 1 (tokenizer), the shape grammar, and every
structure/library/network/placement/parser/resolution scope above are
implemented in `src/rpmroute/dsn/` this session (see below).
implemented in `src/freeroute/dsn/` this session (see below).
## 2. Board data model — `board/`
@@ -175,7 +175,7 @@ converge toward FreeRouting's free-space rooms. Not started this session.
into the read result).
## Port order (this file drives the roadmap)
1. **DSN parser** — done this session (`src/rpmroute/dsn/`).
1. **DSN parser** — done this session (`src/freeroute/dsn/`).
2. **SES writer** — next. Start with an empty/no-op session to prove the loop
end-to-end through `kicad-cli pcb import specctra-ses`. See `SesWriter.java`
and `SpecctraSesFileWriter.java`: `(session <name> (base_design <name>)
@@ -184,6 +184,6 @@ converge toward FreeRouting's free-space rooms. Not started this session.
3. **Geometry primitives** — `geometry/planar` subset needed by the board model.
4. **Board model** — `board` items + spatial index.
5. **Autorouter** — maze/rip-up core, then optimize pass.
6. **CLI + kicad-mcp integration** — `rpmroute board.dsn -o board.ses`.
6. **CLI + kicad-mcp integration** — `freeroute board.dsn -o board.ses`.
</content>
</invoke>
+1 -1
View File
@@ -43,7 +43,7 @@ the output. Match that I/O and the rest of `kicad-mcp` is unchanged.
4. **Autorouter core** — maze routing with rip-up-and-retry. Start grid-based
Manhattan/45° for an MVP; converge toward FreeRouting's approach. _(TBD.)_
5. **Optimize pass** — via minimization, trace smoothing. _(TBD.)_
6. **CLI + kicad-mcp integration** — `rpmroute board.dsn -o board.ses`, then
6. **CLI + kicad-mcp integration** — `freeroute board.dsn -o board.ses`, then
swap it in behind `kicad_mcp/utils/freerouting_engine.py`'s JAR step.
## Validation strategy
+11 -14
View File
@@ -3,9 +3,9 @@ requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "rpmroute"
version = "2026.10.07"
description = "Native Python PCB autorouter with negotiated congestion and tree routing (Specctra DSN in, SES out)"
name = "freeroute"
version = "2026.07.14"
description = "Native Python PCB autorouter — a Java-free port of the FreeRouting engine (Specctra DSN in, SES out)"
readme = "README.md"
license = "GPL-3.0-or-later"
license-files = ["LICENSE"]
@@ -40,17 +40,14 @@ requires-python = ">=3.10"
dependencies = []
[project.urls]
"Homepage" = "https://git.supported.systems/warehack.ing/rpmroute"
"Repository" = "https://git.supported.systems/warehack.ing/rpmroute"
"Issues" = "https://git.supported.systems/warehack.ing/rpmroute/issues"
# Where it started: a port of the Java FreeRouting engine. It has since grown
# its own router (negotiation, tree nets, exact checks) and ships no upstream code.
"Origin" = "https://github.com/freerouting/freerouting"
"Homepage" = "https://git.supported.systems/warehack.ing/freeroute"
"Repository" = "https://git.supported.systems/warehack.ing/freeroute"
"Issues" = "https://git.supported.systems/warehack.ing/freeroute/issues"
# The Java engine this is a port of; freeroute ships no upstream code.
"Upstream" = "https://github.com/freerouting/freerouting"
[project.scripts]
rpmroute = "rpmroute.cli:main"
# the name it had until 2026-10-07, kept so existing scripts keep working
freeroute = "rpmroute.cli:main"
freeroute = "freeroute.cli:main"
[dependency-groups]
dev = [
@@ -60,7 +57,7 @@ dev = [
]
[tool.hatch.build.targets.wheel]
packages = ["src/rpmroute"]
packages = ["src/freeroute"]
[tool.hatch.build.targets.sdist]
# Ship the package, the licence, and the docs — nothing else. `reference/` is a
@@ -98,7 +95,7 @@ select = ["E", "W", "F", "I", "B", "C4", "UP", "SIM"]
ignore = ["E501"]
[tool.ruff.lint.isort]
known-first-party = ["rpmroute"]
known-first-party = ["freeroute"]
force-sort-within-sections = true
[tool.pytest.ini_options]
+3
View File
@@ -0,0 +1,3 @@
"""freeroute — native Python PCB autorouter (Java-free FreeRouting port)."""
__version__ = "0.1.0"
@@ -1,9 +1,9 @@
"""Board data model for rpmroute.
"""Board data model for freeroute.
The data model a parsed DSN produces and the (future) router operates on:
layers, units, coordinate transform, nets, clearance matrix, the item hierarchy,
and the :class:`BasicBoard` container. :func:`build_board` constructs a board
from a :class:`~rpmroute.dsn.model.DsnBoard`.
from a :class:`~freeroute.dsn.model.DsnBoard`.
The routing operations (``RoutingBoard``) and the spatial ``ShapeSearchTree``
belong to the router phase.
@@ -9,7 +9,7 @@ board-model invariants check.
from __future__ import annotations
from rpmroute.geometry import IntBox
from freeroute.geometry import IntBox
from .clearance import ClearanceMatrix
from .items import ConductionArea, Item, ObstacleArea, Pin, Trace, Via
@@ -74,7 +74,7 @@ class BasicBoard:
"""Copper already routed on the board (the DSN's ``wiring``), as
``(net, layers, box)``. A track is its segments, its corners and the
round caps at its ends (as squares); a via is its largest pad."""
from rpmroute.geometry.polyline import Polyline, PolylineShape, corner_box
from freeroute.geometry.polyline import Polyline, PolylineShape, corner_box
out: list[tuple[int, frozenset[int], IntBox]] = []
for item in self._items:
@@ -1,6 +1,6 @@
"""Build a :class:`BasicBoard` from a parsed DSN :class:`DsnBoard`.
This is the load-bearing integration between :mod:`rpmroute.dsn` and the board
This is the load-bearing integration between :mod:`freeroute.dsn` and the board
model. It mirrors what FreeRouting's ``Structure.create_board`` / ``Library`` /
``Component`` / ``Network`` readers do collectively, but on the already-parsed
``DsnBoard``:
@@ -12,10 +12,9 @@ model. It mirrors what FreeRouting's ``Structure.create_board`` / ``Library`` /
* padstacks x placement -> :class:`Pin` items
* keepouts -> :class:`ObstacleArea` items
Pad geometry: a rectangle pad becomes an exact :class:`IntBox`; a circle pad a
16-sided :class:`Simplex` drawn just outside it (its corners stand out by 2% of
the radius, where the bounding box's stood out by 41%); a convex polygon pad an
exact :class:`Simplex`. Every pad is placed centred on its pin
Pad geometry: a rectangle pad becomes an exact :class:`IntBox`; a circle pad its
bounding box (documented approximation pending an exact circle tile); a convex
polygon pad an exact :class:`Simplex`. Every pad is placed centred on its pin
location, so it contains that location by construction. Component rotation is
applied to the pin position; the pad tile itself is not rotated (irrelevant to
the containment invariant, and pads are centre-symmetric in practice).
@@ -26,10 +25,10 @@ from __future__ import annotations
import math
import re
from rpmroute.dsn.model import DsnBoard
from rpmroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape
from rpmroute.geometry import FloatPoint, IntBox, IntPoint, IntVector, Simplex
from rpmroute.geometry.polygon_shape import PolygonShape
from freeroute.dsn.model import DsnBoard
from freeroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape
from freeroute.geometry import FloatPoint, IntBox, IntPoint, IntVector, Simplex
from freeroute.geometry.polygon_shape import PolygonShape
from .board import BasicBoard
from .clearance import ClearanceMatrix
@@ -250,7 +249,7 @@ def _placed_pad_tile(shape: Shape, place, dsn_pin, transform: CoordinateTransfor
r = round(transform.dsn_to_board(shape.diameter / 2))
cx = round(transform.dsn_to_board(centre.x))
cy = round(transform.dsn_to_board(centre.y))
return _circle_tile(cx, cy, r)
return IntBox(cx - r, cy - r, cx + r, cy + r)
if isinstance(shape, Rectangle):
x0, y0, x1, y1 = shape.coords[:4]
corners = [(x0, y0), (x1, y0), (x1, y1), (x0, y1)]
@@ -269,12 +268,8 @@ def _placed_pad_tile(shape: Shape, place, dsn_pin, transform: CoordinateTransfor
for x, y in corners:
p = _to_board_offset(place, x, y, dsn_pin.rotation)
pts.append(IntPoint(round(transform.dsn_to_board(p.x)), round(transform.dsn_to_board(p.y))))
# An oval's padded corners are not in outline order, and a mirrored
# part reverses the winding: take the convex hull, then either winding.
hull = _convex_hull(pts)
if len(hull) >= 3:
for corners in (hull, hull[::-1]):
simplex = Simplex.from_corners(corners)
if len(pts) >= 3:
simplex = Simplex.from_corners(pts)
if not simplex.is_empty():
return simplex
xs = [p.x for p in pts] or [0]
@@ -282,52 +277,6 @@ def _placed_pad_tile(shape: Shape, place, dsn_pin, transform: CoordinateTransfor
return IntBox(min(xs), min(ys), max(xs), max(ys))
_CIRCLE_SIDES = 16
def _circle_tile(cx: int, cy: int, r: int):
"""A polygon around the circle, every side touching it. A square around a
big round pad (a mounting hole) puts phantom copper in its corners that
blocks legal routes past it; this stays outside the circle, so the router
is still never closer than KiCad measures."""
if r < 8:
return IntBox(cx - r, cy - r, cx + r, cy + r)
reach = r / math.cos(math.pi / _CIRCLE_SIDES)
corners = []
for k in range(_CIRCLE_SIDES):
a = (k + 0.5) * 2 * math.pi / _CIRCLE_SIDES
dx, dy = reach * math.cos(a), reach * math.sin(a)
# round away from the centre so the polygon never cuts into the circle
corners.append(IntPoint(cx + math.copysign(math.ceil(abs(dx)), dx),
cy + math.copysign(math.ceil(abs(dy)), dy)))
corners = [IntPoint(int(p.x), int(p.y)) for p in corners]
for winding in (corners, corners[::-1]):
simplex = Simplex.from_corners(winding)
if not simplex.is_empty():
return simplex
return IntBox(cx - r, cy - r, cx + r, cy + r)
def _convex_hull(pts: list[IntPoint]) -> list[IntPoint]:
"""The convex hull of ``pts`` counter-clockwise, collinear points dropped."""
ps = sorted({(p.x, p.y) for p in pts})
if len(ps) < 3:
return [IntPoint(x, y) for x, y in ps]
def cross(o, a, b):
return (a[0] - o[0]) * (b[1] - o[1]) - (a[1] - o[1]) * (b[0] - o[0])
def half(points):
out: list[tuple[int, int]] = []
for p in points:
while len(out) >= 2 and cross(out[-2], out[-1], p) <= 0:
out.pop()
out.append(p)
return out[:-1]
return [IntPoint(x, y) for x, y in half(ps) + half(ps[::-1])]
def _pad_tile(shape: Shape, transform: CoordinateTransform):
"""A board-relative pad tile from a DSN padstack shape (centred near origin)."""
if isinstance(shape, Rectangle):
@@ -337,7 +286,7 @@ def _pad_tile(shape: Shape, transform: CoordinateTransform):
r = round(transform.dsn_to_board(shape.diameter / 2))
cx = round(transform.dsn_to_board(shape.center_x))
cy = round(transform.dsn_to_board(shape.center_y))
return _circle_tile(cx, cy, r)
return IntBox(cx - r, cy - r, cx + r, cy + r) # bounding-box approximation
if isinstance(shape, (Polygon, Path)):
coords = shape.coords
pts = [
@@ -3,22 +3,22 @@
Ports the *data model* of ``board/Item.java`` and its subclasses (``Pin``,
``ObstacleArea``/``ConductionArea``, ``Via``, ``PolylineTrace``). The routing
and search-tree machinery in the Java classes is out of scope here — these hold
the geometry and connectivity a :class:`~rpmroute.board.board.BasicBoard`
the geometry and connectivity a :class:`~freeroute.board.board.BasicBoard`
needs and that the DSN-import invariants check.
Coordinates are board units (DSN units scaled by the resolution). Shapes are the
exact convex tiles / boxes from :mod:`rpmroute.geometry`.
exact convex tiles / boxes from :mod:`freeroute.geometry`.
``Trace``/``Via`` are only produced by routing (an imported unrouted board has
none); they are lightweight here and the router phase fleshes out
``Trace`` with a proper :class:`~rpmroute.geometry.Polyline` shape.
``Trace`` with a proper :class:`~freeroute.geometry.Polyline` shape.
"""
from __future__ import annotations
from dataclasses import dataclass, field
from rpmroute.geometry import IntBox, IntPoint
from freeroute.geometry import IntBox, IntPoint
__all__ = ["Item", "Pin", "ObstacleArea", "ConductionArea", "Via", "Trace"]
@@ -119,6 +119,8 @@ class Via(Item):
shape: object = None
#: drill diameter in board units, when the padstack name gives it
drill: int = 0
#: placed by the router's fan-out, not on the board yet: written out
generated: bool = False
@dataclass
@@ -126,12 +128,14 @@ class Trace(Item):
"""A routed trace (router-produced).
Held as its corner points plus a half-width; the router phase attaches the
full :class:`~rpmroute.geometry.Polyline` swept shape.
full :class:`~freeroute.geometry.Polyline` swept shape.
"""
layer: int = 0
half_width: int = 0
corners: list[IntPoint] = field(default_factory=list)
#: placed by the router's fan-out, not on the board yet: written out
generated: bool = False
def is_empty(self) -> bool:
return len(self.corners) < 2
@@ -9,7 +9,7 @@ from __future__ import annotations
import math
from rpmroute.geometry import IntBox, IntPoint
from freeroute.geometry import IntBox, IntPoint
class BoardOutline:
@@ -2,7 +2,7 @@
Ports the query role of ``board/ShapeSearchTree*.java``. It replaces the exact
router's occupancy grid: instead of rasterizing shapes into cells, it indexes
each item's convex tiles (:class:`~rpmroute.geometry.IntBox`) and answers
each item's convex tiles (:class:`~freeroute.geometry.IntBox`) and answers
overlap / region queries with a broad phase (a bounding-box spatial hash) and an
**exact** narrow phase (exact ``IntBox`` intersection). Insert and remove keep
the index in step as traces are added.
@@ -18,7 +18,7 @@ from __future__ import annotations
from dataclasses import dataclass
from rpmroute.geometry import IntBox, IntPoint, Simplex, overlaps_2d, segment_octagon, segment_slab
from freeroute.geometry import IntBox, Simplex, overlaps_2d, segment_octagon
__all__ = ["TreeShape", "ShapeSearchTree"]
@@ -34,7 +34,7 @@ class TreeShape:
``exact`` / ``seg`` are set only for a 45-degree (diagonal) trace tile: ``tile``
is then the bounding box (broad-phase only), ``exact`` is the tight octagon
copper :class:`~rpmroute.geometry.Simplex`, and ``seg`` is ``(a, b,
copper :class:`~freeroute.geometry.Simplex`, and ``seg`` is ``(a, b,
half_width)`` so the clearance region can be rebuilt exactly on demand. For
every orthogonal tile both are ``None`` and all code paths are byte-identical
to the box-only tree.
@@ -63,9 +63,7 @@ class TreeShape:
segment swept by ``half_width + clearance`` (exact integer superset)."""
if self.seg is None:
return self.tile.offset(clearance)
a, b, half_width = self.seg[-3:]
if self.seg[0] == "slab": # a slanted pin exit, at any angle
return segment_slab(a, b, half_width + clearance)
a, b, half_width = self.seg
return segment_octagon(a, b, half_width + clearance)
@@ -153,25 +151,6 @@ class ShapeSearchTree:
return True
return False
def segment_conflict(
self, a: IntPoint, b: IntPoint, half_width: int, net_no: int, layer: int,
clearance: int, kind: str = "wire",
) -> bool:
""":meth:`clearance_conflict` for a slanted segment, checked on its
exact swept copper instead of its bounding box (which would reach the
neighbouring pads of a pin leaving along its turned pad's axis)."""
copper = segment_slab(a, b, half_width)
grown = segment_slab(a, b, half_width + clearance)
for shape in self.overlapping(grown.bounding_box()):
if shape.net_no == net_no or not shape.on_layer(layer):
continue
if shape.blocks != "all" and shape.blocks != kind + "s":
continue
other = shape.exact if shape.exact is not None else shape.tile
if overlaps_2d(copper if not shape.clearance else grown, other):
return True
return False
def rule_area_overlap(self, box: IntBox, layer: int, kind: str = "wire") -> bool:
"""True if ``box`` overlaps a rule area on ``layer`` that stops ``kind``."""
for shape in self.overlapping(box):
@@ -209,8 +188,6 @@ class ShapeSearchTree:
overlap). Static pad-vs-pad spacing in the source design is not counted.
"""
for shape in self.all_shapes():
if not shape.routed:
continue # a pair with routed copper is checked from that side
expanded = shape.tile.offset(clearance)
grown = None # exact clearance region, built lazily only for diagonals
for other in self.overlapping(expanded):
@@ -8,7 +8,7 @@ resolution`` and zero offset (see ``Structure.create_board``).
from __future__ import annotations
from rpmroute.geometry import FloatPoint, IntPoint
from freeroute.geometry import FloatPoint, IntPoint
__all__ = ["CoordinateTransform"]
+44 -104
View File
@@ -1,8 +1,8 @@
"""rpmroute command-line interface: Specctra DSN in, routed SES out.
"""freeroute command-line interface: Specctra DSN in, routed SES out.
Flag-compatible with the FreeRouting JAR (``-de`` / ``-do`` / ``-mp``) so it can
be dropped in wherever ``java -jar freerouting.jar`` was invoked, plus the
rpmroute-specific engine selection (``--engine``) and its opt-in passes.
freeroute-specific engine selection (``--engine``) and its opt-in passes.
Not every engine supports every pass. The matrix below is the single source of
truth; an unsupported combination is an error, never a silent no-op::
@@ -18,23 +18,23 @@ from __future__ import annotations
import argparse
import sys
from rpmroute.dsn.reader import parse_dsn
from rpmroute.route.orders import best_of_orders, promote_failures
from rpmroute.route.pipeline import (
from freeroute.dsn.reader import parse_dsn
from freeroute.route.orders import best_of_orders, promote_failures
from freeroute.route.pipeline import (
build_exact_routing_result,
build_rooms_routing_result,
build_routing_result,
)
from rpmroute.ses import write_ses
from freeroute.ses import write_ses
#: which optional flags each engine actually implements. Anything not listed for
#: an engine is rejected by :func:`_validate` rather than quietly ignored.
ENGINE_OPTIONS: dict[str, frozenset[str]] = {
"grid": frozenset({"rip_up", "max_passes", "seed", "orders", "promote", "access", "negotiate", "rollback", "tree"}),
"exact": frozenset({
"shove", "diagonal", "rip_up", "max_passes", "seed", "orders", "promote", "access",
"negotiate", "rollback", "tree", "window",
}),
"grid": frozenset({"rip_up", "max_passes", "seed", "orders", "promote", "access", "rollback", "fanout"}),
"exact": frozenset(
{"shove", "diagonal", "rip_up", "max_passes", "seed", "orders", "promote", "access",
"rollback", "fanout"}
),
"room": frozenset({"shove", "pack"}),
}
@@ -49,10 +49,8 @@ _FLAG_NAMES = {
"orders": "--orders",
"promote": "--promote-failures",
"access": "--access-cost",
"negotiate": "--negotiate",
"rollback": "--no-rollback",
"tree": "--no-tree",
"window": "--window-reroute",
"fanout": "--fanout",
}
@@ -74,7 +72,7 @@ def _validate(parser: argparse.ArgumentParser, engine: str, requested: list[str]
def build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(
prog="rpmroute",
prog="freeroute",
description="Native PCB autorouter — route a Specctra DSN and write an SES session file.",
)
parser.add_argument("dsn", nargs="?", help="input Specctra .dsn file")
@@ -94,12 +92,11 @@ def build_parser() -> argparse.ArgumentParser:
parser.add_argument(
"--engine",
choices=sorted(ENGINE_OPTIONS),
default="exact",
default="grid",
help=(
"routing track: exact (default; every route checked against exact pad and "
"copper shapes, DRC-clean output), grid (quick maze on the grid alone: its "
"copper is NOT clearance-checked and can short), room (continuous expansion "
"rooms, routes off-grid channels; not clearance-checked either)"
"routing track: grid (default; multi-layer rip-up maze, highest coverage), "
"exact (orthogonal, exact-geometry DRC-verified output), "
"room (continuous expansion rooms, routes off-grid channels)"
),
)
parser.add_argument(
@@ -174,14 +171,6 @@ def build_parser() -> argparse.ArgumentParser:
help="grid and exact engines: extra cost for a route to pass where it would close "
"another pin's way out while that pin still has connections to route (default 0: off)",
)
parser.add_argument(
"--negotiate",
type=int,
metavar="N",
help="grid and exact engines: before routing, N rounds of negotiation on the empty "
"board, where routes may share space at a price that rises where they compete; "
"the contested cells then cost extra in the real routing (default 0: off)",
)
parser.add_argument(
"--no-rollback",
dest="rollback",
@@ -190,53 +179,6 @@ def build_parser() -> argparse.ArgumentParser:
"connections a rip-up displaces are rerouted at once and the rip-up is undone "
"if fewer connections end up routed",
)
parser.add_argument(
"--no-tree",
dest="tree_nets",
action="store_false",
help="grid and exact engines: join a multi-pin net's pins as a chain in pin "
"order, each connection ending on one chosen pin, as before. By default they are "
"paired by a minimum spanning tree and a connection may end on copper its net "
"has already routed",
)
parser.add_argument(
"--window-reroute",
type=int,
metavar="N",
help="exact engine: after routing, N rounds of window re-routes: around each "
"connection still unrouted, the nets routed wholly inside a window are ripped and "
"the window routed again on a finer grid, kept only if fewer connections are left "
"unrouted; each round doubles the window's margin (default 0: off)",
)
parser.add_argument(
"--window-resolution",
type=int,
default=4,
metavar="K",
help="the window re-route's grid resolution (default 4)",
)
parser.add_argument(
"--window-budget",
type=float,
default=0.25,
metavar="F",
help="the window re-route stops starting windows once it has spent this share "
"of the routing's own time (default 0.25)",
)
parser.add_argument(
"--window-cap",
type=int,
default=40,
metavar="W",
help="at most this many windows per round, smallest first (default 40)",
)
parser.add_argument(
"--window-margin",
type=float,
default=1.5,
metavar="MM",
help="the first round's window margin around the stuck connection's pins (default 1.5)",
)
parser.add_argument(
"--hole-to-hole",
type=float,
@@ -245,6 +187,22 @@ def build_parser() -> argparse.ArgumentParser:
help="grid and exact engines: least distance between the edges of any two via "
"holes, of one net or two (KiCad's min_hole_to_hole; default 0.25)",
)
parser.add_argument(
"--fanout",
nargs="?",
const="all",
choices=["all", "supply"],
help="grid and exact engines: before routing, give every fine-pitch pin a stub "
"outward past its pad row (and a via to its plane, for a plane net), committed "
"as copper so later routes cannot wall it in; --fanout supply: plane pins only",
)
parser.add_argument(
"--fanout-min-pins",
type=int,
default=32,
metavar="N",
help="with --fanout: fan out only packages with at least N fine-pitch pins (default 32)",
)
parser.add_argument(
"--jobs",
type=int,
@@ -274,10 +232,8 @@ def main(argv: list[str] | None = None) -> int:
("orders", args.orders is not None),
("promote", args.promote_failures is not None),
("access", args.access_cost is not None),
("negotiate", args.negotiate is not None),
("rollback", not args.rollback),
("tree", not args.tree_nets),
("window", args.window_reroute is not None),
("fanout", bool(args.fanout)),
)
if asked
]
@@ -292,7 +248,7 @@ def main(argv: list[str] | None = None) -> int:
with open(dsn_path, encoding="utf-8") as f:
dsn_text = f.read()
except OSError as e:
print(f"rpmroute: cannot read {dsn_path}: {e}", file=sys.stderr)
print(f"freeroute: cannot read {dsn_path}: {e}", file=sys.stderr)
return 2
dsn = parse_dsn(dsn_text)
@@ -312,15 +268,10 @@ def main(argv: list[str] | None = None) -> int:
"resolution": 2 if args.grid_resolution is None else args.grid_resolution,
"heuristic_weight": args.heuristic_weight,
"access_cost": args.access_cost or 0.0,
"negotiate": args.negotiate or 0,
"hole_to_hole_mm": args.hole_to_hole,
"fanout": args.fanout or False,
"fanout_min_pins": args.fanout_min_pins,
"rollback": args.rollback,
"tree_nets": args.tree_nets,
"window_reroute": args.window_reroute or 0,
"window_resolution": args.window_resolution,
"window_margin_mm": args.window_margin,
"window_budget": args.window_budget,
"window_cap": args.window_cap,
}
elif args.engine == "grid":
options = {
@@ -330,10 +281,10 @@ def main(argv: list[str] | None = None) -> int:
"edge_clearance_mm": args.edge_clearance,
"resolution": 1 if args.grid_resolution is None else args.grid_resolution,
"access_cost": args.access_cost or 0.0,
"negotiate": args.negotiate or 0,
"hole_to_hole_mm": args.hole_to_hole,
"fanout": args.fanout or False,
"fanout_min_pins": args.fanout_min_pins,
"rollback": args.rollback,
"tree_nets": args.tree_nets,
}
if args.engine == "room":
result = build_rooms_routing_result(
@@ -347,14 +298,14 @@ def main(argv: list[str] | None = None) -> int:
dsn_text, args.engine, options, rounds=args.promote_failures, seed=args.seed
)
counts = ", ".join(str(m) for m, _z in rounds)
print(f"rpmroute: {len(rounds)} rounds, unrouted {counts}; kept the best", file=sys.stderr)
print(f"freeroute: {len(rounds)} rounds, unrouted {counts}; kept the best", file=sys.stderr)
elif args.orders and args.orders > 1:
result, kept, tried = best_of_orders(
dsn_text, args.engine, options, orders=args.orders, seed=args.seed, jobs=args.jobs
)
counts = ", ".join(f"{'default' if s is None else s}: {m}" for s, (m, _z) in tried)
print(
f"rpmroute: tried {len(tried)} orders, kept "
f"freeroute: tried {len(tried)} orders, kept "
f"{'the default order' if kept is None else f'--seed {kept}'} (unrouted {counts})",
file=sys.stderr,
)
@@ -368,12 +319,12 @@ def main(argv: list[str] | None = None) -> int:
in_zone = [u for u in result.unrouted if u[3]]
if missing:
# the SES is still written; say plainly what it is missing
print(f"rpmroute: {len(missing)} connection(s) not routed:", file=sys.stderr)
print(f"freeroute: {len(missing)} connection(s) not routed:", file=sys.stderr)
for net, a, b, _zone in missing:
print(f" {net}: {a} to {b}", file=sys.stderr)
if result.narrowed:
print(
f"rpmroute: {len(result.narrowed)} connection(s) of a wider net class only fitted "
f"freeroute: {len(result.narrowed)} connection(s) of a wider net class only fitted "
"at the default width; their nets are written at the default width:",
file=sys.stderr,
)
@@ -381,23 +332,12 @@ def main(argv: list[str] | None = None) -> int:
print(f" {net}: {a} to {b}", file=sys.stderr)
if in_zone:
print(
f"rpmroute: {len(in_zone)} more connection(s) left to a zone fill that may join them:",
f"freeroute: {len(in_zone)} more connection(s) left to a zone fill that may join them:",
file=sys.stderr,
)
for net, a, b, zone in in_zone:
print(f" {net}: {a} to {b} (both in zone {zone})", file=sys.stderr)
if args.engine != "exact":
# These engines route on approximations and do not check the copper
# they write against exact shapes: a board can come out with shorts
# that this report would otherwise never mention.
print(
f"rpmroute: WARNING: the {args.engine} engine does not check its copper for "
"clearance or shorts; run KiCad's DRC on the result, or route with "
"--engine exact (the default)",
file=sys.stderr,
)
if args.output:
with open(args.output, "w", encoding="utf-8") as f:
f.write(ses_text)
@@ -1,13 +1,13 @@
"""Specctra DSN parsing for rpmroute.
"""Specctra DSN parsing for freeroute.
Public API::
from rpmroute.dsn import parse_dsn
from freeroute.dsn import parse_dsn
board = parse_dsn(dsn_text)
``parse_dsn`` returns a typed :class:`~rpmroute.dsn.model.DsnBoard`. The
lower-level :func:`~rpmroute.dsn.tokenizer.tokenize` and
:func:`~rpmroute.dsn.sexp.parse` are exposed for tooling and tests.
``parse_dsn`` returns a typed :class:`~freeroute.dsn.model.DsnBoard`. The
lower-level :func:`~freeroute.dsn.tokenizer.tokenize` and
:func:`~freeroute.dsn.sexp.parse` are exposed for tooling and tests.
"""
from __future__ import annotations
@@ -22,7 +22,7 @@ class SExp:
``head`` is the text of the first token when it is an atom (e.g. ``pcb``,
``layer``, ``net``), else ``None``. ``items`` holds the remaining elements,
each either a :class:`~rpmroute.dsn.tokenizer.Token` (a leaf atom/string)
each either a :class:`~freeroute.dsn.tokenizer.Token` (a leaf atom/string)
or a nested :class:`SExp`.
"""
@@ -1,4 +1,4 @@
"""Planar geometry primitives for rpmroute.
"""Planar geometry primitives for freeroute.
A port of the subset of FreeRouting's ``geometry/planar`` package the router
needs, with the exact-arithmetic types preserved. Arithmetic model per type:
@@ -21,7 +21,7 @@ from .direction import Direction, IntDirection
from .float_point import FloatPoint
from .limits import CRIT_DOUBLE, CRIT_INT
from .line import Line
from .octagon import ceil_sqrt2, overlaps_2d, segment_octagon, segment_slab
from .octagon import ceil_sqrt2, overlaps_2d, segment_octagon
from .point import IntPoint, Point, RationalPoint, point, rational_point
from .polygon import Polygon
from .polygon_shape import PolygonShape
@@ -59,6 +59,5 @@ __all__ = [
"shove_segment",
"ceil_sqrt2",
"segment_octagon",
"segment_slab",
"overlaps_2d",
]
@@ -231,7 +231,7 @@ class IntBox:
return [FloatPoint(c.x, c.y) for c in self.corners()]
def to_simplex(self):
"""Return this box as a :class:`~rpmroute.geometry.simplex.Simplex`.
"""Return this box as a :class:`~freeroute.geometry.simplex.Simplex`.
Four directed border lines whose common right side is the box interior
(ports ``IntBox.to_Simplex``).
@@ -6,7 +6,7 @@ Ports ``geometry/planar/FloatPoint.java``.
keeps ``FloatPoint`` *outside* the exact ``Point`` hierarchy because float math
is inexact; it is used for distances, rounding, and speed-over-accuracy paths.
Its :meth:`side_of` has no reliable ``COLLINEAR`` result (numerical noise), so
exact side tests must go through :class:`~rpmroute.geometry.point.Point`.
exact side tests must go through :class:`~freeroute.geometry.point.Point`.
"""
from __future__ import annotations
@@ -137,13 +137,13 @@ class FloatPoint:
# --- rounding to integer points ----------------------------------------
def round(self):
"""Round to the nearest :class:`~rpmroute.geometry.point.IntPoint`."""
"""Round to the nearest :class:`~freeroute.geometry.point.IntPoint`."""
from .point import IntPoint
return IntPoint(_round_half_up(self.x), _round_half_up(self.y))
def bounding_box(self):
"""Smallest :class:`~rpmroute.geometry.box.IntBox` containing this point."""
"""Smallest :class:`~freeroute.geometry.box.IntBox` containing this point."""
from .box import IntBox
return IntBox(
@@ -2,12 +2,12 @@
Ports ``geometry/planar/Line.java`` (the subset needed for the router's
half-plane work). Like the upstream class, a ``Line`` is defined by two
:class:`~rpmroute.geometry.point.IntPoint` endpoints.
:class:`~freeroute.geometry.point.IntPoint` endpoints.
**Arithmetic model: exact.** :meth:`side_of` uses an exact integer determinant,
and :meth:`intersection` returns an :class:`~rpmroute.geometry.point.IntPoint`
and :meth:`intersection` returns an :class:`~freeroute.geometry.point.IntPoint`
when the crossing is integral and a
:class:`~rpmroute.geometry.point.RationalPoint` otherwise (``z == 0`` when the
:class:`~freeroute.geometry.point.RationalPoint` otherwise (``z == 0`` when the
lines are parallel — the "point at infinity"). :meth:`intersection_approx` is
the fast ``float`` path.
"""
@@ -29,7 +29,7 @@ from .line import Line
from .point import IntPoint
from .simplex import Simplex
__all__ = ["ceil_sqrt2", "segment_octagon", "segment_slab", "overlaps_2d"]
__all__ = ["ceil_sqrt2", "segment_octagon", "overlaps_2d"]
def ceil_sqrt2(radius: int) -> int:
@@ -82,46 +82,6 @@ def segment_octagon(a: IntPoint, b: IntPoint, radius: int) -> Simplex:
return Simplex.get_instance(lines)
def segment_slab(a: IntPoint, b: IntPoint, radius: int) -> Simplex:
"""Convex cover of segment ``a``-``b`` swept by ``radius``, at any angle.
The rectangle along the segment, ``radius`` either side, with flush ends
like :func:`polyline.segment_box`: the ends of a trace leg sit on a pad or
on the square corner tile of the next leg, which cover them. Corners are
rounded away from the middle and the radius gets one unit more, so the
side bounds never under-report, and it stays tight for a slanted segment
off the 45-degree lines (a pin leaving along its pad's axis on a part
turned 30 degrees).
"""
dx, dy = b.x - a.x, b.y - a.y
length = math.hypot(dx, dy)
r = max(radius, 0) + 1
if length == 0:
return Simplex.from_corners([
IntPoint(a.x - r, a.y - r), IntPoint(a.x + r, a.y - r),
IntPoint(a.x + r, a.y + r), IntPoint(a.x - r, a.y + r),
])
ux, uy = dx / length, dy / length
nx, ny = -uy, ux
mx, my = (a.x + b.x) / 2, (a.y + b.y) / 2
def out(x: float, y: float) -> IntPoint:
return IntPoint(math.ceil(x) if x >= mx else math.floor(x),
math.ceil(y) if y >= my else math.floor(y))
corners = [
out(a.x + nx * r, a.y + ny * r),
out(b.x + nx * r, b.y + ny * r),
out(b.x - nx * r, b.y - ny * r),
out(a.x - nx * r, a.y - ny * r),
]
for winding in (corners, corners[::-1]):
slab = Simplex.from_corners(winding)
if not slab.is_empty():
return slab
return Simplex(())
def overlaps_2d(shape_a, shape_b) -> bool:
"""True if the two convex tiles share 2-D area (a real clearance overlap).
@@ -1,7 +1,7 @@
"""``Polygon`` — a normalized corner list (no duplicate or collinear corners).
Ports ``geometry/planar/Polygon.java``. Used as the corner normalizer behind
:class:`~rpmroute.geometry.polygon_shape.PolygonShape`.
:class:`~freeroute.geometry.polygon_shape.PolygonShape`.
**Arithmetic model:** corner de-duplication and collinearity removal are
**exact** (exact ``Point.side_of``); the winding-number test is approximate
@@ -2,7 +2,7 @@
Ports ``geometry/planar/PolygonShape.java``, in particular the recursive
``split_to_convex`` that decomposes a simple polygon into convex
:class:`~rpmroute.geometry.simplex.Simplex` tiles — the decomposition the
:class:`~freeroute.geometry.simplex.Simplex` tiles — the decomposition the
router's search tree relies on.
**Arithmetic model:** corner orientation / convexity tests are **exact**
@@ -7,7 +7,7 @@ trace half-width — the copper region — as a set of exact convex tiles.
**Arithmetic model: exact, integer.** The router that uses this routes
*orthogonally* (axis-aligned segments), so each swept segment is an exact
:class:`~rpmroute.geometry.box.IntBox` (centreline offset by the half-width,
:class:`~freeroute.geometry.box.IntBox` (centreline offset by the half-width,
squared at the ends). The 45-degree case (which needs ``IntOctagon`` caps to
stay exact) is deferred; ``segment_box`` returns the axis-aligned bounding box
for a diagonal segment, which is a *conservative* cover (it never under-reports
@@ -1,10 +1,10 @@
"""``Simplex`` — a convex region as the intersection of directed half-planes.
Ports ``geometry/planar/Simplex.java``. A simplex is defined by an array of
directed :class:`~rpmroute.geometry.line.Line`s sorted by direction angle; the
directed :class:`~freeroute.geometry.line.Line`s sorted by direction angle; the
region is the intersection of the *right* half-plane of each line. Corners are
the exact intersections of consecutive border lines
(:meth:`~rpmroute.geometry.line.Line.intersection`).
(:meth:`~freeroute.geometry.line.Line.intersection`).
**Arithmetic model: exact where it matters.** Corners and all point-containment
tests are exact (exact line intersection + exact ``side_of``). ``offset`` is
@@ -3,11 +3,11 @@
Ports the concrete (non-abstract) behaviour of ``geometry/planar/TileShape.java``
that is defined purely in terms of the border lines and corners: point
containment, area, centre of gravity, and border tests. Concrete subclasses
(:class:`~rpmroute.geometry.simplex.Simplex`) supply ``border_line_count``,
(:class:`~freeroute.geometry.simplex.Simplex`) supply ``border_line_count``,
``border_line``, ``corner`` and ``corner_approx``.
**Arithmetic model:** containment and ``contains_on_border`` are **exact**
(they use the exact :meth:`~rpmroute.geometry.line.Line.side_of`); ``area`` and
(they use the exact :meth:`~freeroute.geometry.line.Line.side_of`); ``area`` and
``centre_of_gravity`` are approximate (``float``), as upstream.
A convex tile is the intersection of the right half-planes of its directed
@@ -13,7 +13,7 @@ Ports ``geometry/planar/{Vector,IntVector,RationalVector}.java``.
representing the affine vector ``(x/z, y/z)``; ``z`` is kept non-negative.
Mirrors the upstream ``BigInteger`` triple. ``BigIntDirection`` is not needed
because ``int`` is unbounded, so normalized directions are always
:class:`~rpmroute.geometry.direction.IntDirection`.
:class:`~freeroute.geometry.direction.IntDirection`.
"""
from __future__ import annotations
@@ -1,9 +1,9 @@
"""Autorouting for rpmroute.
"""Autorouting for freeroute.
An MVP grid-based maze router and the DSN-in / SES-out pipeline that makes
rpmroute a Java-free replacement for the ``freerouting.jar`` step::
freeroute a Java-free replacement for the ``freerouting.jar`` step::
from rpmroute.route import route
from freeroute.route import route
ses_text = route(dsn_text)
The router (:class:`GridRouter`) is intentionally simple — single-layer A* over
@@ -1,18 +1,18 @@
"""Exact-geometry routing track (orthogonal), built on the search tree.
The grid MVP (:mod:`rpmroute.route.grid_router`) approximates clearance with
The grid MVP (:mod:`freeroute.route.grid_router`) approximates clearance with
cell occupancy and emits centrelines with no width-aware DRC check. This track
keeps the grid's rip-up/multi-layer/via *topology* search (in orthogonal mode,
so segments are axis-aligned) but replaces the occupancy check with an **exact**
one: every item's copper is an exact :class:`~rpmroute.geometry.IntBox` tile
indexed in a :class:`~rpmroute.board.search_tree.ShapeSearchTree`, and the
one: every item's copper is an exact :class:`~freeroute.geometry.IntBox` tile
indexed in a :class:`~freeroute.board.search_tree.ShapeSearchTree`, and the
routed board is verified to have **no clearance violation** by exact tile
intersection. A net whose copper would violate is dropped, so the output is
DRC-clean by construction.
**Shove (opt-in, ``shove=True``).** Before a dropped net is abandoned, the
router tries to make room by *moving an existing trace aside* geometrically
(:func:`~rpmroute.geometry.shove_segment`) rather than dropping the incoming
(:func:`~freeroute.geometry.shove_segment`) rather than dropping the incoming
net. A shove is accepted only if the moved trace still connects its pads, clears
every other item exactly (via the tree), and stays in the board outline — so
cleanliness is preserved. Shoves are bounded (``max_shove_depth`` and a
@@ -30,21 +30,19 @@ from __future__ import annotations
from dataclasses import dataclass, field
import math
from rpmroute.board.board import BasicBoard
from rpmroute.board.items import Pin, Via
from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from rpmroute.geometry import (
from freeroute.board.board import BasicBoard
from freeroute.board.items import Pin, Via
from freeroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.geometry import (
IntBox,
IntPoint,
Polyline,
PolylineShape,
Simplex,
segment_box,
segment_octagon,
segment_slab,
shove_segment,
)
from rpmroute.geometry.polyline import corner_box
from freeroute.geometry.polyline import corner_box
from .grid_router import RouteResult, route_board
@@ -100,14 +98,10 @@ def route_board_exact(
seed: int | None = None,
route_first: frozenset | None = None,
access_cost: float = 0.0,
negotiate: int = 0,
rollback: bool = True,
tree_nets: bool = True,
net_widths: dict[int, int] | None = None,
via_drill: int | None = None,
hole_to_hole: int = 0,
only_nets: frozenset | None = None,
bounds: IntBox | None = None,
) -> ExactRouteResult:
"""Route ``board`` orthogonally and verify the result with exact geometry.
@@ -139,14 +133,10 @@ def route_board_exact(
seed=seed,
route_first=route_first,
access_cost=access_cost,
negotiate=negotiate,
rollback=rollback,
tree_nets=tree_nets,
net_widths=net_widths,
via_drill=via_drill,
hole_to_hole=hole_to_hole,
only_nets=only_nets,
bounds=bounds,
)
edge = 0 if edge_clearance is None else edge_clearance
outline = board.outline
@@ -164,9 +154,7 @@ def route_board_exact(
net = pin.net_nos[0] if pin.net_nos else -1
pin_layers = frozenset(layer for layer in pin.layers if layer in signal_layers)
if pin_layers:
# a rotated pad is checked against its outline, not its box
exact = pin.shape if _is_rotated(pin.shape) else None
tree.insert(TreeShape(next(owner), net, pin_layers, box, exact=exact))
tree.insert(TreeShape(next(owner), net, pin_layers, box))
for net, copper_layers, box in board.get_fixed_copper():
on = frozenset(layer for layer in copper_layers if layer in signal_layers)
if on and not box.is_empty():
@@ -200,43 +188,25 @@ def route_board_exact(
# 25-pin supply net costs that one connection, not the whole net.
rejected: list[tuple[int, str, str]] = []
ends_list = result.connection_ends or [("?", "?", "")] * len(result.connections)
anchors_list = getattr(result, "connection_anchors", None) or [()] * len(result.connections)
# each net is checked at the width it will be written at: its class's
# when all of its connections went in at that, else the default
net_half = dict(result.net_half)
# a connection that ended on another's copper (a T into its net's tree)
# dangles if that one is dropped, so it is dropped too; connections come
# in commit order, anchors first
dropped_at: set[int] = set()
for pos, ((net_no, wires, vias), ends, anchors) in sorted(
enumerate(zip(result.connections, ends_list, anchors_list, strict=False)),
key=lambda c: c[1][0][0],
for (net_no, wires, vias), ends in sorted(
zip(result.connections, ends_list, strict=False), key=lambda c: c[0][0]
):
if any(a in dropped_at for a in anchors):
dropped_at.add(pos)
rejected.append((net_no, *ends))
continue
wire_half = net_half.get(net_no, half_width)
pieces = _copper_pieces(wires, vias, wire_half, via_layers, via_half)
boxes = [(box, box_layers) for box, box_layers, _ in pieces]
wire_count = len(_copper_pieces(wires, [], wire_half, via_layers, via_half))
boxes = _copper_boxes(wires, vias, wire_half, via_layers, via_half)
wire_count = len(_copper_boxes(wires, [], wire_half, via_layers, via_half))
if any(
(
tree.segment_conflict(*seg, wire_half, net_no, layer, clearance)
if seg is not None
else tree.clearance_conflict(
tree.clearance_conflict(
box, net_no, layer, clearance, "wire" if i < wire_count else "via"
)
)
for i, (box, box_layers, seg) in enumerate(pieces)
for i, (box, box_layers) in enumerate(boxes)
for layer in box_layers
) or _end_in_rule_area(tree, wires, wire_half) or (
outline is not None and not _inside_outline(
outline, boxes[:wire_count], vias, (via_half or wire_half) + edge, edge
)
outline is not None and not all(outline.box_clear(b, edge) for b, _ in boxes)
):
rejected.append((net_no, *ends))
dropped_at.add(pos)
continue # exact-clearance conflict -> drop (may be recovered by shove)
acc = accepted.get(net_no)
if acc is None:
@@ -248,25 +218,16 @@ def route_board_exact(
v for v in dict.fromkeys(vias)
if v not in acc.vias and not _on_fixed_via(net_no, v, fixed_vias, via_half)
)
for box, box_layers, seg in pieces:
for box, box_layers in boxes:
oid = next(owner)
if seg is None:
tree.insert(TreeShape(oid, net_no, box_layers, box, routed=True))
else: # a slanted pin exit: its exact copper, rebuilt for the DRC check
tree.insert(TreeShape(
oid, net_no, box_layers, box, routed=True,
exact=segment_slab(*seg, wire_half), seg=("slab", *seg, wire_half),
))
acc.owners.append(oid)
accepted_before_recovery = set(accepted)
# a net is dropped if it has a real ratsnest (>= 2 pins on a signal layer)
# but was not accepted — whether the grid failed to route it or its exact
# copper conflicted.
routable = _routable_nets(board, signal_layers)
if only_nets is not None: # a window re-route: the other nets are not ours to route
routable &= set(only_nets)
dropped = sorted(routable - set(accepted))
dropped = sorted(_routable_nets(board, signal_layers) - set(accepted))
shoves = 0
if shove and dropped:
@@ -291,7 +252,7 @@ def route_board_exact(
if diagonal:
outline = board.bounding_box
for net_no in sorted(routable):
for net_no in sorted(_routable_nets(board, signal_layers)):
_diagonalize(
net_no, board, tree, accepted, owner, signal_layers, half_width, clearance, outline
)
@@ -633,7 +594,7 @@ def _conflicting_segment(corners, d_boxes, half_width, clearance):
horizontal = a.y == b.y
if not horizontal and a.x != b.x:
continue # skip diagonal grid stubs
from rpmroute.geometry import segment_box
from freeroute.geometry import segment_box
seg = segment_box(a, b, half_width).offset(clearance)
if any(seg.overlaps(box) for box in d_boxes):
@@ -694,27 +655,6 @@ def _on_fixed_via(net_no, point, fixed_vias, via_half) -> bool:
)
def _copper_pieces(wires, vias, half_width, via_layers, via_half=None):
"""Like :func:`_copper_boxes`, but a slanted wire segment (a pin leaving
along a turned pad's axis) comes with its end points, so it can be checked
on its exact copper: ``(box, layers, (a, b) or None)``."""
via_half = via_half or half_width
pieces: list[tuple[IntBox, frozenset[int], tuple | None]] = []
for layer, points in wires:
on = frozenset({layer})
for a, b in zip(points, points[1:], strict=False):
if a.x == b.x or a.y == b.y:
pieces.append((segment_box(a, b, half_width), on, None))
else:
pieces.append((segment_slab(a, b, half_width).bounding_box(), on, (a, b)))
for c in points[1:-1]:
pieces.append((corner_box(c, half_width), on, None))
for loc in vias:
vbox = IntBox(loc.x - via_half, loc.y - via_half, loc.x + via_half, loc.y + via_half)
pieces.append((vbox, via_layers, None))
return pieces
def _copper_boxes(wires, vias, half_width, via_layers, via_half=None):
via_half = via_half or half_width
boxes: list[tuple[IntBox, frozenset[int]]] = []
@@ -727,19 +667,6 @@ def _copper_boxes(wires, vias, half_width, via_layers, via_half=None):
return boxes
def _inside_outline(outline, wire_boxes, vias, via_reach, edge) -> bool:
"""Copper inside the board, ``edge`` from its outline. A via is round, as
the grid and KiCad take it: its square box would reach past a chamfered
corner where the via itself does not."""
return all(outline.box_clear(b, edge) for b, _ in wire_boxes) and all(
outline.point_clear(v, via_reach) for v in vias
)
def _is_rotated(shape) -> bool:
return isinstance(shape, Simplex) and not shape.is_int_box()
def _net_pins(board: BasicBoard, net_no: int, signal_layers) -> list[Pin]:
return [
pin
+229
View File
@@ -0,0 +1,229 @@
"""Fan out fine-pitch pins before routing: commit each pin's way out as copper.
On a dense board the pins of a fine-pitch package get walled in: their own
neighbours' pads on either side, and other nets' copper that got there first
across the only way out. Reserving the way out did not help (the reserved
cells still had to be routed, and lost to congestion there); committing it
does, which is what a person does by hand.
Each fine-pitch pin of a perimeter package (QFP, QFN, LGA: pads on the edge,
none inside) gets a straight stub outward, perpendicular to its side of the
package, just past its pad row. A pin whose net has an inner plane also gets
a via at the stub's end, staggered between neighbouring pins so their holes
keep their spacing, and so reaches the plane with nothing left to route.
Every stub and via is checked exactly against pads, keepouts, the board edge,
copper already on the board and earlier fan-out, and left out where it would
not fit. The result goes on the board as fixed copper of its net (marked
``generated``), so the router starts from the stub's end or the via, and the
session writes it out with the routes.
"""
from __future__ import annotations
from dataclasses import dataclass
import math
from freeroute.board.board import BasicBoard
from freeroute.board.items import Pin, Trace, Via
from freeroute.geometry import IntBox, IntPoint
from freeroute.geometry.polyline import Polyline, PolylineShape, corner_box
# a package is fanned out when it has this many pins and they are this close
_MIN_PINS = 8
_FINE_PITCH_FACTOR = 1.2 # neighbour centres within this many (trace + 2 clearance)
@dataclass
class FanoutRules:
trace_width: int
clearance: int
via_half: int
via_drill: int
hole_to_hole: int
edge_clearance: int
signal_layers: list[int]
via_padstack: str
#: smallest package fanned out (a big dense part is where pins get walled in)
min_pins: int = 32
#: fan out plane pins only (a stub and a via each), as a person would first
supply_only: bool = False
def plan_fanout(board: BasicBoard, rules: FanoutRules) -> list:
"""The stubs and vias to put on the board before routing."""
half = max(rules.trace_width // 2, 1)
# a net may have several plane zones (a main plane and an island)
planes: dict[int, list] = {}
for z in board.get_conduction_areas():
if z.net_nos and not board.layer_structure.arr[z.layer].is_signal:
planes.setdefault(z.net_nos[0], []).append(z)
# copper pours on the routing layers, by net: a pad inside one is joined
# by the fill, and a stub there would take the room its thermal spokes need
pours: dict[int, list] = {}
for z in board.get_conduction_areas():
if z.net_nos and board.layer_structure.arr[z.layer].is_signal:
pours.setdefault(z.net_nos[0], []).append(z)
placed = _Placed(board, rules)
by_net: dict[int, list[Pin]] = {}
for pin in board.get_pins():
for n in pin.net_nos:
by_net.setdefault(n, []).append(pin)
items: list = []
pitch = 2 * rules.via_half + rules.hole_to_hole
for pins in _packages(board, rules).values():
centre = IntPoint(
sum(p.location.x for p in pins) // len(pins), sum(p.location.y for p in pins) // len(pins)
)
for k, pin in enumerate(sorted(pins, key=lambda p: (p.location.x, p.location.y))):
net = pin.net_nos[0] if pin.net_nos else None
if net is None:
continue
layer = next(layer for layer in pin.layers if layer in rules.signal_layers)
if any(z.layer == layer and z.polygon is not None and z.polygon.contains(pin.location)
for z in pours.get(net, [])):
continue # the pour joins it
direction = _outward(pin.location, centre)
reach = _pad_reach(pin, direction) + rules.clearance + half + rules.trace_width
end = _step(pin.location, direction, reach)
plane = planes.get(net)
partners = [q for q in by_net.get(net, []) if q is not pin]
# a signal whose other pins are all on other layers has to change
# layer somewhere: do it at the stub's end, away from the pads
elsewhere = bool(partners) and all(layer not in q.layers for q in partners)
if plane is None and (rules.supply_only or not elsewhere):
if not rules.supply_only and placed.stub_fits(pin.location, end, layer, net, half):
items.append(placed.add_stub(pin.location, end, layer, net, half))
continue
# stagger the via of every other pin along the side outward
options = [reach + rules.via_half + rules.clearance + (k % 2) * pitch,
reach + rules.via_half + rules.clearance + ((k + 1) % 2) * pitch]
for d in options:
at = _step(pin.location, direction, d)
if plane is not None and not any(
z.polygon is not None and z.polygon.contains(at) for z in plane
):
continue
if placed.stub_fits(pin.location, at, layer, net, half) and placed.via_fits(at, net):
items.append(placed.add_stub(pin.location, at, layer, net, half))
items.append(placed.add_via(at, net))
break
return items
def _packages(board: BasicBoard, rules: FanoutRules) -> dict[str, list[Pin]]:
"""Fine-pitch perimeter packages: many single-layer pins, close together."""
by_ref: dict[str, list[Pin]] = {}
for pin in board.get_pins():
if pin.shape is None or not pin.component_ref:
continue
on = [layer for layer in pin.layers if layer in rules.signal_layers]
if len(on) != 1:
continue # through-hole pins change layer for free
by_ref.setdefault(pin.component_ref, []).append(pin)
fine = _FINE_PITCH_FACTOR * (rules.trace_width + 2 * rules.clearance)
out = {}
for ref, pins in by_ref.items():
if len(pins) < max(rules.min_pins, _MIN_PINS):
continue
close = sum(
1 for p in pins
if min(math.hypot(p.location.x - q.location.x, p.location.y - q.location.y)
for q in pins if q is not p) < fine * 2
)
if close >= len(pins) // 2:
out[ref] = pins
return out
def _outward(point: IntPoint, centre: IntPoint) -> tuple[int, int]:
"""Away from the package centre, along the nearer axis (its side's normal)."""
dx, dy = point.x - centre.x, point.y - centre.y
if abs(dx) >= abs(dy):
return (1 if dx >= 0 else -1, 0)
return (0, 1 if dy >= 0 else -1)
def _pad_reach(pin: Pin, direction: tuple[int, int]) -> int:
"""How far the pad reaches from its centre in ``direction``."""
box = pin.shape.bounding_box()
if direction[0] > 0:
return box.ur.x - pin.location.x
if direction[0] < 0:
return pin.location.x - box.ll.x
if direction[1] > 0:
return box.ur.y - pin.location.y
return pin.location.y - box.ll.y
def _step(point: IntPoint, direction: tuple[int, int], distance: float) -> IntPoint:
return IntPoint(point.x + round(direction[0] * distance), point.y + round(direction[1] * distance))
class _Placed:
"""Copper a fan-out stub or via has to clear, growing as fan-out is placed."""
def __init__(self, board: BasicBoard, rules: FanoutRules) -> None:
self.board, self.rules = board, rules
self.copper: list[tuple[IntBox, frozenset[int], int]] = [] # box, layers, net
for pin in board.get_pins():
if pin.shape is not None:
net = pin.net_nos[0] if pin.net_nos else -1
self.copper.append((pin.shape.bounding_box(), frozenset(pin.layers), net))
for net, layers, box in board.get_fixed_copper():
self.copper.append((box, layers, net))
self.keepouts = [
(tile.bounding_box(), o.layer, o.blocks_wires, o.blocks_vias, o.clearance)
for o in board.get_obstacle_areas() for tile in o.tiles
]
self.holes: list[tuple[IntPoint, int]] = [] # centre, radius
for item in board.get_items():
if isinstance(item, Via) and item.fixed:
self.holes.append((item.location, (item.drill or rules.via_drill) // 2))
for pin in board.get_pins():
if pin.shape is not None and sum(1 for layer in pin.layers if layer in rules.signal_layers) > 1:
b = pin.shape.bounding_box()
self.holes.append((pin.location, min(b.ur.x - b.ll.x, b.ur.y - b.ll.y) // 2))
def _clear(self, box: IntBox, layers: frozenset[int], net: int, kind: str) -> bool:
grown = box.offset(self.rules.clearance)
for other, other_layers, other_net in self.copper:
if other_net != net and layers & other_layers and other.overlaps(grown):
return False
for kbox, klayer, wires, vias, needs in self.keepouts:
if klayer not in layers or not (wires if kind == "wire" else vias):
continue
if kbox.overlaps(grown if needs else box):
return False
outline = self.board.outline
return outline is None or outline.box_clear(box, self.rules.edge_clearance)
def stub_fits(self, a: IntPoint, b: IntPoint, layer: int, net: int, half: int) -> bool:
boxes = list(PolylineShape(Polyline([a, b]), half).tiles()) + [corner_box(b, half)]
return all(self._clear(box, frozenset({layer}), net, "wire") for box in boxes)
def via_fits(self, at: IntPoint, net: int) -> bool:
h = self.rules.via_half
box = IntBox(at.x - h, at.y - h, at.x + h, at.y + h)
if not self._clear(box, frozenset(self.rules.signal_layers), net, "via"):
return False
mine = self.rules.via_drill // 2
return all(
math.hypot(c.x - at.x, c.y - at.y) >= mine + r + self.rules.hole_to_hole
for c, r in self.holes
)
def add_stub(self, a: IntPoint, b: IntPoint, layer: int, net: int, half: int) -> Trace:
for box in list(PolylineShape(Polyline([a, b]), half).tiles()) + [corner_box(b, half)]:
self.copper.append((box, frozenset({layer}), net))
return Trace(net_nos=[net], fixed=True, layer=layer, half_width=half, corners=[a, b],
generated=True)
def add_via(self, at: IntPoint, net: int) -> Via:
h = self.rules.via_half
box = IntBox(at.x - h, at.y - h, at.x + h, at.y + h)
layers = list(self.rules.signal_layers)
self.copper.append((box, frozenset(layers), net))
self.holes.append((at, self.rules.via_drill // 2))
return Via(net_nos=[net], fixed=True, padstack_name=self.rules.via_padstack,
location=at, layers=layers, shape=box, drill=self.rules.via_drill,
generated=True)
File diff suppressed because it is too large Load Diff
@@ -15,8 +15,8 @@ from __future__ import annotations
from concurrent.futures import ProcessPoolExecutor
import os
from rpmroute.dsn import parse_dsn
from rpmroute.ses import RoutingResult
from freeroute.dsn import parse_dsn
from freeroute.ses import RoutingResult
from .pipeline import build_exact_routing_result, build_routing_result
@@ -13,16 +13,14 @@ to DSN units (dividing by the resolution) for the SES ``(wire (path ...))`` and
from __future__ import annotations
import re
import time
from rpmroute.board import build_board
from rpmroute.dsn import DsnBoard, parse_dsn
from rpmroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses
from freeroute.board import build_board
from freeroute.dsn import DsnBoard, parse_dsn
from freeroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses
from .exact_router import ExactRouteResult, route_board_exact
from .grid_router import RouteResult, route_board
from .room_router import route_board_rooms
from .window import window_reroute as window_reroute_stage
__all__ = ["route", "route_dsn_board", "build_routing_result"]
@@ -90,6 +88,42 @@ def _dsn_units_per_um(dsn: DsnBoard) -> float:
return {"um": 1.0, "mm": 0.001, "mil": 1 / 25.4, "inch": 1 / 25400}.get(dsn.unit, 1.0)
def _place_fanout(
board, dsn, scale, layers, width, clearance, edge, hole_to_hole_mm, mode=True, min_pins=32
) -> None:
"""Put the fan-out's stubs and vias on the board, before routing."""
from .fanout import FanoutRules, plan_fanout
via_half = _via_half_board(dsn, scale) or max(width // 2, 1)
rules = FanoutRules(
trace_width=width,
clearance=clearance,
via_half=via_half,
via_drill=_via_drill_board(dsn, scale) or 2 * via_half,
hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
edge_clearance=edge or 0,
signal_layers=layers or [i for i, layer in enumerate(dsn.layers) if layer.is_signal],
via_padstack=_via_padstack(dsn),
min_pins=min_pins,
supply_only=mode == "supply",
)
for item in plan_fanout(board, rules):
board.insert(item)
def _add_generated(result, board) -> None:
"""The fan-out's copper goes into the session with the routes."""
from freeroute.board.items import Trace, Via
for item in board.get_items():
if not getattr(item, "generated", False) or not item.net_nos:
continue
if isinstance(item, Trace):
result.add_wire(item.net_nos[0], item.layer, list(item.corners))
elif isinstance(item, Via):
result.add_via(item.net_nos[0], item.location)
def _via_half_board(dsn: DsnBoard, scale: int) -> int | None:
"""Half the via pad's size in board units, from the DSN's via padstack.
@@ -120,10 +154,10 @@ def route_dsn_board(
seed: int | None = None,
route_first: frozenset | None = None,
access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25,
fanout: bool | str = False,
fanout_min_pins: int = 32,
rollback: bool = True,
tree_nets: bool = True,
) -> tuple[RouteResult, int, list[str]]:
"""Route a parsed :class:`DsnBoard`; return the board-unit result, the scale,
and the layer names. ``layers`` restricts routing to those signal-layer
@@ -134,6 +168,9 @@ def route_dsn_board(
edge_clearance_board = _mm_to_board(dsn, scale, edge_clearance_mm)
width_board = round(_rule_width_dsn(dsn) * scale)
clearance_board = round(_rule_clearance_dsn(dsn) * scale)
if fanout:
_place_fanout(board, dsn, scale, layers, width_board, clearance_board,
edge_clearance_board, hole_to_hole_mm, fanout, fanout_min_pins)
result = route_board(
board,
resolution=resolution,
@@ -147,13 +184,12 @@ def route_dsn_board(
seed=seed,
route_first=route_first,
access_cost=access_cost,
negotiate=negotiate,
rollback=rollback,
tree_nets=tree_nets,
net_widths=_net_widths_board(dsn, scale),
via_drill=_via_drill_board(dsn, scale),
hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
)
_add_generated(result, board)
return result, scale, [layer.name for layer in dsn.layers]
@@ -202,10 +238,10 @@ def build_routing_result(
seed: int | None = None,
route_first: frozenset | None = None,
access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25,
fanout: bool | str = False,
fanout_min_pins: int = 32,
rollback: bool = True,
tree_nets: bool = True,
) -> RoutingResult:
"""Route ``dsn`` (grid track) and convert to a DSN-unit RoutingResult."""
route, scale, layer_names = route_dsn_board(
@@ -213,10 +249,10 @@ def build_routing_result(
edge_clearance_mm=edge_clearance_mm, resolution=resolution, seed=seed,
route_first=route_first,
access_cost=access_cost,
negotiate=negotiate,
hole_to_hole_mm=hole_to_hole_mm,
fanout=fanout,
fanout_min_pins=fanout_min_pins,
rollback=rollback,
tree_nets=tree_nets,
)
return _to_routing_result(route, dsn, scale, layer_names)
@@ -235,15 +271,10 @@ def route_dsn_board_exact(
seed: int | None = None,
route_first: frozenset | None = None,
access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25,
fanout: bool | str = False,
fanout_min_pins: int = 32,
rollback: bool = True,
tree_nets: bool = True,
window_reroute: int = 0,
window_resolution: int = 4,
window_margin_mm: float = 1.5,
window_budget: float = 0.25,
window_cap: int = 40,
) -> tuple[ExactRouteResult, int, list[str]]:
"""Route a parsed :class:`DsnBoard` with the exact-geometry (orthogonal,
DRC-verified) track; return the exact result, the scale, and layer names.
@@ -255,48 +286,31 @@ def route_dsn_board_exact(
edge_clearance_board = _mm_to_board(dsn, scale, edge_clearance_mm)
width_board = round(_rule_width_dsn(dsn) * scale)
clearance_board = round(_rule_clearance_dsn(dsn) * scale)
# the settings a window re-route repeats, at its own resolution
common = {
"heuristic_weight": heuristic_weight,
"via_half": _via_half_board(dsn, scale),
"edge_clearance": edge_clearance_board,
"trace_width": width_board,
"clearance": clearance_board,
"layers": layers,
"max_passes": max_passes,
"rip_up": rip_up,
"shove": shove,
"diagonal": diagonal,
"rollback": rollback,
"tree_nets": tree_nets,
"net_widths": _net_widths_board(dsn, scale),
"via_drill": _via_drill_board(dsn, scale),
"hole_to_hole": _mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
}
started = time.monotonic()
if fanout:
_place_fanout(board, dsn, scale, layers, width_board, clearance_board,
edge_clearance_board, hole_to_hole_mm, fanout, fanout_min_pins)
exact = route_board_exact(
board,
resolution=resolution,
heuristic_weight=heuristic_weight,
via_half=_via_half_board(dsn, scale),
edge_clearance=edge_clearance_board,
trace_width=width_board,
clearance=clearance_board,
layers=layers,
max_passes=max_passes,
rip_up=rip_up,
shove=shove,
diagonal=diagonal,
seed=seed,
route_first=route_first,
access_cost=access_cost,
negotiate=negotiate,
**common,
)
if window_reroute > 0:
via_half = common["via_half"] or max(width_board // 2, 1)
exact.result = window_reroute_stage(
dsn, exact.result, common,
rounds=window_reroute,
resolution=max(int(window_resolution), resolution),
margin=_mm_to_board(dsn, scale, window_margin_mm) or 0,
via_half=via_half,
via_drill=common["via_drill"] or 2 * via_half,
via_name=_via_padstack(dsn),
# a share of what the routing itself took
budget_s=max(float(window_budget), 0.0) * (time.monotonic() - started),
max_windows=window_cap,
rollback=rollback,
net_widths=_net_widths_board(dsn, scale),
via_drill=_via_drill_board(dsn, scale),
hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
)
_add_generated(exact.result, board)
return exact, scale, [layer.name for layer in dsn.layers]
@@ -314,15 +328,10 @@ def build_exact_routing_result(
seed: int | None = None,
route_first: frozenset | None = None,
access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25,
fanout: bool | str = False,
fanout_min_pins: int = 32,
rollback: bool = True,
tree_nets: bool = True,
window_reroute: int = 0,
window_resolution: int = 4,
window_margin_mm: float = 1.5,
window_budget: float = 0.25,
window_cap: int = 40,
) -> RoutingResult:
"""Route ``dsn`` (exact track) and convert to a DSN-unit RoutingResult."""
exact, scale, layer_names = route_dsn_board_exact(
@@ -338,15 +347,10 @@ def build_exact_routing_result(
seed=seed,
route_first=route_first,
access_cost=access_cost,
negotiate=negotiate,
hole_to_hole_mm=hole_to_hole_mm,
fanout=fanout,
fanout_min_pins=fanout_min_pins,
rollback=rollback,
tree_nets=tree_nets,
window_reroute=window_reroute,
window_resolution=window_resolution,
window_margin_mm=window_margin_mm,
window_budget=window_budget,
window_cap=window_cap,
)
return _to_routing_result(exact.result, dsn, scale, layer_names)
@@ -30,10 +30,10 @@ from __future__ import annotations
from dataclasses import dataclass, field
import heapq
from rpmroute.board.board import BasicBoard
from rpmroute.board.items import Pin
from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from rpmroute.geometry import IntBox, IntPoint, Polyline, PolylineShape, shove_segment
from freeroute.board.board import BasicBoard
from freeroute.board.items import Pin
from freeroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.geometry import IntBox, IntPoint, Polyline, PolylineShape, shove_segment
from .exact_router import ExactRouteResult, _routable_nets
from .grid_router import RouteResult
@@ -56,7 +56,7 @@ class _Accepted:
``wires`` / ``vias`` are the *same* list objects as ``RouteResult.wires`` /
``.vias`` for this net, so rewriting a shoved wire in place also updates the
routed output. ``wire_owners`` is parallel to ``wires``: each entry is the
list of :class:`~rpmroute.board.search_tree.TreeShape` owner ids for that
list of :class:`~freeroute.board.search_tree.TreeShape` owner ids for that
wire's copper tiles, so a later shove can locate, remove, and roll back a
specific wire without disturbing a multi-wire net's other connections.
"""
@@ -1,6 +1,6 @@
"""Shared orthogonal shove primitives for the exact and room routers.
The exact-geometry router (:mod:`rpmroute.route.exact_router`) grew the first
The exact-geometry router (:mod:`freeroute.route.exact_router`) grew the first
shove implementation; the continuous room router reuses its geometry so both
tracks agree on how a blocking trace's conflicting segment is found, how the
perpendicular displacement ladder is generated, and how a reshaped trace is
@@ -19,8 +19,8 @@ from __future__ import annotations
from collections.abc import Iterator
from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from rpmroute.geometry import IntBox, IntPoint, Polyline, PolylineShape
from freeroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.geometry import IntBox, IntPoint, Polyline, PolylineShape
from .exact_router import _conflicting_segment as conflicting_segment
@@ -1,9 +1,9 @@
"""Specctra SES (session) writing for rpmroute.
"""Specctra SES (session) writing for freeroute.
Public API::
from rpmroute.dsn import parse_dsn
from rpmroute.ses import write_ses, RoutingResult, RoutedWire, RoutedVia
from freeroute.dsn import parse_dsn
from freeroute.ses import write_ses, RoutingResult, RoutedWire, RoutedVia
board = parse_dsn(dsn_text)
ses_text = write_ses(board) # valid no-op session
@@ -1,8 +1,8 @@
"""Specctra SES session-file writer.
Ports the write path of FreeRouting's ``io/specctra/SesWriter.java`` to operate
on this project's parsed :class:`~rpmroute.dsn.model.DsnBoard` plus an
in-memory :class:`~rpmroute.ses.model.RoutingResult`. The emitted structure is::
on this project's parsed :class:`~freeroute.dsn.model.DsnBoard` plus an
in-memory :class:`~freeroute.ses.model.RoutingResult`. The emitted structure is::
(session <name>
(base_design <name>)
@@ -30,8 +30,8 @@ from __future__ import annotations
import math
from rpmroute.dsn.model import DsnBoard
from rpmroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape
from freeroute.dsn.model import DsnBoard
from freeroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape
from .indent import Identifier, IndentWriter
from .model import RoutedNet, RoutedVia, RoutedWire, RoutingResult
-3
View File
@@ -1,3 +0,0 @@
"""rpmroute — native Python PCB autorouter (Java-free FreeRouting port)."""
__version__ = "0.1.0"
-248
View File
@@ -1,248 +0,0 @@
"""Window re-route: a last stage for the connections still unrouted.
Around each stuck connection a window is cut: the box of its two end pins
plus a margin. Every net whose routed copper lies wholly inside it is
ripped; everything else stays, as fixed copper. The window is then routed
again on its own, on a finer grid than the whole board can afford, the
stuck connection's net and the ripped nets only. The result is kept only
if fewer connections are left unrouted than before; otherwise the board is
as it was. Each round doubles the margin for the connections still stuck.
It is a last stage, so it is kept cheap: a window's board holds only what
the window needs (every pin and piece of copper of the nets it reroutes,
so their connectivity is unchanged, and of the other items only those near
the window), the smallest windows go first, at most ``max_windows`` run per
round, and no new window starts once ``budget_s`` seconds are spent.
What makes it differ from re-running the same search near the failure: the
finer grid finds gaps the board's grid steps over, and the ripped nets go in
again in a new order around the stuck one. A finer grid on the whole board
costs routes elsewhere (its cells are slower and its order changes); inside
a small window it only ever replaces what it can improve.
"""
from __future__ import annotations
import time
from typing import Any
from rpmroute.board import BasicBoard, build_board
from rpmroute.board.items import ObstacleArea, Pin, Trace, Via
from rpmroute.dsn import DsnBoard
from rpmroute.geometry import IntBox, IntPoint
from .exact_router import route_board_exact
from .grid_router import RouteResult
Copper = tuple[list[tuple[int, list[IntPoint]]], list[IntPoint]]
def _pin_labels(board) -> dict[tuple[int, str], IntPoint]:
"""Each pin's location by (net, label), the label a failure names it by."""
found: dict[tuple[int, str], IntPoint] = {}
for pin in board.get_pins():
for net in pin.net_nos:
found.setdefault((net, f"{pin.component_ref}-{pin.name}"), pin.location)
return found
def _end_point(labels, net: int, label: str) -> IntPoint | None:
"""Where a failure's end is: the first pin its label names."""
return labels.get((net, label.split("/")[0]))
def _inside(copper: Copper, window: IntBox) -> bool:
wires, vias = copper
points = [p for _layer, path in wires for p in path] + list(vias)
return bool(points) and all(
window.ll.x <= p.x <= window.ur.x and window.ll.y <= p.y <= window.ur.y for p in points
)
def _item_box(item) -> IntBox | None:
if isinstance(item, (Pin, Via)):
return item.shape.bounding_box() if item.shape is not None else None
if isinstance(item, ObstacleArea):
return item.bounding_box()
if isinstance(item, Trace) and item.corners:
h = item.half_width
xs, ys = [p.x for p in item.corners], [p.y for p in item.corners]
return IntBox(min(xs) - h, min(ys) - h, max(xs) + h, max(ys) + h)
return None
def _meets(box: IntBox | None, view: IntBox) -> bool:
return box is not None and box.ll.x <= view.ur.x and view.ll.x <= box.ur.x and (
box.ll.y <= view.ur.y and view.ll.y <= box.ur.y
)
def _path_box(path: list[IntPoint], grow: int) -> IntBox:
xs, ys = [p.x for p in path], [p.y for p in path]
return IntBox(min(xs) - grow, min(ys) - grow, max(xs) + grow, max(ys) + grow)
def _window_board(
base: BasicBoard, base_items: list, view: IntBox, affected: set[int],
copper: dict[int, Copper], keep: set[int], half: dict[int, int], default_half: int,
via_half: int, via_drill: int, layers: list[int], via_name: str,
) -> BasicBoard:
"""The board a window is routed on: the base board's items of the nets
being rerouted and those near ``view``, plus the routed copper being kept
(all of an affected net's, so its connectivity is the whole board's, and
of other nets only what is near ``view``), as fixed copper."""
board = BasicBoard(base.layer_structure, base.nets, base.clearance_matrix, base.bounding_box)
board.outline = base.outline
for item, box in base_items:
if (item.net_nos and item.net_nos[0] in affected) or _meets(box, view):
board.insert(item)
for net in keep:
wires, vias = copper.get(net, ([], []))
width = half.get(net, default_half)
mine = net in affected
for layer, path in wires:
if len(path) >= 2 and (mine or _meets(_path_box(path, width), view)):
board.insert(Trace(net_nos=[net], fixed=True, layer=layer, half_width=width, corners=list(path)))
for location in dict.fromkeys(vias):
shape = IntBox(location.x - via_half, location.y - via_half,
location.x + via_half, location.y + via_half)
if mine or _meets(shape, view):
board.insert(Via(
net_nos=[net], fixed=True, padstack_name=via_name, drill=via_drill,
location=location, layers=list(layers), shape=shape,
))
return board
def _open(failed) -> list:
"""Failures that are real opens, not connections left to a zone fill."""
return [f for f in failed if not (len(f) > 3 and f[3])]
def window_reroute(
dsn: DsnBoard,
result: RouteResult,
route_args: dict[str, Any],
*,
rounds: int,
resolution: int,
margin: int,
via_half: int,
via_drill: int,
via_name: str,
budget_s: float | None = None,
max_windows: int = 40,
) -> RouteResult:
"""Re-route a window around each still-failing connection; keep only gains.
``route_args`` are the exact engine's settings for the whole board (width,
clearance, layers, shove, ...); the window runs them at ``resolution``.
``margin`` is the first round's window margin in board units. No new
window starts once ``budget_s`` seconds have gone by (None: no limit),
and at most ``max_windows`` run per round."""
started = time.monotonic()
if rounds < 1 or not _open(result.failed):
return result
default_half = result.half_width
copper: dict[int, Copper] = {
net: (list(result.wires.get(net, [])), list(result.vias.get(net, [])))
for net in set(result.wires) | set(result.vias)
}
half = dict(result.net_half)
failed = list(result.failed)
base = build_board(dsn)
base_items = [(item, _item_box(item)) for item in base.get_items()]
layers = route_args.get("layers") or [
i for i, layer in enumerate(base.layer_structure.arr) if layer.is_signal
]
labels = _pin_labels(base)
# the copper a window's routing can feel from outside it
context = 2 * (route_args["trace_width"] + route_args["clearance"]) + 2 * via_half + (
route_args.get("edge_clearance") or 0
)
def window_of(entry, reach: int) -> IntBox | None:
ends = [_end_point(labels, entry[0], label) for label in entry[1:3]]
ends = [p for p in ends if p is not None]
if not ends:
return None
return IntBox(
min(p.x for p in ends) - reach, min(p.y for p in ends) - reach,
max(p.x for p in ends) + reach, max(p.y for p in ends) + reach,
)
def area(box: IntBox | None) -> float:
return float("inf") if box is None else (box.ur.x - box.ll.x) * (box.ur.y - box.ll.y)
changed = out_of_time = False
for rnd in range(rounds):
reach = margin * (2 ** rnd)
# the cheap wins first: the smallest windows
todo = sorted(_open(list(failed)), key=lambda f: area(window_of(f, reach)))
for entry in todo[:max(int(max_windows), 1)]:
if budget_s is not None and time.monotonic() - started >= budget_s:
out_of_time = True
break
if entry not in failed:
continue # an earlier window routed it
net = entry[0]
window = window_of(entry, reach)
if window is None:
continue
victims = {n for n, c in copper.items() if _inside(c, window)}
affected = victims | {net}
before = _open(f for f in failed if f[0] in affected)
keep = set(copper) - victims
view = IntBox(window.ll.x - context, window.ll.y - context,
window.ur.x + context, window.ur.y + context)
board = _window_board(base, base_items, view, affected, copper, keep, half,
default_half, via_half, via_drill, layers, via_name)
sub = route_board_exact(
board, **route_args, resolution=resolution,
only_nets=frozenset(affected), bounds=window,
route_first=frozenset((f[0], f[1], f[2]) for f in before),
).result
after = _open(f for f in sub.failed if f[0] in affected)
if len(after) >= len(before):
continue
# the window board left out what lies away from it, so copper
# reaching out of the window was never checked against it
if any(not _inside((sub.wires.get(n, []), sub.vias.get(n, [])), window)
for n in affected if sub.wires.get(n) or sub.vias.get(n)):
continue
# a net keeping some of its copper is written at one width: the
# window's new copper has to have gone in at that width too
if any(
n not in victims and copper.get(n) and (sub.wires.get(n) or sub.vias.get(n))
and sub.net_half.get(n, default_half) != half.get(n, default_half)
for n in affected
):
continue
for n in affected:
kept_wires, kept_vias = copper.get(n, ([], [])) if n not in victims else ([], [])
copper[n] = (kept_wires + sub.wires.get(n, []), kept_vias + sub.vias.get(n, []))
if n in victims:
half.pop(n, None)
if n in sub.net_half:
half[n] = sub.net_half[n]
failed = [f for f in failed if f[0] not in affected] + [
f for f in sub.failed if f[0] in affected
]
changed = True
if out_of_time or not _open(failed):
break
if not changed:
return result
out = RouteResult(default_half)
for net, (wires, vias) in copper.items():
for layer, path in wires:
out.add_wire(net, layer, path)
for location in dict.fromkeys(vias):
out.add_via(net, location)
out.failed = failed
out.unrouted = len(_open(failed))
out.net_half = half
out.narrowed = list(result.narrowed)
return out
+1 -1
View File
@@ -2,7 +2,7 @@
from __future__ import annotations
from rpmroute.board import (
from freeroute.board import (
ClearanceMatrix,
CoordinateTransform,
Layer,
+6 -6
View File
@@ -15,9 +15,9 @@ import sys
import pytest
from rpmroute.board import BasicBoard, ObstacleArea, Pin, build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntPoint
from freeroute.board import BasicBoard, ObstacleArea, Pin, build_board
from freeroute.dsn import parse_dsn
from freeroute.geometry import IntPoint
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -184,7 +184,7 @@ def test_place_keepout_does_not_block_routing():
def test_grid_router_leaves_the_interior_of_a_ring_keepout_open():
from rpmroute.route.pipeline import route_dsn_board
from freeroute.route.pipeline import route_dsn_board
ring_only = "\n".join(
line for line in _RING_DSN.splitlines() if "wire_keepout" not in line
@@ -251,7 +251,7 @@ def test_oval_pad_keeps_its_width():
def test_via_size_comes_from_the_via_padstack():
from rpmroute.route.pipeline import _via_half_board
from freeroute.route.pipeline import _via_half_board
assert _via_half_board(parse_dsn(_PAD_DSN), 10) == 3000 # 0.6 mm via, board units
@@ -279,7 +279,7 @@ def test_a_keepout_named_rule_area_takes_no_clearance():
def _route_channel(name):
from rpmroute.route.pipeline import build_exact_routing_result
from freeroute.route.pipeline import build_exact_routing_result
return build_exact_routing_result(parse_dsn(_CHANNEL_DSN.format(name=name)), resolution=2)
+2 -2
View File
@@ -2,8 +2,8 @@
from __future__ import annotations
from rpmroute.board import ShapeSearchTree, TreeShape
from rpmroute.geometry import IntBox
from freeroute.board import ShapeSearchTree, TreeShape
from freeroute.geometry import IntBox
def shape(owner, net, layer, box, routed=False):
+4 -4
View File
@@ -6,10 +6,10 @@ from pathlib import Path
import pytest
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.reader import DsnParseError
from rpmroute.dsn.shapes import Circle, Rectangle
from rpmroute.dsn.shapes import Path as DsnPath
from freeroute.dsn import parse_dsn
from freeroute.dsn.reader import DsnParseError
from freeroute.dsn.shapes import Circle, Rectangle
from freeroute.dsn.shapes import Path as DsnPath
FIXTURES = Path(__file__).parent / "fixtures"
+2 -2
View File
@@ -4,8 +4,8 @@ from __future__ import annotations
import pytest
from rpmroute.dsn.sexp import SExp, parse
from rpmroute.dsn.tokenizer import DsnSyntaxError, Token
from freeroute.dsn.sexp import SExp, parse
from freeroute.dsn.tokenizer import DsnSyntaxError, Token
def test_parse_simple_head_and_values():
+2 -2
View File
@@ -2,8 +2,8 @@
from __future__ import annotations
from rpmroute.dsn.sexp import parse
from rpmroute.dsn.shapes import (
from freeroute.dsn.sexp import parse
from freeroute.dsn.shapes import (
Circle,
Path,
Polygon,
+1 -1
View File
@@ -4,7 +4,7 @@ from __future__ import annotations
import pytest
from rpmroute.dsn.tokenizer import DsnSyntaxError, TokenKind, tokenize
from freeroute.dsn.tokenizer import DsnSyntaxError, TokenKind, tokenize
def kinds(text: str) -> list[TokenKind]:
+1 -1
View File
@@ -6,7 +6,7 @@ containment and degenerate (empty / point / segment) tiles.
from __future__ import annotations
from rpmroute.geometry import IntBox, IntPoint, IntVector, RationalPoint
from freeroute.geometry import IntBox, IntPoint, IntVector, RationalPoint
def test_measures():
+1 -1
View File
@@ -5,7 +5,7 @@ Oracles hand-derived from ``geometry/planar/{Direction,IntDirection}.java``.
from __future__ import annotations
from rpmroute.geometry import Direction, IntDirection, IntPoint, IntVector, Side
from freeroute.geometry import Direction, IntDirection, IntPoint, IntVector, Side
def test_normalized_direction_reduces_by_gcd():
+2 -2
View File
@@ -5,7 +5,7 @@ Oracles hand-derived from ``geometry/planar/Line.java``.
from __future__ import annotations
from rpmroute.geometry import IntPoint, Line, RationalPoint, Side
from freeroute.geometry import IntPoint, Line, RationalPoint, Side
def test_side_of_point():
@@ -79,7 +79,7 @@ def test_intersection_approx_matches_exact():
def test_translate_and_opposite():
line = Line.from_coords(0, 0, 4, 0)
assert line.opposite().direction().equals(line.direction()) is False
from rpmroute.geometry import IntVector
from freeroute.geometry import IntVector
moved = line.translate_by(IntVector(0, 5))
assert moved.side_of(IntPoint(2, 5)) == Side.COLLINEAR
+1 -1
View File
@@ -7,7 +7,7 @@ import random
import pytest
from rpmroute.geometry import IntBox, IntPoint, ceil_sqrt2, overlaps_2d, segment_octagon
from freeroute.geometry import IntBox, IntPoint, ceil_sqrt2, overlaps_2d, segment_octagon
@pytest.mark.parametrize("r", [0, 1, 2, 3, 1000, 2000, 3000, 12345, 999999])
+2 -2
View File
@@ -8,7 +8,7 @@ Java ``long``, and rational equality.
from __future__ import annotations
from rpmroute.geometry import (
from freeroute.geometry import (
IntPoint,
IntVector,
RationalPoint,
@@ -139,7 +139,7 @@ def test_rational_point_infinite():
def test_rational_point_contained_in_box_exact():
from rpmroute.geometry import IntBox
from freeroute.geometry import IntBox
box = IntBox(0, 0, 2, 2)
assert RationalPoint(3, 2, 2).is_contained_in(box) # (1.5, 1.0) inside
+3 -3
View File
@@ -13,9 +13,9 @@ from __future__ import annotations
import pytest
from rpmroute.geometry import IntPoint, Side
from rpmroute.geometry.polygon import Polygon
from rpmroute.geometry.polygon_shape import PolygonShape
from freeroute.geometry import IntPoint, Side
from freeroute.geometry.polygon import Polygon
from freeroute.geometry.polygon_shape import PolygonShape
def pts(*coords):
+1 -1
View File
@@ -2,7 +2,7 @@
from __future__ import annotations
from rpmroute.geometry import (
from freeroute.geometry import (
IntBox,
IntPoint,
Polyline,
+2 -2
View File
@@ -16,7 +16,7 @@ Source: ``geometry/planar/{TileShape,Simplex}.java``.
from __future__ import annotations
from rpmroute.geometry import IntBox, IntPoint, Line, Side, Simplex
from freeroute.geometry import IntBox, IntPoint, Line, Side, Simplex
def _grid(lo: int, hi: int):
@@ -162,7 +162,7 @@ def test_get_instance_detects_empty_from_opposing_halfplanes():
def test_translate_preserves_shape():
tri = right_triangle()
from rpmroute.geometry import IntVector
from freeroute.geometry import IntVector
moved = tri.translate_by(IntVector(100, 50))
for p in _grid(-3, 13):
+5 -5
View File
@@ -1,8 +1,8 @@
"""FreeRouting JAR oracle for behaviour-level validation.
**Dev/test only — not part of the shipped package** (rpmroute is Java-free by
**Dev/test only — not part of the shipped package** (freeroute is Java-free by
design). This runs the reference FreeRouting JAR to route a Specctra DSN so that
rpmroute's own output can be diffed against the reference implementation. There
freeroute's own output can be diffed against the reference implementation. There
are no unit-test oracles for FreeRouting's geometry/router, so the oracle is how
we validate at the behaviour level: same DSN in, compare routed connectivity.
@@ -10,7 +10,7 @@ Tests that use this skip automatically when a Java 21+ runtime or the JAR is not
available (e.g. CI without a JVM), so the normal suite stays Java-free.
Overrides:
- ``RPMROUTE_ORACLE_JAVA`` (or the older ``FREEROUTE_ORACLE_JAVA``) — explicit path to a ``java`` binary.
- ``FREEROUTE_ORACLE_JAVA`` — explicit path to a ``java`` binary.
- ``FREEROUTING_JAR`` — explicit path to a freerouting JAR.
"""
@@ -27,7 +27,7 @@ import tempfile
import pytest
from rpmroute.dsn.sexp import parse
from freeroute.dsn.sexp import parse
_MIN_JAVA_MAJOR = 21
_REPO_ROOT = Path(__file__).resolve().parents[1]
@@ -60,7 +60,7 @@ def _java_major(java: str) -> int:
def find_java() -> str | None:
"""Return a path to a Java >= 21 runtime, or None."""
candidates: list[str] = []
override = os.environ.get("RPMROUTE_ORACLE_JAVA") or os.environ.get("FREEROUTE_ORACLE_JAVA")
override = os.environ.get("FREEROUTE_ORACLE_JAVA")
if override:
candidates.append(override)
java_home = os.environ.get("JAVA_HOME")
-113
View File
@@ -1,113 +0,0 @@
"""Pins of a fine-pitch part turned off the grid axes leave along their pads.
A QFN at 45 degrees has no straight exit: every horizontal or vertical step
from a pin passes its neighbours closer than the clearance (0.35 mm away on
each axis at 0.5 mm pitch). The grid leaves along the pad's own axis first,
past the pin row, and the exact engine checks that slanted leg on its exact
copper. Found on th-eda's lift ESC, where a QFN-24 at 45 degrees left 15
connections unroutable on an empty board.
"""
from __future__ import annotations
import math
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntPoint, overlaps_2d, segment_slab
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import (
_rule_clearance_dsn,
_rule_width_dsn,
_via_half_board,
build_exact_routing_result,
)
def _qfn_side_dsn(rotation: float) -> str:
"""Two rows of five 0.25 x 0.8 mm pads at 0.5 mm pitch (one side of a
QFN and its opposite side), turned by ``rotation``; each pin of the top
row is its own net, routed to a pad 4.5 mm out, the pads fanned 1.5 mm
apart."""
cx, cy = 100000, -100000
t = math.radians(rotation)
out = (-math.sin(t), math.cos(t)) # the pads' outward axis after turning
along = (math.cos(t), math.sin(t)) # the pin row
pins, targets, nets = [], [], []
for i in range(5):
x = -1000 + 500 * i
pins += [f"(pin P {i + 1} {x} 1000)", f"(pin P {i + 6} {x} -1000)"]
px = cx + x * math.cos(t) - 1000 * math.sin(t)
py = cy + x * math.sin(t) + 1000 * math.cos(t)
spread = 1500 * (i - 2) - x # fan the far pads out to 1.5 mm apart
tx = px + 4500 * out[0] + spread * along[0]
ty = py + 4500 * out[1] + spread * along[1]
targets.append(f"(place T{i + 1} {round(tx)} {round(ty)} front 0)")
nets.append(f"(net N{i} (pins U1-{i + 1} T{i + 1}-1))")
return f"""(pcb qfn (parser) (resolution um 10) (unit um)
(structure
(layer F.Cu (type signal)) (layer B.Cu (type signal))
(boundary (path pcb 0 115000 -115000 85000 -115000 85000 -85000 115000 -85000
115000 -115000))
(via "Via[0-1]_450:200_um")
(rule (width 150) (clearance 150)))
(placement
(component Q (place U1 {cx} {cy} front {rotation}))
(component T {" ".join(targets)}))
(library
(image Q {" ".join(pins)})
(image T (pin t 1 0 0))
(padstack P (shape (rect F.Cu -125 -400 125 400)) (attach off))
(padstack t (shape (rect F.Cu -300 -300 300 300)) (attach off))
(padstack "Via[0-1]_450:200_um" (shape (circle F.Cu 450)) (shape (circle B.Cu 450))
(attach off)))
(network {" ".join(nets)}))"""
@pytest.mark.parametrize("rotation", [45, 30, -45])
def test_a_turned_fine_pitch_part_gets_its_pins_out(rotation):
result = build_exact_routing_result(parse_dsn(_qfn_side_dsn(rotation)), resolution=2, shove=True)
assert result.unrouted == []
def test_the_exit_runs_along_the_pad_axis_and_clears_the_neighbours():
dsn = parse_dsn(_qfn_side_dsn(45))
s = dsn.resolution.value
board = build_board(dsn)
router = GridRouter(
board,
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
via_half=_via_half_board(dsn, s),
orthogonal=True,
)
pins = {p.name: p for p in board.get_pins() if p.component_ref == "U1"}
pin = pins["3"]
exit_point = router._axis_exit(pin)
assert exit_point is not None
dx, dy = exit_point.x - pin.location.x, exit_point.y - pin.location.y
assert abs(abs(dx) - abs(dy)) <= 2 # along the 45-degree axis
leg = segment_slab(pin.location, exit_point, router.half_width + router.clearance)
for name in ("2", "4"):
assert not overlaps_2d(leg, pins[name].shape)
def test_a_pad_on_the_grid_axes_keeps_the_usual_exits():
dsn = parse_dsn(_qfn_side_dsn(0))
s = dsn.resolution.value
board = build_board(dsn)
router = GridRouter(board, trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), via_half=_via_half_board(dsn, s))
pin = next(p for p in board.get_pins() if p.component_ref == "U1" and p.name == "3")
assert router._axis_exit(pin) is None
def test_a_slanted_slab_is_tight_where_a_bounding_box_is_not():
slab = segment_slab(IntPoint(0, 0), IntPoint(10000, 10000), 750)
# a point beside the diagonal but inside its bounding box
from rpmroute.geometry import IntBox
assert not overlaps_2d(slab, IntBox(8000, 0, 8100, 100))
assert overlaps_2d(slab, IntBox(4900, 4900, 5100, 5100))
+6 -6
View File
@@ -16,11 +16,11 @@ from pathlib import Path
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.geometry import IntBox, IntPoint, overlaps_2d, segment_octagon
from rpmroute.route import route, route_dsn_board_exact
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.geometry import IntBox, IntPoint, overlaps_2d, segment_octagon
from freeroute.route import route, route_dsn_board_exact
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
DIAGONAL_WIN = FIXTURES / "diagonal_win.dsn"
@@ -55,7 +55,7 @@ def _pins_by_net(fixture):
def _rule_clearance_board(fixture):
from rpmroute.route.pipeline import _rule_clearance_dsn
from freeroute.route.pipeline import _rule_clearance_dsn
dsn = parse_dsn(fixture.read_text())
return round(_rule_clearance_dsn(dsn) * max(dsn.resolution.value, 1))
+6 -6
View File
@@ -15,12 +15,12 @@ import sys
import pytest
from rpmroute.board import ShapeSearchTree, TreeShape, build_board
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.geometry import IntBox, Polyline, PolylineShape
from rpmroute.route import route, route_dsn_board, route_dsn_board_exact
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
from freeroute.board import ShapeSearchTree, TreeShape, build_board
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.geometry import IntBox, Polyline, PolylineShape
from freeroute.route import route, route_dsn_board, route_dsn_board_exact
from freeroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
+78
View File
@@ -0,0 +1,78 @@
"""--fanout: fine-pitch pins get their way out committed before routing."""
from __future__ import annotations
from freeroute.board import build_board
from freeroute.board.items import Trace, Via
from freeroute.dsn import parse_dsn
from freeroute.route.fanout import FanoutRules, plan_fanout
from freeroute.route.pipeline import route_dsn_board_exact
# a 12-pad package, 3 pads a side at 0.5 mm pitch, over a GND plane on In1;
# pad 1 (left side, top) is GND, the rest are signals to far connector pads
_SIDES = {
"L": [(-2000, y, 0) for y in (500, 0, -500)],
"R": [(2000, y, 0) for y in (500, 0, -500)],
"T": [(x, 2000, 90) for x in (-500, 0, 500)],
"B": [(x, -2000, 90) for x in (-500, 0, 500)],
}
_PADS = [p for side in "LRTB" for p in _SIDES[side]]
def _dsn():
pins = "\n ".join(
f"(pin {'padv' if r else 'padh'} {i + 1} {x} {y})" for i, (x, y, r) in enumerate(_PADS)
)
far = " ".join(f"(place C{i} {3000 + 2000 * (i % 5)} {-12000 - 2000 * (i // 5)} front 0)" for i in range(11))
nets = "(net GND (pins U1-1))\n " + "\n ".join(f"(net S{i} (pins U1-{i + 2} C{i}-1))" for i in range(11))
return f"""(pcb pkg (parser) (resolution um 10) (unit um)
(structure
(layer F.Cu (type signal)) (layer In1.Cu (type power)) (layer In2.Cu (type power))
(layer B.Cu (type signal))
(boundary (path pcb 0 -15000 15000 25000 15000 25000 -25000 -15000 -25000 -15000 15000))
(plane GND (polygon In1.Cu 0 -14500 14500 24500 14500 24500 -24500 -14500 -24500 -14500 14500))
(via "Via[0-3]_450:200_um") (rule (width 150) (clearance 150)))
(placement (component Q (place U1 0 0 front 0)) (component P {far}))
(library
(image Q
{pins})
(image P (pin padc 1 0 0))
(padstack padh (shape (rect F.Cu -400 -125 400 125)) (attach off))
(padstack padv (shape (rect F.Cu -125 -400 125 400)) (attach off))
(padstack padc (shape (rect F.Cu -500 -500 500 500)) (attach off))
(padstack "Via[0-3]_450:200_um" (shape (circle F.Cu 450)) (shape (circle B.Cu 450)) (attach off)))
(network {nets}))"""
def _rules(dsn):
s = dsn.resolution.value
return FanoutRules(trace_width=150 * s, clearance=150 * s, via_half=225 * s, via_drill=200 * s,
hole_to_hole=250 * s, edge_clearance=0, signal_layers=[0, 3],
via_padstack="Via[0-3]_450:200_um", min_pins=8)
def test_every_pin_gets_a_stub_outward_past_its_pad():
dsn = parse_dsn(_dsn())
board = build_board(dsn)
items = plan_fanout(board, _rules(dsn))
stubs = [i for i in items if isinstance(i, Trace)]
assert len(stubs) == 12
for stub in stubs:
a, b = stub.corners
pin = next(p for p in board.get_pins() if p.location == a)
pad = pin.shape.bounding_box()
# outward: the stub ends further from the package centre, outside its pad
assert abs(b.x) + abs(b.y) > abs(a.x) + abs(a.y)
assert not (pad.ll.x <= b.x <= pad.ur.x and pad.ll.y <= b.y <= pad.ur.y)
def test_a_plane_pin_gets_a_via_and_needs_no_route():
dsn = parse_dsn(_dsn())
board = build_board(dsn)
items = plan_fanout(board, _rules(dsn))
assert len([i for i in items if isinstance(i, Via)]) == 1
exact, _scale, _ = route_dsn_board_exact(dsn, resolution=2, fanout=True, fanout_min_pins=8)
gnd = next(i + 1 for i, n in enumerate(dsn.nets) if n.name == "GND")
assert not any(f[0] == gnd for f in exact.result.failed)
assert exact.drc_clean
assert len(exact.result.vias.get(gnd, [])) == 1 # the fan-out's, written out
+5 -5
View File
@@ -2,9 +2,9 @@
from __future__ import annotations
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route.pipeline import route_dsn_board_exact
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.route.pipeline import route_dsn_board_exact
_DSN = """(pcb wired (parser) (resolution um 10) (unit um)
(structure
@@ -95,9 +95,9 @@ def test_a_fanned_out_signal_is_routed_from_its_via():
def test_the_session_never_repeats_copper_already_on_the_board():
# the JAR writes the DSN's wiring back into its session, and an applier
# then adds it a second time on top of itself; rpmroute writes only
# then adds it a second time on top of itself; freeroute writes only
# what it routed
from rpmroute.route.pipeline import build_exact_routing_result
from freeroute.route.pipeline import build_exact_routing_result
fixed_vias = {(5000.0, -11500.0), (10000.0, -11500.0)}
fixed_paths = {(5000.0, -10000.0, 5000.0, -11500.0), (10000.0, -10000.0, 10000.0, -11500.0),
-284
View File
@@ -1,284 +0,0 @@
"""The grid must not believe copper legal that the exact check then refuses.
Each case is one way the two used to disagree on roomba-ESP12E: a rotated oval
pad modelled as an inflated box (and opened to its own net), a via shared by
two connections of a net losing its footprint when one of them is ripped, and
a wider net class searched as if it were the default width.
"""
from __future__ import annotations
import math
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntBox, Simplex
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import (
_rule_clearance_dsn,
_rule_width_dsn,
_via_half_board,
build_exact_routing_result,
)
# --- rotated oval pads -------------------------------------------------------
def _socket_dsn(rotation: float, layout: str) -> str:
"""A 1x4 2.54 mm socket strip (rect pin 1, oval pins 2-4) at ``rotation``,
each pin its own net, routed to a small SMD pad 0.9 mm away."""
cx, cy = 100000, -100000
t = math.radians(rotation)
ax = (math.cos(t), math.sin(t))
perp = (-math.sin(t), math.cos(t))
places = []
for i in range(4):
px, py = cx + 2540 * i * ax[0], cy + 2540 * i * ax[1]
side = 1 if i % 2 == 0 else -1
if layout == "y":
tx, ty = px, py + side * 9000
else:
tx, ty = px + side * 8000 * perp[0], py + side * 8000 * perp[1]
places.append(f"(place T{i + 1} {round(tx)} {round(ty)} front 0)")
nets = " ".join(f"(net N{i} (pins P3-{i + 1} T{i + 1}-1))" for i in range(4))
return f"""(pcb socket (parser) (resolution um 10) (unit um)
(structure
(layer F.Cu (type signal)) (layer B.Cu (type signal))
(boundary (path pcb 0 125000 -115000 85000 -115000 85000 -75000 125000 -75000
125000 -115000))
(via "Via[0-1]_800:400_um")
(rule (width 300) (clearance 250)))
(placement
(component S (place P3 {cx} {cy} front {rotation}))
(component T {" ".join(places)}))
(library
(image S (pin R 1 0 0) (pin O 2 2540 0) (pin O 3 5080 0) (pin O 4 7620 0))
(image T (pin t 1 0 0))
(padstack O (shape (path F.Cu 1727.2 0 -152.4 0 152.4))
(shape (path B.Cu 1727.2 0 -152.4 0 152.4)) (attach off))
(padstack R (shape (rect F.Cu -863.6 -1016 863.6 1016))
(shape (rect B.Cu -863.6 -1016 863.6 1016)) (attach off))
(padstack t (shape (rect F.Cu -500 -500 500 500)) (attach off))
(padstack "Via[0-1]_800:400_um" (shape (circle F.Cu 800)) (shape (circle B.Cu 800))
(attach off)))
(network {nets}
(class c N0 N1 N2 N3 (circuit (use_via "Via[0-1]_800:400_um"))
(rule (width 300) (clearance 250)))))"""
def test_a_rotated_oval_pad_is_its_outline_not_its_bounding_box():
board = build_board(parse_dsn(_socket_dsn(60, "y")))
oval = next(p for p in board.get_pins() if p.component_ref == "P3" and p.name == "2")
assert isinstance(oval.shape, Simplex) and not oval.shape.is_int_box()
box = oval.shape.bounding_box()
assert oval.shape.contains(oval.location)
assert not oval.shape.contains(box.ll) and not oval.shape.contains(box.ur)
@pytest.mark.parametrize("layout", ["y", "perp"])
def test_routes_leaving_a_rotated_socket_pass_the_exact_check(layout):
result = build_exact_routing_result(
parse_dsn(_socket_dsn(60, layout)), resolution=2, shove=True
)
assert result.unrouted == []
# --- a via two connections share --------------------------------------------
_SHARED_VIA = """(pcb shared (parser) (resolution um 10) (unit um)
(structure
(layer Top (type signal)) (layer Bottom (type signal))
(boundary (path pcb 0 0 0 20000 0 20000 -20000 0 -20000 0 0))
(via "Via[0-1]_800:400_um")
(rule (width 300) (clearance 250)))
(library
(padstack p (shape (rect Top -400 -400 400 400)) (attach off))
(padstack "Via[0-1]_800:400_um" (shape (circle Top 800)) (shape (circle Bottom 800))
(attach off))
(image PAD (pin p 1 0 0)))
(placement (component PAD
(place G1 3000 -5000 front 0) (place G2 3000 -15000 front 0)
(place G3 17000 -10000 front 0) (place S1 3000 -10000 front 0)
(place S2 17000 -3000 front 0)))
(network (net GND (pins G1-1 G2-1 G3-1)) (net SIG (pins S1-1 S2-1))))"""
def _line(a, b, layer):
(x, y), (x1, y1) = a, b
out = [(x, y, layer)]
while x != x1:
x += 1 if x1 > x else -1
out.append((x, y, layer))
while y != y1:
y += 1 if y1 > y else -1
out.append((x, y, layer))
return out
def test_a_shared_via_keeps_its_footprint_when_one_user_is_ripped():
dsn = parse_dsn(_SHARED_VIA)
s = dsn.resolution.value
router = GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
via_half=_via_half_board(dsn, s),
)
conns = router._conns = router._build_connections()
gnd = [c for c in conns if len({c.a.component_ref, c.b.component_ref} & {"G1", "G2", "G3"})]
sig = next(c for c in conns if c not in gnd)
first, second = gnd
g3 = router._cell_of(next(p for p in router.board.get_pins() if p.component_ref == "G3").location)
via = (g3[0] - 10, g3[1])
def through_via(conn):
a, b = router._cell_of(conn.a.location), router._cell_of(conn.b.location)
return _line(a, via, 0) + _line(via, b, 1)
router._commit(first, through_via(first))
router._commit(second, through_via(second))
footprint = [c for c in router._via_cells(via) if c != via]
router._rip(first)
assert second.routed and via in second.via_cells
assert all(router._via_claims.get(c) == [second.index] for c in footprint)
# another net still keeps its distance from the via that is left
assert all(router._enter_cost_base(c, 0, sig.net_no, False, conns) is None for c in footprint)
def test_a_route_through_a_shared_via_rips_every_user():
"""Two connections of a net share a via. Another net routed through it
in rip-up mode has to rip both, or the one left keeps its via under the
new trace and the exact check throws one of them out."""
dsn = parse_dsn(_SHARED_VIA)
s = dsn.resolution.value
router = GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
via_half=_via_half_board(dsn, s),
)
conns = router._conns = router._build_connections()
gnd = [c for c in conns if len({c.a.component_ref, c.b.component_ref} & {"G1", "G2", "G3"})]
sig = next(c for c in conns if c not in gnd)
first, second = gnd
g3 = router._cell_of(next(p for p in router.board.get_pins() if p.component_ref == "G3").location)
via = (g3[0] - 10, g3[1])
def through_via(conn):
a, b = router._cell_of(conn.a.location), router._cell_of(conn.b.location)
return _line(a, via, 0) + _line(via, b, 1)
router._commit(first, through_via(first))
router._commit(second, through_via(second))
# the via's copper alone: footprint cells no trace or trace halo covers
crossing = [
node
for c in router._via_cells(via)
for node in ((*c, 0), (*c, 1))
if node not in router._cell_owner and node not in router._halo
]
assert crossing
assert router._crossed_owners(crossing, sig.net_no, conns) == {first.index, second.index}
# --- a wider net class --------------------------------------------------------
_WIDE = """(pcb wide (parser) (resolution um 10) (unit um)
(structure
(layer F.Cu (type signal))
(boundary (path pcb 0 0 0 20000 0 20000 -10000 0 -10000 0 0))
(rule (width 300) (clearance 250)))
(placement (component S (place P1 2000 -5000 front 0) (place P2 18000 -5000 front 0)
(place Q1 10000 {ylo} front 0) (place Q2 10000 {yhi} front 0)
(place Q3 10000 -1000 front 0) (place Q4 10000 -9000 front 0)))
(library (image S (pin pad 1 0 0)) (padstack pad (shape (rect F.Cu -600 -600 600 600)) (attach off)))
(network (net PWR (pins P1-1 P2-1)) (net SIG (pins Q1-1 Q3-1)) (net SIG2 (pins Q2-1 Q4-1))
(class Power PWR (rule (width 500) (clearance 250)))))"""
@pytest.mark.parametrize("resolution", [1, 2])
@pytest.mark.parametrize("gap", [900, 1000, 1075])
def test_a_wide_net_past_pads_it_does_not_fit_between_is_not_refused(gap, resolution):
# 0.3 mm fits the gap between the two pads, 0.5 mm does not: the grid
# must see that, rather than lay it wide and have the exact check drop it
ylo, yhi = -5000 - gap // 2 - 600, -5000 + gap // 2 + 600
result = build_exact_routing_result(
parse_dsn(_WIDE.format(ylo=ylo, yhi=yhi)), resolution=resolution
)
assert result.unrouted == []
def _wide_router():
dsn = parse_dsn(_WIDE.format(ylo=-6050, yhi=-3950))
s = dsn.resolution.value
pwr = next(i for i, net in enumerate(dsn.nets, 1) if net.name == "PWR")
return GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
resolution=2,
net_widths={pwr: 5000},
), pwr
def test_a_wide_trace_keeps_clear_of_a_default_one_at_the_grid_diagonal():
router, _pwr = _wide_router()
# 0.5 mm against 0.3 mm needs 0.25 + 0.25 + 0.15 = 0.65 mm between centres,
# on either axis, since the exact check compares boxes
need = 2500 + router.clearance + router.half_width
for dx, dy in [(2, 2), (2, 1), (1, 2)]:
assert max(dx, dy) * router.step < need
assert (dx, dy) in router._halo_for(2500)
def test_a_wide_rip_up_route_counts_what_its_extra_width_crosses():
router, pwr_net = _wide_router()
conns = router._conns = router._build_connections()
pwr = next(c for c in conns if c.net_no == pwr_net)
other = next(c for c in conns if c.net_no != pwr_net)
# a default-width trace two cells from the wide route's path
x, y = 20, 5
router._commit(other, _line((x - 3, y + 2), (x + 3, y + 2), 0))
path = _line((x - 3, y), (x + 3, y), 0)
spread = router._spread_for(2500)
assert other.index not in router._crossed_owners(path, pwr.net_no, conns)
assert other.index in router._crossed_owners(path, pwr.net_no, conns, spread)
def test_a_pad_cell_check_uses_the_rotated_outline():
board = build_board(parse_dsn(_socket_dsn(60, "y")))
router = GridRouter(board, trace_width=3000, clearance=2500, resolution=2)
oval = next(p for p in board.get_pins() if p.component_ref == "P3" and p.name == "2")
box = oval.shape.bounding_box()
margin = router.clearance + router.half_width
exact = set(router._pad_cells(oval.shape, box, margin))
boxed = set(router._cells_in_box(box, margin))
assert exact < boxed
for cell in boxed - exact:
c = router._cell_center(cell)
square = IntBox(c.x - margin, c.y - margin, c.x + margin, c.y + margin)
assert oval.shape.intersection(square).dimension() != 2
def test_a_via_by_a_chamfered_corner_is_judged_round():
"""The grid keeps a via's centre its radius plus the edge clearance from
the outline. The exact check used the via's square, whose corner reaches
past a 45-degree chamfer where the round via does not."""
from rpmroute.board.outline import BoardOutline
from rpmroute.geometry import IntBox, IntPoint
from rpmroute.route.exact_router import _inside_outline
# a 10 mm square with its lower-left corner cut at 45 degrees
outline = BoardOutline([IntPoint(*p) for p in
[(30, 0), (100, 0), (100, 100), (0, 100), (0, 30)]])
half, edge = 4, 1
via = IntPoint(19, 20) # its centre 6.4 from the chamfer x + y = 30
square = IntBox(via.x - half, via.y - half, via.x + half, via.y + half)
assert not outline.box_clear(square, edge) # the square's corner: 0.7 away
assert _inside_outline(outline, [], [via], half + edge, edge)
# 4.2 from the chamfer: the round via itself is too close
assert not _inside_outline(outline, [], [IntPoint(18, 18)], half + edge, edge)
-65
View File
@@ -1,65 +0,0 @@
"""--negotiate: PathFinder-style rounds on the empty board before routing."""
from __future__ import annotations
from pathlib import Path
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
def _router(name, negotiate):
dsn = parse_dsn((FIXTURES / name).read_text())
s = dsn.resolution.value
return GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
negotiate=negotiate,
)
def test_negotiation_leaves_the_board_empty_and_the_ends_as_they_were():
router = _router("true_density.dsn", 3)
conns = router._conns = router._build_connections()
ends = [(c.a_end, c.b_end) for c in conns]
router._negotiate(list(conns), conns)
assert router._history # a dense board has contested cells
assert not router._cell_owner and not router._halo and not router._via_claims
assert not any(c.routed for c in conns)
assert [(c.a_end, c.b_end) for c in conns] == ends
assert router._present is None
def test_sharing_is_priced_only_for_other_nets():
router = _router("true_density.dsn", 1)
node = (3, 4, 0)
router._history[node] = 2.0
router._present, router._present_cost = {node: {7: 1, 9: 2}}, 0.5
assert router._congestion(node, 7) == pytest.approx(2.5) # one other net
assert router._congestion(node, 5) == pytest.approx(3.0) # two other nets
router._present = None
assert router._congestion(node, 5) == pytest.approx(2.0) # history only, after
@pytest.mark.parametrize("name", ["ripup_needed.dsn", "true_density.dsn", "kicad_routable.dsn"])
def test_negotiated_routing_keeps_the_occupancy_honest(name):
"""Only routed connections hold cells afterwards, as without negotiation."""
router = _router(name, 3)
router.route()
conns = router._conns
assert all(conns[i].routed for i in router._cell_owner.values())
assert all(conns[i].routed for claims in router._halo.values() for i in claims)
def test_option_reaches_the_router_and_is_off_by_default():
text = (FIXTURES / "kicad_routable.dsn").read_text()
plain, _, _ = route_dsn_board(parse_dsn(text))
again, _, _ = route_dsn_board(parse_dsn(text), negotiate=0)
assert plain.unrouted == again.unrouted
+2 -2
View File
@@ -2,8 +2,8 @@
from __future__ import annotations
from rpmroute.dsn import parse_dsn
from rpmroute.route.pipeline import build_exact_routing_result
from freeroute.dsn import parse_dsn
from freeroute.route.pipeline import build_exact_routing_result
_BOARD = """(pcb widths (parser) (resolution um 10) (unit um)
(structure
+2 -2
View File
@@ -4,8 +4,8 @@ from __future__ import annotations
from pathlib import Path
from rpmroute.cli import main
from rpmroute.route.orders import (
from freeroute.cli import main
from freeroute.route.orders import (
best_of_orders,
candidate_seeds,
promote_failures,
+13 -16
View File
@@ -6,9 +6,9 @@ import math
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route.pipeline import route_dsn_board_exact
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.route.pipeline import route_dsn_board_exact
# 20 x 20 mm board whose corners are rounded with a 3 mm radius, as polylines
_R = 3000.0
@@ -51,26 +51,23 @@ def test_routes_keep_edge_clearance_at_a_rounded_corner():
assert outline.edge_distance(p) >= half + 500 * scale - 1
@pytest.mark.parametrize("resolution", [1, 4])
def test_every_pin_of_a_half_millimetre_pitch_row_escapes(resolution):
@pytest.mark.parametrize(("resolution", "escape"), [(1, 2), (4, 5)])
def test_every_pin_of_a_half_millimetre_pitch_row_escapes(resolution, escape):
# Five 0.3 mm pads at 0.5 mm pitch, each wired to its own pad 8 mm away.
# Between two neighbours a trace's centre has a legal band only 0.15 mm
# wide. At resolution 4 the 0.1 mm columns cannot miss it. At resolution
# 1 the 0.4 mm grid misses most bands, but a stub leaves its pin straight
# along the band and jogs to the column only past the pads, so every pin
# gets out there too, as the JAR manages (only 2 did before).
# wide. At resolution 1 the 0.4 mm grid misses most bands; at 4 its
# 0.1 mm columns cannot, and every pin gets out, as the JAR manages.
places = " ".join(f"(place R{i} {6000 + 500 * i} -6000 front 0)" for i in range(5))
places += " " + " ".join(f"(place F{i} {6000 + 500 * i} -14000 front 0)" for i in range(5))
nets = " ".join(f"(net N{i} (pins R{i}-1 F{i}-1))" for i in range(5))
result, _, _ = route_dsn_board_exact(
parse_dsn(_dsn(f"(component P {places})", nets)), resolution=resolution
)
assert len(result.routed_net_numbers) == 5
assert result.drc_clean
assert len(result.routed_net_numbers) == escape
def test_resolution_one_has_no_halo_so_the_grid_is_unchanged():
from rpmroute.route.grid_router import GridRouter
from freeroute.route.grid_router import GridRouter
board = build_board(parse_dsn(_dsn("", "")))
assert GridRouter(board, trace_width=2500, clearance=1500)._halo_offsets == []
@@ -101,7 +98,7 @@ def test_heuristic_weight_bounds_route_length():
# --- copper zones (DSN planes) -----------------------------------------------
# rc4 power stage: pads inside "keep router off" pours connect through the pour,
# and rpmroute, not knowing zones, dropped every such connection.
# and freeroute, not knowing zones, dropped every such connection.
_ZONE = "(plane N (polygon F.Cu 0 4000 -4000 10000 -4000 10000 -10000 4000 -10000 4000 -4000))"
_NO_TRACKS = "(wire_keepout \"pour\" (polygon F.Cu 0 4000 -4000 10000 -4000 10000 -10000 4000 -10000))"
@@ -121,7 +118,7 @@ def test_planes_are_read_and_are_not_obstacles():
def test_pads_in_one_zone_need_no_route_between_them():
from rpmroute.route.grid_router import _connected_groups
from freeroute.route.grid_router import _connected_groups
board = build_board(_zone_board())
pins = sorted(board.get_pins(), key=lambda p: p.component_ref)
@@ -155,7 +152,7 @@ def test_a_pour_other_nets_can_cross_is_not_trusted_to_connect():
def test_cli_names_the_connections_it_could_not_route(tmp_path, capsys):
# a keepout wall across the board on both layers: A and B cannot be joined
from rpmroute.cli import main
from freeroute.cli import main
wall = " ".join(
f"(keepout \"wall\" (polygon {layer} 0 9000 1000 11000 1000 11000 -21000 9000 -21000))"
@@ -218,7 +215,7 @@ def test_a_pad_outside_the_plane_routes_to_it():
def test_a_through_hole_pad_inside_a_plane_needs_no_route():
from rpmroute.route.grid_router import _connected_groups
from freeroute.route.grid_router import _connected_groups
board = build_board(parse_dsn(_four_layer_dsn()))
plane = [z for z in board.get_conduction_areas() if z.name == "GND"]
+5 -5
View File
@@ -6,10 +6,10 @@ from pathlib import Path
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.route.grid_router import GridRouter
from freeroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
@@ -31,7 +31,7 @@ def test_occupancy_only_holds_routed_connections(name):
router, _ = _routed_router(name)
conns = router._conns
assert all(conns[i].routed for i in router._cell_owner.values())
assert all(conns[i].routed for claims in router._via_claims.values() for i in claims)
assert all(conns[i].routed for i in router._via_owner.values())
assert all(conns[i].routed for claims in router._halo.values() for i in claims)
+6 -6
View File
@@ -23,11 +23,11 @@ from pathlib import Path
import pytest
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.geometry import Polyline, PolylineShape
from rpmroute.route import route, route_dsn_board_rooms
from rpmroute.route.pipeline import _rule_clearance_dsn
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.geometry import Polyline, PolylineShape
from freeroute.route import route, route_dsn_board_rooms
from freeroute.route.pipeline import _rule_clearance_dsn
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
CHANNEL_PACK = FIXTURES / "channel_pack.dsn"
@@ -134,7 +134,7 @@ def test_channel_pack_is_deterministic():
def test_channel_pack_endpoints_stay_on_pads():
dsn = parse_dsn(CHANNEL_PACK.read_text())
board_pins: dict[int, set[tuple[int, int]]] = {}
from rpmroute.board import build_board
from freeroute.board import build_board
for pin in build_board(dsn).get_pins():
for net_no in pin.net_nos:
+6 -6
View File
@@ -13,11 +13,11 @@ import sys
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.geometry import Polyline
from rpmroute.route import route, route_dsn_board_exact, route_dsn_board_rooms
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.geometry import Polyline
from freeroute.route import route, route_dsn_board_exact, route_dsn_board_rooms
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -31,7 +31,7 @@ WIDE_DOOR = FIXTURES / "rooms_wide_door.dsn"
def _clearance(dsn, scale):
from rpmroute.route.pipeline import _rule_clearance_dsn
from freeroute.route.pipeline import _rule_clearance_dsn
return round(_rule_clearance_dsn(dsn) * scale)
+11 -11
View File
@@ -32,12 +32,12 @@ import sys
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.geometry import IntBox, IntPoint, Polyline, PolylineShape
from rpmroute.route import route, route_dsn_board_exact, route_dsn_board_rooms
from rpmroute.route.pipeline import _rule_clearance_dsn
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.geometry import IntBox, IntPoint, Polyline, PolylineShape
from freeroute.route import route, route_dsn_board_exact, route_dsn_board_rooms
from freeroute.route.pipeline import _rule_clearance_dsn
def _emitted_drc_violations(result, clearance):
@@ -265,8 +265,8 @@ def test_shove_is_byte_identical_on_foundation_fixtures(fixture):
def test_project_gate_reduces_to_clamp_without_occupancy():
from rpmroute.board.search_tree import ShapeSearchTree
from rpmroute.route.room_router import _Door, _edge_gate, _project_gate
from freeroute.board.search_tree import ShapeSearchTree
from freeroute.route.room_router import _Door, _edge_gate, _project_gate
door = _Door(other=1, kind="edge", lo=IntPoint(0, 100), hi=IntPoint(200, 100))
tree = ShapeSearchTree()
@@ -277,8 +277,8 @@ def test_project_gate_reduces_to_clamp_without_occupancy():
def test_project_gate_avoids_other_net_copper_on_the_door():
from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from rpmroute.route.room_router import _Door, _project_gate
from freeroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.route.room_router import _Door, _project_gate
door = _Door(other=1, kind="edge", lo=IntPoint(0, 100), hi=IntPoint(200, 100))
tree = ShapeSearchTree()
@@ -293,7 +293,7 @@ def test_project_gate_avoids_other_net_copper_on_the_door():
def test_free_intervals_splits_around_forbidden_band():
from rpmroute.route.room_router import _best_free_point, _free_intervals
from freeroute.route.room_router import _best_free_point, _free_intervals
free = _free_intervals(0, 200, [(87, 113)])
assert free == [(0, 87), (113, 200)]
+8 -8
View File
@@ -16,11 +16,11 @@ import sys
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.route import route, route_dsn_board
from rpmroute.ses.writer import ses_scale
from freeroute.board import build_board
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.route import route, route_dsn_board
from freeroute.ses.writer import ses_scale
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -287,11 +287,11 @@ def test_connectivity_parity_on_congested_board():
if not HAS_ORACLE:
pytest.skip("FreeRouting oracle unavailable")
our_nets = routed_net_set(route(RIPUP.read_text()))
assert our_nets == {"NET_A", "NET_B"} # rpmroute connects both via rip-up
assert our_nets == {"NET_A", "NET_B"} # freeroute connects both via rip-up
oracle_nets = routed_net_set(route_dsn(RIPUP, max_passes=3, timeout=300))
if not oracle_nets:
# the reference JAR does not route this synthetic single-signal-layer
# board (it expects a routing/via layer); rpmroute's rip-up connecting
# board (it expects a routing/via layer); freeroute's rip-up connecting
# both nets is already asserted above and by the fast tests.
pytest.skip("reference JAR routed nothing on the synthetic single-layer board")
assert oracle_nets <= our_nets # rip-up matches the JAR's connectivity
@@ -306,7 +306,7 @@ def test_connectivity_parity_on_crossing_board():
our_nets = routed_net_set(route(CROSSING.read_text()))
oracle_nets = routed_net_set(route_dsn(CROSSING, max_passes=3, timeout=300))
assert oracle_nets, "oracle routed nothing on a routable board"
assert oracle_nets <= our_nets # rpmroute connects every net the JAR does
assert oracle_nets <= our_nets # freeroute connects every net the JAR does
@pytest.mark.oracle
+5 -5
View File
@@ -17,10 +17,10 @@ import sys
import pytest
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import parse
from rpmroute.route import route, route_dsn_board_exact
from rpmroute.route.pipeline import _rule_clearance_dsn
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse
from freeroute.route import route, route_dsn_board_exact
from freeroute.route.pipeline import _rule_clearance_dsn
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -66,7 +66,7 @@ def test_shove_result_is_deterministic():
def test_shoved_trace_endpoints_still_on_pads():
from rpmroute.board import build_board
from freeroute.board import build_board
on, _, _ = route_dsn_board_exact(parse_dsn(SHOVE.read_text()), rip_up=False, shove=True)
board = build_board(parse_dsn(SHOVE.read_text()))
-58
View File
@@ -1,58 +0,0 @@
"""Pins of a 1.27 mm pitch row routed at 1.0 mm (the RN2483 module on the
TTN Enschede mote). A trace centre has to stay within 0.06 mm of a pin's
centreline to pass its neighbours, which no grid column hits, so a route
leaves each pin straight along that line and only jogs to its column once
past the pads. FreeRouting routes this row in full the same way."""
from __future__ import annotations
import pytest
from rpmroute.board import build_board
from rpmroute.board.items import Pin
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntPoint
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import route_dsn_board_exact
def _row(x0: int, pins: int = 6, skew: int = 3000) -> str:
places = " ".join(f"(place R{i} {x0 + 1270 * i} -5000 front 0)" for i in range(pins))
places += " " + " ".join(
f"(place T{i} {x0 + 1270 * i + skew} -15000 front 0)" for i in range(pins)
)
nets = " ".join(f"(net N{i} (pins R{i}-1 T{i}-1))" for i in range(pins))
return f"""(pcb t (parser) (resolution um 10) (unit um)
(structure (layer F.Cu (type signal)) (layer B.Cu (type signal))
(boundary (path pcb 0 0 0 30000 0 30000 -20000 0 -20000 0 0))
(via "Via[0-1]_600:400_um") (rule (width 1000) (clearance 200)))
(placement (component P {places}))
(library (image P (pin pad 1 0 0))
(padstack pad (shape (rect F.Cu -508 -762 508 762)) (attach off))
(padstack "Via[0-1]_600:400_um" (shape (circle F.Cu 600)) (shape (circle B.Cu 600))
(attach off)))
(network {nets}))"""
@pytest.mark.parametrize("x0", [5000, 5150, 5300])
def test_every_pin_of_a_row_leaves_straight_and_routes(x0):
# three offsets of the row against the grid; before, 2 or 3 of 6 routed
result, _, _ = route_dsn_board_exact(parse_dsn(_row(x0)), resolution=2)
assert len(result.routed_net_numbers) == 6
assert result.drc_clean
def test_a_walled_in_pin_may_escape_to_the_column_either_side():
# two pins side by side leaving the same way can then jog apart
board = build_board(parse_dsn(_row(5000)))
router = GridRouter(board, trace_width=10000, clearance=2000, orthogonal=True, resolution=2)
router._conns = router._build_connections()
pin = next(
p for p in board.get_items()
if isinstance(p, Pin) and p.location == IntPoint(50000 + 2 * 12700, -50000)
)
net = pin.net_nos[0]
cx, cy = router._cell_of(pin.location)
nodes = router._escape_nodes(pin, net, router._conns, [0], (cx, cy))
columns = {x for x, y, _ in nodes if y != cy}
assert {cx - 1, cx, cx + 1} <= columns
-170
View File
@@ -1,170 +0,0 @@
"""Multi-pin nets: spanning-tree pairs, and connections that end on copper
their net has already routed (a T into the tree)."""
from __future__ import annotations
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route import exact_router
from rpmroute.route.grid_router import GridRouter, RouteResult
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
# P1 and P2 are nearest each other, so the tree pairs them first; P3 sits
# under the middle of that leg, 50 mm below it and 90 mm from either pin.
TEE = """(pcb "tee.dsn"
(parser (string_quote ") (space_in_quoted_tokens on) (host_cad "t") (host_version "1"))
(resolution um 10)
(unit um)
(structure
(layer F.Cu (type signal) (property (index 0)))
(boundary (path pcb 0 0 0 200000 0 200000 -100000 0 -100000 0 0))
(rule (width 2000) (clearance 2000))
)
(library
(padstack Rect_Pad (shape (rect F.Cu -1000 -1000 1000 1000)) (attach off))
(image PAD (pin Rect_Pad 1 0 0))
)
(placement
(component PAD
(place P1 60000 -20000 front 0)
(place P2 140000 -20000 front 0)
(place P3 100000 -70000 front 0)
)
)
(network
(net N (pins P1-1 P2-1 P3-1))
(class default (rule (width 2000) (clearance 2000)))
)
(wiring)
)
"""
def _router(tree_nets=True, text=TEE):
dsn = parse_dsn(text)
s = dsn.resolution.value
return GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
orthogonal=True,
tree_nets=tree_nets,
)
def test_pairs_follow_a_spanning_tree_not_the_pin_order():
router = _router()
conns = router._build_connections()
pairs = [(c.a.component_ref, c.b.component_ref) for c in conns]
assert pairs == [("P1", "P2"), ("P1", "P3")]
chain = _router(tree_nets=False)._build_connections()
assert [(c.a.component_ref, c.b.component_ref) for c in chain] == [("P1", "P2"), ("P2", "P3")]
def test_the_third_pin_tees_into_the_first_leg():
router = _router()
result = router.route()
first, second = router._conns
assert result.unrouted == 0
# the second connection starts on the first one's copper, mid-leg
start = second.path[0]
assert start in first.copper and second.a_end is None
assert second.anchors == {first.index}
assert router._dependents[first.index] == {second.index}
assert abs(router._cell_center(start[:2]).x - 1_000_000) <= router.step
# and so its copper is the 50 mm drop, not 90 mm back to a pin
assert len(second.path) < len(router._conns[0].path)
def test_without_trees_each_connection_ends_on_a_pin():
router = _router(tree_nets=False)
router.route()
assert all(c.anchors == frozenset() for c in router._conns)
assert all(c.a_end is not None and c.b_end is not None for c in router._conns)
def test_ripping_an_anchor_takes_what_hangs_on_it():
router = _router()
router.route()
first, second = router._conns
victims = router._with_dependents([first], router._conns)
assert victims == [first, second] # anchors first, as committed
for victim in victims:
router._rip(victim)
assert not first.routed and not second.routed
assert not router._dependents.get(first.index)
assert not router._cell_owner
def test_the_snapshot_lists_anchors_before_what_hangs_on_them():
router = _router()
result = router.route()
assert result.connection_anchors == [(), (0,)]
def test_the_exact_engine_drops_a_tee_whose_anchor_it_rejects(monkeypatch):
"""A connection teed onto copper the exact check refuses would dangle."""
dsn = parse_dsn(TEE)
board = build_board(dsn)
real = exact_router.route_board
def grid_then_spoil(*args, **kwargs):
result: RouteResult = real(*args, **kwargs)
assert result.connection_anchors == [(), (0,)]
# move the first leg off the board edge so the exact check rejects it
net, wires, vias = result.connections[0]
result.connections[0] = (net, [(layer, [type(p)(p.x, p.y + 2_000_000) for p in pts])
for layer, pts in wires], vias)
return result
monkeypatch.setattr(exact_router, "route_board", grid_then_spoil)
s = dsn.resolution.value
exact = exact_router.route_board_exact(
board,
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
)
assert len(exact.result.failed) == 2 # the leg and the T hanging on it
assert not exact.result.wires
@pytest.mark.parametrize("tree_nets", [True, False])
def test_occupancy_stays_honest(tree_nets):
router = _router(tree_nets)
router.route()
conns = router._conns
assert all(conns[i].routed for i in router._cell_owner.values())
for anchor, hanging in router._dependents.items():
for i in hanging:
assert conns[i].routed and conns[anchor].routed
# P1-P2 along the top, P3 far off to the lower right, P4 just under the
# middle of the P1-P2 leg.
CHAIN_TEE = TEE.replace(
""" (place P3 100000 -70000 front 0)
""",
""" (place P3 190000 -90000 front 0)
(place P4 100000 -40000 front 0)
""",
).replace("(pins P1-1 P2-1 P3-1)", "(pins P1-1 P2-1 P3-1 P4-1)")
def test_a_tee_depends_on_every_connection_back_to_its_group():
"""Joined as P1-P2, P2-P3, P3-P4, P4's connection tees onto P1-P2 copper,
which reaches P3's group only through P2-P3. Ripping P2-P3 must take the T
too, or it would be counted routed while cut off from P3."""
router = _router(text=CHAIN_TEE)
conns = router._conns = router._build_connections()
groups = {c.a.component_ref: c.a_group for c in conns}
groups.update({c.b.component_ref: c.b_group for c in conns})
for conn, (a, b) in zip(conns, (("P1", "P2"), ("P2", "P3"), ("P3", "P4")), strict=True):
conn.a_group, conn.b_group = groups[a], groups[b]
for conn in conns:
assert router._try_route(conn, conns)
first, second, third = conns
assert third.path[0] in first.copper # the T lands on the far leg
assert third.anchors == {first.index, second.index}
assert router._with_dependents([second], conns) == [second, third]
+6 -6
View File
@@ -5,8 +5,8 @@ from __future__ import annotations
import itertools
import math
from rpmroute.dsn import parse_dsn
from rpmroute.route.pipeline import route_dsn_board_exact
from freeroute.dsn import parse_dsn
from freeroute.route.pipeline import route_dsn_board_exact
# four GND pads 0.5 mm apart over a GND plane: each drops a via to the plane
_DSN = """(pcb holes (parser) (resolution um 10) (unit um)
@@ -57,9 +57,9 @@ def test_connections_sharing_a_plane_via_write_it_once():
def _router(dsn_text, via_drill_um=300):
from rpmroute.board import build_board
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
from freeroute.board import build_board
from freeroute.route.grid_router import GridRouter
from freeroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
dsn = parse_dsn(dsn_text)
s = dsn.resolution.value
@@ -90,7 +90,7 @@ def test_no_via_goes_near_a_through_hole_pads_hole_even_of_its_own_net():
def test_a_via_in_a_pad_keeps_hole_spacing_from_a_fixed_via():
from rpmroute.geometry import IntPoint
from freeroute.geometry import IntPoint
text = _THT.replace("(network (net SIG (pins J1-1))))",
"(network (net SIG (pins J1-1)))\n"
-128
View File
@@ -1,128 +0,0 @@
"""Window re-route: a finer grid around a stuck connection, kept only when
it leaves fewer connections unrouted."""
from __future__ import annotations
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntBox
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board_exact
def _slot(gap: int = 640, far: bool = False) -> str:
"""A wall across the board with a slot in it. A trace fits the slot
only along a narrow band of heights that the board's 1x grid has no row
in and a 4x grid does. ``far`` adds a second net nowhere near the wall."""
yc = -5000
lo, hi = yc - gap // 2, yc + gap // 2
extra_place = "(place Q1 2000 -1000 front 0) (place Q2 6000 -1000 front 0)" if far else ""
extra_net = "(net M (pins Q1-1 Q2-1))" if far else ""
return f"""(pcb "slot.dsn"
(parser (string_quote ") (space_in_quoted_tokens on) (host_cad "t") (host_version "1"))
(resolution um 10)
(unit um)
(structure
(layer F.Cu (type signal) (property (index 0)))
(boundary (path pcb 0 0 0 20000 0 20000 -10000 0 -10000 0 0))
(keepout "" (rect F.Cu 9000 -10000 11000 {lo}))
(keepout "" (rect F.Cu 9000 {hi} 11000 0))
(rule (width 200) (clearance 200))
)
(library
(padstack Rect_Pad (shape (rect F.Cu -100 -100 100 100)) (attach off))
(image PAD (pin Rect_Pad 1 0 0))
)
(placement
(component PAD
(place P1 3000 {yc} front 0)
(place P2 17000 {yc} front 0)
{extra_place}
)
)
(network
(net N (pins P1-1 P2-1))
{extra_net}
(class default (rule (width 200) (clearance 200)))
)
(wiring)
)
"""
def _route(text: str, rounds: int, **window):
exact, _scale, _layers = route_dsn_board_exact(
parse_dsn(text), resolution=1, window_reroute=rounds, window_resolution=4, **window,
)
return exact.result
def test_the_board_grid_misses_the_slot_and_a_finer_window_finds_it():
plain = _route(_slot(), 0)
assert len(plain.failed) == 1
windowed = _route(_slot(), 1)
assert windowed.failed == []
assert windowed.wires # and the copper it found is in the result
def test_a_window_that_cannot_help_leaves_the_board_as_it_was():
plain = _route(_slot(gap=500, far=True), 0) # too narrow for any grid
windowed = _route(_slot(gap=500, far=True), 2)
assert len(windowed.failed) == len(plain.failed) == 1
assert windowed.wires == plain.wires
assert windowed.vias == plain.vias
def test_copper_outside_the_window_is_kept_as_it_was():
plain = _route(_slot(far=True), 0)
windowed = _route(_slot(far=True), 1)
assert windowed.failed == []
far_net = 2 # M, the second net in the DSN
assert windowed.wires[far_net] == plain.wires[far_net]
def test_a_router_limited_to_some_nets_and_a_box_builds_only_those():
dsn = parse_dsn(_slot(far=True))
s = dsn.resolution.value
board = build_board(dsn)
whole = GridRouter(board, trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), orthogonal=True)
part = GridRouter(board, trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), orthogonal=True,
only_nets=frozenset({2}), bounds=IntBox(0, -20000, 80000, 0))
assert {c.net_no for c in whole._build_connections()} == {1, 2}
assert {c.net_no for c in part._build_connections()} == {2}
assert part.cols * part.rows < whole.cols * whole.rows
def test_a_spent_budget_starts_no_window():
assert len(_route(_slot(), 1, window_budget=0.0).failed) == 1
assert _route(_slot(), 1, window_budget=1000.0).failed == []
def test_window_board_keeps_far_items_of_the_rerouted_nets_only():
from rpmroute.route.window import _item_box, _window_board
board = build_board(parse_dsn(_slot(far=True)))
items = [(item, _item_box(item)) for item in board.get_items()]
view = IntBox(80000, -60000, 120000, -40000) # around the slot, far from Q1/Q2
sub = _window_board(board, items, view, {1}, {}, set(), {}, 100, 300, 300, [0], "via")
refs = {p.component_ref for p in sub.get_pins()}
assert {"P1", "P2"} <= refs # net N's pins, though outside the view
assert not refs & {"Q1", "Q2"} # net M's, far away, left out
def test_a_connection_ending_outside_the_window_gets_no_copper():
"""Its far end has no grid cells; a stub out to it would cross items the
window board never saw."""
from rpmroute.route.exact_router import route_board_exact
dsn = parse_dsn(_slot(far=True))
s = dsn.resolution.value
window = IntBox(70000, -70000, 130000, -30000) # the slot only; net M's pins are far off
result = route_board_exact(
build_board(dsn), trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), only_nets=frozenset({2}), bounds=window,
).result
assert [f[0] for f in result.failed] == [2]
assert not result.wires.get(2) and not result.vias.get(2)
+1 -1
View File
@@ -2,7 +2,7 @@
from __future__ import annotations
from rpmroute.ses.indent import Identifier, IndentWriter
from freeroute.ses.indent import Identifier, IndentWriter
def test_nested_scopes_indent_by_two_spaces():
+7 -7
View File
@@ -1,7 +1,7 @@
"""End-to-end tests for the SES writer.
Where possible these re-parse the emitted SES with the project's own tokenizer /
S-expression parser (:mod:`rpmroute.dsn.sexp`) and assert structural
S-expression parser (:mod:`freeroute.dsn.sexp`) and assert structural
invariants, mirroring what FreeRouting's ``SesReader`` and ``kicad-cli pcb
import specctra-ses`` walk: ``session > routes > network_out > net >
wire(path)/via``.
@@ -13,9 +13,9 @@ from pathlib import Path
import pytest
from rpmroute.dsn import parse_dsn
from rpmroute.dsn.sexp import SExp, parse
from rpmroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses
from freeroute.dsn import parse_dsn
from freeroute.dsn.sexp import SExp, parse
from freeroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses
FIXTURES = Path(__file__).parent.parent / "dsn" / "fixtures"
@@ -142,7 +142,7 @@ def test_round_trip_from_empty_board_fixture():
# --- SES coordinate units ---------------------------------------------------
# FreeRouting's SesWriter writes coordinates in resolution units, and KiCad's
# importer and mckicad's ses_apply read them that way. On 2026-09-26 rpmroute
# importer and mckicad's ses_apply read them that way. On 2026-09-26 freeroute
# was found writing DSN units instead, so every routed board came back 10x small.
@@ -155,8 +155,8 @@ def test_round_trip_from_empty_board_fixture():
],
)
def test_ses_scale(resolution, unit, expected):
from rpmroute.dsn import parse_dsn
from rpmroute.ses.writer import ses_scale
from freeroute.dsn import parse_dsn
from freeroute.ses.writer import ses_scale
dsn = parse_dsn(f"(pcb t (parser) {resolution} {unit} (structure) (placement) (library) (network))")
assert ses_scale(dsn) == pytest.approx(expected)
+8 -22
View File
@@ -1,4 +1,4 @@
"""Tests for the rpmroute CLI (Specctra DSN in, SES out).
"""Tests for the freeroute CLI (Specctra DSN in, SES out).
Covers the engine selection contract: every engine must route a fixture from the
command line, and every option the selected engine does not implement must fail
@@ -11,7 +11,7 @@ from pathlib import Path
import pytest
from rpmroute.cli import ENGINE_OPTIONS, main
from freeroute.cli import ENGINE_OPTIONS, main
FIXTURES = Path(__file__).parent / "dsn" / "fixtures"
FIXTURE = FIXTURES / "simple_2net.dsn"
@@ -71,25 +71,13 @@ def test_cli_every_engine_routes_a_fixture(engine, tmp_path):
assert "(wire" in text
def test_cli_default_engine_is_exact(tmp_path):
"""The default is the engine that checks its copper: grid output can short
and say nothing (a user routing with no flags shipped 15 crossings)."""
def test_cli_default_engine_is_grid(tmp_path):
"""The default must stay grid — the drop-in JAR replacement behaviour."""
default = tmp_path / "default.ses"
exact = tmp_path / "exact.ses"
grid = tmp_path / "grid.ses"
assert main([str(FIXTURE), "-do", str(default)]) == 0
assert main([str(FIXTURE), "--engine", "exact", "-do", str(exact)]) == 0
assert default.read_text() == exact.read_text()
@pytest.mark.parametrize("engine", ["grid", "room"])
def test_unchecked_engines_say_so(tmp_path, capsys, engine):
assert main([str(FIXTURE), "--engine", engine, "-do", str(tmp_path / "out.ses")]) == 0
assert "does not check its copper" in capsys.readouterr().err
def test_the_exact_engine_does_not_warn(tmp_path, capsys):
assert main([str(FIXTURE), "-do", str(tmp_path / "out.ses")]) == 0
assert "WARNING" not in capsys.readouterr().err
assert main([str(FIXTURE), "--engine", "grid", "-do", str(grid)]) == 0
assert default.read_text() == grid.read_text()
def test_cli_room_pack_routes(tmp_path):
@@ -170,10 +158,8 @@ def test_cli_supported_combinations_are_accepted(tmp_path):
"orders": ["--orders", "2"],
"promote": ["--promote-failures", "2"],
"access": ["--access-cost", "5"],
"negotiate": ["--negotiate", "2"],
"rollback": ["--no-rollback"],
"tree": ["--no-tree"],
"window": ["--window-reroute", "1"],
"fanout": ["--fanout"],
}
for engine, options in ENGINE_OPTIONS.items():
for option in options:
Generated
+21 -21
View File
@@ -126,6 +126,27 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/8a/0e/97c33bf5009bdbac74fd2beace167cab3f978feb69cc36f1ef79360d6c4e/exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598", size = 16740, upload-time = "2025-11-21T23:01:53.443Z" },
]
[[package]]
name = "freeroute"
version = "2026.7.14"
source = { editable = "." }
[package.dev-dependencies]
dev = [
{ name = "pytest" },
{ name = "pytest-cov" },
{ name = "ruff" },
]
[package.metadata]
[package.metadata.requires-dev]
dev = [
{ name = "pytest", specifier = ">=7.0.0" },
{ name = "pytest-cov", specifier = ">=4.0.0" },
{ name = "ruff", specifier = ">=0.1.0" },
]
[[package]]
name = "iniconfig"
version = "2.3.0"
@@ -194,27 +215,6 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/9d/7a/d968e294073affff457b041c2be9868a40c1c71f4a35fcc1e45e5493067b/pytest_cov-7.1.0-py3-none-any.whl", hash = "sha256:a0461110b7865f9a271aa1b51e516c9a95de9d696734a2f71e3e78f46e1d4678", size = 22876, upload-time = "2026-03-21T20:11:14.438Z" },
]
[[package]]
name = "rpmroute"
version = "2026.10.7"
source = { editable = "." }
[package.dev-dependencies]
dev = [
{ name = "pytest" },
{ name = "pytest-cov" },
{ name = "ruff" },
]
[package.metadata]
[package.metadata.requires-dev]
dev = [
{ name = "pytest", specifier = ">=7.0.0" },
{ name = "pytest-cov", specifier = ">=4.0.0" },
{ name = "ruff", specifier = ">=0.1.0" },
]
[[package]]
name = "ruff"
version = "0.15.21"