r2g —— 从 RTL 到签核版图，再到可训练的数据集
r2g 是一个开源 EDA 自主 agent：给它一批 Verilog，它在后台跑完综合、布局布线、DRC/LVS 签核；
遇到失败自己读日志、诊断、选修法、重跑、复核；最后把签核通过的设计转成机器学习数据集
（GNN 图数据集 或 CNN 图像数据集），逐项独立校验后交给你。模型由你选择：DeepSeek、通义千问、
Kimi、智谱 GLM、豆包、OpenAI、Gemini、Claude 或本地 Ollama，配置即用。
一键安装
需要一台 x86_64 Linux 机器（Ubuntu 22.04 及以上、Debian 12 及以上等 glibc ≥ 2.35 的发行版；安装过程不需要 root 权限），系统预先有 Git、curl、CA 证书及带 venv/ensurepip 的 Python 3.10+。三平台安装和小设计验收建议至少准备 80 GB 可用空间，其中包含默认运行磁盘保护要求的 50 GB 余量。下载需要访问 GitHub、Conda 和 Python 软件源；耗时取决于网络和磁盘速度。
git clone https://github.com/ShenShan123/r2g-skills.git
cd r2g-skills
bash install.sh
install.sh 会依次：检查机器 → 安装 EDA 工具链（下载生成所有 r2g 数据集所用的同一套 OpenROAD、Yosys、
KLayout 预编译包并校验 sha256，固定版本的 OpenROAD-flow-scripts，以及图数据集用的 PyTorch 环境；
已安装的依赖会被识别并跳过；SKY130/GF180 PDK 固定到实验使用的包版本并核对包哈希）→ 分别严格验证 nangate45、sky130hd、gf180 平台可用 → 安装 agent →
把 r2g 命令放进 ~/.local/bin → 让你选择模型并填写 API 密钥（只保存在本机）→ 可选地跑一次自检
（在每个所选平台上运行内置 counter8，从 RTL 到图数据集）。安装器的成功退出不代表完整语料全部通过；是否执行了物理自检会单独打印。
SystemVerilog 修复使用独立的实验版 Yosys/Slang（OSS CAD Suite 2025-03-29），安装器会自动下载并校验归档和二进制哈希，保存其路径；它不会替换布局布线流程使用的 Yosys。
常用参数：--yes（不逐项确认）、--prefix DIR（大文件放哪里）、--platforms nangate45（只安装并验证指定平台，多个平台用逗号分隔）、--skip-toolchain（工具链已就绪）、
--provider deepseek --key-env DEEPSEEK_API_KEY（不交互地配置模型）。无模型密钥的完整流程验收可以使用 bash install.sh --yes --prefix /your/install/path --no-config --selftest。完整说明：bash install.sh --help。
使用
任务在装了 r2g 的那台机器上跑，浏览器只是看和操作的窗口。 r2g 只能装在 Linux 上（工具链是 Linux
预编译包），所以 Windows / Mac 用户把它装在 Linux 服务器上，自己电脑只开浏览器。
| 装在哪里 | 任务在哪里跑 | 怎么打开网页 |
|---|
| 自己的 Linux 电脑 | 本机 | r2g ui，浏览器打开 http://127.0.0.1:8770 |
| 服务器（推荐，算力大） | 服务器 | 服务器上 r2g ui 常驻，自己电脑转发端口后打开（见下） |
在服务器上使用
-
服务器上启动服务，并让它一直开着（放进 tmux，或者后台运行）：
nohup r2g ui > ~/r2g_ui.log 2>&1 & # 默认端口 8770；换端口：r2g ui --port 9000
-
在自己电脑上把服务器的端口转发到本机，任选一种：
-
VS Code 远程连着服务器：底部「端口 / PORTS」面板里转发 8770，点地球图标打开。最省事。
-
SSH 隧道（Windows PowerShell、Mac、Linux 都一样）：
ssh -N -L 8888:127.0.0.1:8770 用户名@服务器地址
输入密码后窗口不动是正常的，别关；然后浏览器打开 http://127.0.0.1:8888。
如果报 bind [127.0.0.1]:8888: Permission denied，说明本机这个端口被占用或被系统保留，
把 8888 换成别的数字（如 7070）再试；Windows 上可用
netsh interface ipv4 show excludedportrange protocol=tcp 查看保留端口。
几点说明：
- 服务只在服务器本机（127.0.0.1）上监听，别人不能直接访问，必须经过 SSH 或 VS Code 转发。
- 关掉浏览器或断开 SSH 不影响任务；服务重启后，没跑完的设计会自动接着跑。
- 每个用户的任务、设置、密钥和修复经验库都在自己的
~/.r2g/ 下，互不影响。
- 同时运行几个设计、每个用几个核，在「设置 → 算力」里改；网页、命令行、对话共用这个上限。
三个页面
- 开始：五步——选设计（上传一个设计的文件夹；或「批量」：一个文件夹里每个子文件夹一个设计，可上传也可直接填服务器上的路径）
→ 选平台（Nangate45 / SKY130 / GF180）→ 选数据集类型（图 / 图像）→ 流程参数（默认采用对应平台的经验参数，也可自定义时钟、利用率、die 等）
→ 开始。不需要配置模型。
- 任务：每个设计的进度条（综合 → 布局布线 → 签核 → 修复 → 数据集 → 校验）、失败原因、自动修复记录、
版图与日志、数据集下载；批量任务按状态筛选、按失败原因归类，运行中也能下载已完成的部分。
- 对话：用一句话说要求，例如“在 GitHub 上找个小的 UART 设计跑一遍”“/data/rtl 下的设计都跑，时钟用 2 ns”
“这个任务失败的设计是什么原因”。需要先在「设置」里配置模型（DeepSeek、通义千问、Kimi、GLM、OpenAI、
Claude、Gemini 或本地模型）。
命令行与其他客户端：
r2g config --provider qwen --set-key # 更换模型
r2g check-model # 测试模型连通与工具调用
r2g run --example counter8 # 不经过对话，直接跑
r2g status # 查看任务
r2g chat # 终端里对话
r2g mcp # 作为 MCP 服务器，接入 Claude Code、Cursor 等客户端
两种数据集
| 图数据集（graph） | 图像数据集（image） |
|---|
| 形式 | PyTorch Geometric：五种视图（b–f）+ 网表图，HeteroData | GCell 网格上的多通道数组（.npz，[x][y]）+ 预览图 |
| 特征 | 单元、线网、引脚的几何与电气特征 | 单元密度、宏单元区域、RUDY、引脚 RUDY、引脚密度 —— 只取自放置后的版图，不含布线信息 |
| 标签 | 拥塞、线长、时序、IR drop、RC 寄生参数 | 拥塞、IR drop |
| 校验 | tools/verify_graph_dataset.py（数百项） | verify_images.py（17 项，含与图数据集拥塞标签的逐单元对齐） |
结论为什么可信
- 模型负责判断，代码负责判定。 通过与否只由 DRC/LVS 和数据集校验器决定；模型调用的工具里没有任何
一个能宣布“通过”。检查器崩溃或超时不算通过。
- 只收签核通过的设计。 数据集构建前有签核门，版图与报告按内容摘要绑定，换了版图旧报告就失效。
- 每个数据集都经过独立复算。 校验程序不复用生成代码，自行解析 DEF/LEF/SPEF 重新计算并比对。
- 失败分得清。 agent 区分“你的 RTL 有问题”和“工具/流程问题”，并引用真实的报错码。
当前版本支持 nangate45（45 nm）平台；sky130hd、gf180 正在适配。设计文档：
docs/agent/AGENT_DESIGN.md。
作为 Claude Code 技能使用
A Claude Code skill that drives an open-source RTL-to-GDS flow — from natural-language spec (or existing RTL) through synthesis, place-and-route, and full signoff (DRC, LVS, RCX) — using Yosys, OpenROAD-flow-scripts, KLayout, and OpenRCX.
Install the r2g-skills skills (eda-install to set up the toolchain, rtl-acquire to grow an RTL corpus at scale, signoff-loop for RTL→GDS + signoff, def-graph for graph datasets), then ask Claude: "set up the EDA tools" followed by "synthesize this UART at 100 MHz on nangate45" — it handles everything from provisioning to GDSII. Recent changes: see CHANGELOG.md.
Prerequisites
| Tool | Required | Purpose |
|---|
| Python 3.10+ | yes | skill scripts |
| Yosys | yes | synthesis |
| iverilog / vvp | yes | simulation |
| OpenROAD + ORFS | yes | place & route, RCX |
| Verilator | optional | faster lint |
| KLayout | optional | GDS viewer, DRC, LVS |
| Magic + Netgen | optional | sky130 DRC / LVS |
| OpenSTA | optional | standalone STA |
| sky130A PDK | optional | sky130 signoff |
| torch + torch_geometric + pandas | optional | PyG graph datasets (run_graphs.sh; venv on /proj, R2G_GRAPH_PYTHON) |
Install the skill
git clone https://github.com/ShenShan123/r2g-skills.git
cd r2g-skills
bash r2g-skills/install.sh --user # installs eda-install + rtl-acquire + signoff-loop + def-graph into ~/.claude/skills/
Restart Claude Code (or run /reload) after install.
Other options:
This is the beginning of the README. Read the rest at the original. Read the full README ↗
