The-OpenROAD-Project / OpenROAD-flow-scripts

# OpenROAD Flow
OpenROAD-flow-scripts (ORFS) is a fully autonomous, RTL-GDSII flow
for rapid architecture and design space exploration, early prediction
of QoR and detailed physical design implementation. However, ORFS
also enables manual intervention for finer user control of individual
flow stages through Tcl commands and Python APIs.
 [code] 
## Tool Installation
There are multiple ways to install and develop OpenROAD and ORFS. However, the best option depends on your use case, experience level, and personal preference.
> **Recommendation for new users:** 
> If you are new to OpenROAD-flow-scripts, Docker can be a reliable way to get started since it avoids most dependency and environment issues. 
> 
> On supported platforms, using the pre-built binaries can be an even simpler option as it avoids building from source. 
> 
> Alternatively, the Bazel-based flow also avoids manual dependency installation (aside from installing Bazelisk itself), similar to how Docker requires installing Docker.
### Use Bazel, avoid installing anything at all and adapt the flow to your needs in your own repository
bazel-orfs provides a seamless, reproducible way to manage dependencies and adapt the flow without requiring manual installations(no Docker images, sudo bash scripts, etc.)
By leveraging Bazel's robust build system, all dependencies are automatically resolved, versioned, and built in a consistent environment. This eliminates setup complexity, ensures fast incremental builds, and allows for easy customization of the flow, making it an efficient choice for both beginners and advanced users.
### Docker Based Installation
To ease dependency installation issues, ORFS uses docker images.
Docker image includes ORFS binaries, applications as well as all
required dependencies. All of the flow tools are encapsulated
inside the container image.
If `Docker` is not installed already, install latest docker tool
based on OS from here.
To manage docker as non-root user and verify that you can run
`docker` commands without `sudo` must complete steps from
here.
#### Build ORFS with Docker
Document for detailed steps on docker based installation found
here.
### Pre-built Binaries
You can download, set up and run ORFS easily with pre-built
binaries, including OpenROAD, Yosys and Klayout. See instructions
here.
> **Thanks** to Precision Innovations for
> providing and supporting OpenROAD based binaries.
> **Note** Only the latest version of OpenROAD is guaranteed to work with
> the latest version of ORFS.
> **Disclaimer** The versions of OpenROAD, Yosys and Klayout provided by
> other third-party vendors are not guaranteed to work with ORFS.
### Build from sources locally
Document for detailed local build from sources and installation steps found here.
## Using the Flow
- For details about the OpenROAD and the available features and
 individual flows commands, see the documentation
 here.
- For details about automated flow setup, see ORFS docs
 here.
- Flow tutorial to run th