SymbiFlow 路由资源图 (rr-graph) Python 库

此存储库包含用于处理由 "路由资源图" (rr-graph) 文件 的 Python 库和工具，这些文件由 SymbiFlow 和 Verilog to Routing 使用。

它支持 rr-graph 文件的 XML 和 Cap'n'Proto 格式。Cap'n'Proto 架构是从 XML 架构 vtr-verilog-to-routing/vpr/src/route/rr_graph.xsd 使用 uxsdcxx 工具 生成的。

有关模式生成的信息可以在SCHEMA_GENERATOR.md文件中找到，该文件位于Verilog to Routing。

贡献

完整的贡献指南可以在docs/contributing.md中找到。

以下是一些重要要点；

• 所有贡献应以GitHub Pull requests的形式发送。

• 通过贡献，您同意行为准则。

• 所有提交都必须包含一个DCO签署行。

许可证

本存储库中所有的软件（代码、相关文档、支持文件等）均根据非常宽泛的ISC许可授权。

副本可以在LICENSE文件中找到。

所有新的贡献也必须在此许可下发布。

安装

从PyPI

pip install rr-graph

注意：每次向此存储库推送时，构建都将自动发布到GitHub。

直接从GitHub

pip install git+https://github.com/SymbiFlow/symbiflow-rr-graph.git#egg=rr-graph

直接从检出

python setup.py install或python setup.py develop

开发

要设置本地开发环境，请使用make venv目标，这将为您构建一个包含所需包和工具的Python虚拟环境（在venv目录中）。

make version目标将输出rr-graph库的当前版本。

运行测试

要运行测试，请运行make test。

如果您遇到CI系统与本地make test输出不一致的问题，您还可以尝试运行make test-like-ci目标，以更接近CI系统运行测试的方式。

格式化

要运行对存储库的自动格式化，请使用make format。

更新GitHub Actions

make format-gha目标将使用最新版本的任务更新.github/workflows下的GitHub Actions。

建议您将这些建议与其他更改分开提交。