yapnr documentation¶
yapnr (“yet another place and route”) places components and routes copper for KiCad printed circuit boards. It uses a mechanical, Monte-Carlo-driven search:
hierarchical block synthesis: blocks become macros, with a library of trials per template;
power-first placement: power tiers, trunks and hot loops are derived from the design;
native KiCad routing and design-rule checks (DRC) in the loop, with KiCad’s own DRC as the judge;
electrical contracts (current, differential pairs, plane access) declared next to the design.
The engine grew inside the Splanc repository, where it laid out the Splanc Mini board. It is being migrated here in reviewable pull requests; until that is done, this repository holds the project scaffolding (build, CI, documentation) and the plan.
Status¶
Alpha. The engine’s committed history (PR1) and its newer, never committed state (PR2) are
imported from Splanc at their original paths under hardware/ (see the
history import manifest); the package restructuring follows. The
command line currently offers yapnr --version and a yapnr doctor stub; the live viewer
(PR4) runs with bazel run //:viewer. Progress is tracked in
WORKLOG.md and in GitHub issues.
Start here¶
Container images: run yapnr with Docker and nothing else (KiCad included).
The live viewer: watch experiments in a browser; its configuration, optional services and the cost and security of the (off by default) Ask agent.
The atopile toolchain: build atopile projects offline, without Nix.
The part cache: where part data lives instead of the repository.
Fab bundles and staged orders: check a routed board under OSH Park’s, JLCPCB’s or PCBWay’s rules, build the files to upload and an order card, and open the vendor’s page. yapnr never uploads, orders or pays.
Releases and versioning: version numbers, image tags, what a release publishes.
RF fab-model test coupons: coupon boards that measure the fab’s stackup (εr, loss, heights, copper, etch, mask), and the extraction that turns VNA data into a fitted stackup with uncertainties.
Order 0: the OSH Park 4-layer RF demo and coupon boards, their pre-registered predictions and the measurement procedure.
Cloud and HPC experiments:
yapnr expcampaigns on a local pool, Google Cloud Batch (Spot VMs) or a Slurm allocation, with cost guards; the owner’s bootstrap runbook.Palace models: one solver-neutral description of layered RF structures, its adapters (generated lines, the radar60 patch and feeds, KiCad board regions), the Gmsh mesher and the Palace configurations, checked against Palace’s own schema.
Regression ladder: eight boards of rising complexity, up to a TLC555 + CD4017B LED chaser, with an animation of each board’s place and route.
Constraints and hierarchy: a line of LEDs, parts held on the board edge and a board built from reused blocks, each animated from the engine’s own record.
How plane partition works: how yapnr divides a shared plane layer among several supply rails, stage by stage with stills and an animation of a real board, the checks it reports, its limits, and where the method sits in the published literature.
Architecture: the planned layout of the package, the test tiers and the pipeline.
Migration plan: how the engine moves out of Splanc, PR by PR.
CI lanes and caches: ordinary RF smoke, nightly solver checks and cache policy.
Decisions: the owner’s decisions and the pinned tool versions.
History import manifest: what PR1 and PR2 imported from Splanc, and how it was rewritten and checked.
About the name: “yet another place and route”, and the circuit tree.
Foundations and references: the papers and open-source projects behind the place-and-route loop (DREAMPlace, freerouting, tscircuit, PathFinder and more), and what yapnr takes from each.
For contributors and agents:
DEVELOPERS.md: setup, everyday commands, Bazel and KiCad notes.
CONTRIBUTING.md: contribution policy, commit style, license terms.
AGENTS.md: the rules automated agents follow in this repository.
THIRD_PARTY.md: third-party material and its licenses.
License¶
yapnr is free software under the GNU Affero General Public License, version 3 or (at your option)
any later version (AGPL-3.0-or-later). See LICENSE.