Welcome to OpenROAD Cloud Flow

The source code that empowers https://flow.theopenroadproject.org/

Purpose

The OpenROAD Project aims at providing a 24-hour, no-human-in-the-loop layout design for SoC, package and PCB with no Power-Performance-Area (PPA) loss. The cloud infrastructure set up at OpenROAD Flow makes the tools and designs accessible through an easy-to-use web-based interface.

If you want to jump start using our platform, go to the Quickstart section. To get a deeper look at the platform, refer to the documentation section.

Quickstart Guide

Jumpstart with our 3-minute video: https://youtu.be/4WR-QgdsluA

Go to https://flow.theopenroadproject.org, register for an account and follow the step-by-step tutorial.

Documentation

Find our detailed documentation at https://docs.theopenroadproject.org.

Deployment on a Private Cloud

Although the publicly available platform enables our research and offers ease-of-use and latest improvements to users around the world, OpenROAD flow can be independently deployed on a private cloud infrastructure. Follow our deployment guide to get started. You can also seek help below.

Contributing

To contribute to our project, have a look at the project roadmap to get familiar with our plans. Our developer guide outlines important coding style and organization of the codebase.

In general, here are the skills and tracks you can contribute to:

• Frontend development: We build user-centric web-based interfaces. You can contribute to this track if you have decent skills in HTML, CSS, JavaScript and JQuery. Dare to modernize our frontend stack to VueJS, Angular or React? We would love to hear from you.
• Backend development: Our REST APIs are built using Python Django REST Framework. In addition, there are some views rendered using Django template system. Contribute to this track if you are familiar with Python, Djnago, REST APIs and databases.
• Testing: writing unit tests, integration tests, and automating this process is at the heart of our CI/CD pipeline. Contribute to this track to enhance the reliability of the platform.

Before submitting a pull request, get in touch with the project contributors to align what features you will be working on.

Help

In the issues tab, create a new issue with your question. If you need to send attachments with private IPs, contact us through https://docs.theopenroadproject.org/#questions-support

License

BSD 2-Clause License

Copyright (c) 2019, The OpenROAD Project All rights reserved.