SymbiFlow RR Graph libraries
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for rr_graph-0.0.1.post19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e046016a8f5d08d86f0096b6b547dac55a31d029e07ae23808321d1026e656e8 |
|
MD5 | b915feae8dd150b28ed944c8c4c263de |
|
BLAKE2b-256 | a36b70f345febc2e1c5859ff8e58b5db65c61b9c13a160cf2f5153b699212cfa |
Hashes for rr_graph-0.0.1.post19-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86031c8d9f6f0b450e6a8569beec17b068bad8b1a55e2211e0adeb3ece261cc6 |
|
MD5 | ff8e1ac99d09feb66d4772d00a4c6027 |
|
BLAKE2b-256 | 2a328bc81145c44b50d276e211deec6fa5f1329c606d15244daad7f4cf0483b9 |