SymbiFlow Routing Resources Graph (rr-graph) Python Libraries

This repository contains a Python library and utilities for working with "Routing Resource Graph" (rr-graph) files used by SymbiFlow and Verilog to Routing.

It supports both the XML and Cap'n'Proto formats of rr-graph files. The Cap'n'Proto schema is generated from the XML schema @ vtr-verilog-to-routing/vpr/src/route/rr_graph.xsd using the uxsdcxx tool.

For information on the schema generation can be found in the SCHEMA_GENERATOR.md file in Verilog to Routing.

Contributing

A full contribution guide can be found in docs/contributing.md.

A few important points;

• All contributions should be sent as GitHub Pull requests.

• By contributing you agree to the code of conduct.

• All commits are required to include a DCO sign off line.

License

All software (code, associated documentation, support files, etc) in this repository is licensed under the very permissive ISC Licence.

A copy can be found in the LICENSE file.

All new contributions must also be released under this license.

Installing

From PyPI

pip install rr-graph

FYI: Builds are automatically published to GitHub on every push to this repository.

Direct from GitHub

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

Direct from checkout

python setup.py install or python setup.py develop

Developing

To setup a local development environment use the make venv target which will build you a Python virtualenv (in the venv directory) with the needed packages and tools.

The make version target will output the current version of the rr-graph library.

Running tests

To run the tests, run make test.

If you have an issue with the CI disagreeing with the output of your local make test output, you can also try the make test-like-ci target to closer match how the CI system runs the tests.

Formatting

To run automated formatting over the repository, use make format.

Updating GitHub Actions

The make format-gha target will update the GitHub Actions under .github/workflows with the latest version of the included tasks.

It is recommended that you commit these updates separately from your other changes.