# OpenROAD Flow

> OpenROAD Flow  documentation


The Regents of the University of California, 2021

## Pages

- [Adding New Designs to the ORFS](user/AddingNewDesign.html.md): This section explains how to add  verilog designs to ORFS
- [Build from sources locally](user/BuildLocally.html.md): The `setup.sh` script installs all of the dependencies, including OpenROAD dependencies, if they are...
- [Build from sources using Docker](user/BuildWithDocker.html.md): This document describes how to build your own Docker image.
- [Using Pre-built Binaries](user/BuildWithPrebuilt.html.md): Please ensure the Klayout version (denoted with `klayoutVersion` variable) is consistent with the on...
- [Build with WSL](user/BuildWithWSL.html.md): Windows Subsystem for Linux, or WSL for short is a way for you to mount a Linux-based OS onto your W...
- [CI Guide](contrib/CI.html.md): This document describes the pipelines available to the developers and code
- [Contributor Covenant Code of Conduct](contrib/CODE_OF_CONDUCT.html.md): We as members, contributors, and leaders pledge to make participation in our
- [Running Claude Code in Docker](user/ClaudeCode.html.md): The `claude.sh` script runs [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
- [Developer Guide](contrib/DeveloperGuide.html.md): - Integrate a new platform to OpenROAD Flow: [Guide](PlatformBringUp.md).
- [Building example design using Docker image](user/DockerShell.html.md): The `docker_shell` script is used to launch a command using a OpenROAD-flow-scripts docker image.
- [FAQs](user/FAQS.html.md): If you cannot find your question/answer here, please file a GitHub issue to
- [OpenROAD Flow Scripts Tutorial](tutorials/FlowTutorial.html.md): This document describes a tutorial to run the complete
- [Variables for the OpenROAD Flow Scripts](user/FlowVariables.html.md): Variables are used in the OpenROAD flow to define various
- [OpenROAD QoR and CI Metrics](user/Flow_QoR_CI.html.md): The [OpenROAD Dashboard](QoRDashboard.md) provides an easy way to explore
- [Getting Involved](contrib/GettingInvolved.html.md): Thank you for taking the time to read this document and to contribute.
- [Git Quickstart](contrib/GitGuide.html.md): This tutorial serves as a quickstart to Git and contributing to our repository. If you have not alre...
- [Instructions for AutoTuner with Ray](user/InstructionsForAutoTuner.html.md): *AutoTuner* is a “no-human-in-loop” parameter tuning framework for commercial and academic RTL-to-GD...
- [Jenkins Continuous Integration](user/Jenkins.html.md): The Jenkins website is at [https://jenkins.openroad.tools/](https://jenkins.openroad.tools/).
- [Tips on building large design](user/LargeDesigns.html.md): Large designs can quickly result in unmanageable turnaround times for tweaking and fixing if the des...
- [Utilities](Manpage.html.md): The utility module contains the `man` command.
- [Metrics](contrib/Metrics.html.md): The [OpenROAD-flow-scripts](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts)
- [Colab Quickstart](tutorials/Notebooks.html.md): Notebook-based packaging offers three main benefits:
- [Guide to Integrate a New Platform into the OpenROAD Flow](contrib/PlatformBringUp.html.md): This document is a guide for foundry and third party IP providers to
- [Using the OpenROAD Dashboard to track and analyze Quality of Results](user/QoRDashboard.html.md): The metrics dashboard [(https://dashboard.theopenroadproject.org/)](https://dashboard.theopenroadpro...
- [Welcome to OpenROAD’s documentation!](SupportedOS.html.md): The OpenROAD (“Foundations and Realization of Open, Accessible Design”)
- [OpenROAD-flow-scripts tutorial](tutorials/TutorialHome.html.md): The links to the main flow tutorial, where we go through each step of
- [User Guide](user/UserGuide.html.md): The OpenROAD Project uses three tools to perform automated RTL-to-GDS layout generation:
- [Welcome to the OpenROAD Flow Scripts documentation!](index2.html.md): The OpenROAD (“Foundations and Realization of Open, Accessible Design”)
- [OpenROAD Flow](mainREADME.html.md): [![Build Status](https://jenkins.openroad.tools/buildStatus/icon?job=OpenROAD-flow-scripts-Public%2F...

---

For more comprehensive documentation, see [llms-full.txt](llms-full.txt)