OpenLane is currently in maintenance mode.

The versions of OpenLane currently being offered and supported are currently
versions 1.0.X, as they were used for countless tape outs for the Google MPW and
Efabless chipIgnite shuttles. Only critical bugfixes will be merged at this
point. The intent is that tape-outs on older shuttles may be reproduced.
OpenLane is not recommended for new projects or designs.

For new designs, kindly check out the successor to the OpenLane flow, the
LibreLane flow infrastructure (which is backwards-compatible.)

OpenLane

OpenLane is an automated RTL to GDSII flow based on several components including OpenROAD, Yosys, Magic, Netgen, CVC, SPEF-Extractor, KLayout and a number of custom scripts for design exploration and optimization. The flow performs all ASIC implementation steps from RTL all the way down to GDSII.

You can check out the documentation, including in-depth guides and reference manuals at ReadTheDocs.

Installation, the short version

The short version is, to install the OpenLane environment...

On Windows, install and launch the Windows Subsystem for Linux before doing anything. We recommend and provide instructions for Ubuntu 20.04.

On macOS, get brew.

Get Docker (or a compatible container engine)
- On Ubuntu, follow the Docker post install instructions after you install Docker.
Get Python 3.6 or higher: (macOS | Ubuntu)
- On Ubuntu, you may also need to install venv: apt-get install python3-venv, and pip: apt-get install python3-pip.
Get git (macOS | Ubuntu)
Get GNU Make (macOS | Ubuntu)

Run the following commands in your command-line prompt:

cd $HOME
git clone https://github.com/The-OpenROAD-Project/OpenLane
cd OpenLane
make
make test

If everything's gone smoothly, that's it. OpenLane is set up on your computer. To enter the OpenLane environment, cd $HOME/OpenLane and then make mount.

Installation, the long version

See the installation docs at https://openlane.readthedocs.io/en/superstable/getting_started/installation/index.html.

Usage

After entering the OpenLane environment, you can start hardening chips: the following command, for example, runs the included spm design.

./flow.tcl -design spm

Publication

If you use OpenLane in your research, please cite the following paper.

M. Shalan and T. Edwards, “Building OpenLANE: A 130nm OpenROAD-based Tapeout-Proven Flow: Invited Paper,” 2020 IEEE/ACM International Conference On Computer Aided Design (ICCAD), San Diego, CA, USA, 2020, pp. 1-6. Paper

@INPROCEEDINGS{9256623,
  author={Shalan, Mohamed and Edwards, Tim},
  booktitle={2020 IEEE/ACM International Conference On Computer Aided Design (ICCAD)}, 
  title={Building OpenLANE: A 130nm OpenROAD-based Tapeout- Proven Flow : Invited Paper}, 
  year={2020},
  volume={},
  number={},
  pages={1-6},
  doi={}}

Legal Stuff

Newer container images (downloaded from
ghcr.io/the-openroad-project/openlane) are distributed by Somnium Consulting
LLC under the same license.

Older container images (downloaded from docker.io/efabless/openlane) were
distributed by Efabless Corporation under the same license.

Binaries in OpenLane distributions may fall under stricter open source licenses.

The-OpenROAD-Project/OpenLane