markdown/ORFS_docs/general/UserGuide.md

User Guide

The OpenROAD Project uses three tools to perform automated RTL-to-GDS layout generation:

1. yosys: Logic Synthesis
2. OpenROAD: Floorplanning through Detailed Routing
3. KLayout: GDS merge, DRC and LVS (public PDKs)

To automate RTL-to-GDS we provide OpenROAD Flow, which contains scripts that integrate the three tools.

Code Organization

The OpenROAD Flow repository serves as an example RTL-to-GDS flow using the OpenROAD tools. The script build_openroad.sh in the repository will automatically build the OpenROAD toolchain.

The two main directories are:

1. tools/: contains the source code for the entire yosys and OpenROAD App (both via submodules) as well as other tools required for the flow.
2. flow/: contains reference recipes and scripts to run designs through the flow. It also contains public platforms and test designs.

Setup

See Getting Started guide.

Using the OpenROAD Flow

See the documentation here for details about the flow and how to run designs through the flow.

Using the OpenROAD App

See the documentation here for details about the app and the available features and commands.