Mohamed Gaber a7b0e6dba7
Some checks failed
CI / Prepare Test Matrices and Cache PDKs (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Build and Unit Test (Python 3.10) (push) Has been cancelled
CI / Build and Unit Test (Python 3.8) (push) Has been cancelled
CI / Build and Unit Test (Python 3.9) (push) Has been cancelled
CI / Build (Nix/x86_64-linux) (push) Has been cancelled
CI / Build (Nix/aarch64-linux) (push) Has been cancelled
CI / Build (Nix/aarch64-darwin) (push) Has been cancelled
CI / Build (Nix/x86_64-darwin) (push) Has been cancelled
CI / Build Docker Image (aarch64) (push) Has been cancelled
CI / Build Docker Image (amd64) (push) Has been cancelled
CI / Test Design ${{ matrix.design.test_name }} (${{ matrix.design.pdk }}/${{matrix.design.scl}}) (push) Has been cancelled
CI / Merge Metrics (push) Has been cancelled
CI / Upload Metrics (push) Has been cancelled
CI / Publish (If Applicable) (push) Has been cancelled
docs: point to librelane in readme (#693)
2025-12-02 14:25:48 +02:00

Banner explaining that development has moved over to github.com/librelane/librelane

If you're looking to tapeout an OpenLane 2/LibreLane-based design with ChipFoundry, an appropriate version of OpenLane 2/LibreLane will be automatically pulled by your target template:


OpenLane

License: Apache 2.0 Python 3.8 or higher Code Style: black Checked with mypy Built with Nix

OpenLane is an ASIC infrastructure library based on several components including OpenROAD, Yosys, Magic, Netgen, CVC, KLayout and a number of custom scripts for design exploration and optimization.

A reference flow, "Classic", performs all ASIC implementation steps from RTL all the way down to GDSII.

You can find the documentation here to get started.

Try it out

You can try OpenLane right in your browser, free-of-charge, using Google Colaboratory by following this link.

Installation

You'll need the following:

  • Python 3.8 or higher with PIP, Venv and Tkinter

Works for macOS and Linux (x86-64 and aarch64). Recommended, as it is more integrated with your filesystem and overall has less upload and download deltas.

See Nix-based installation in the docs for more info.

Docker

Works for Windows, macOS and Linux (x86-64 and aarch64).

See Docker-based installation in the docs for more info.

Do note you'll need to add --dockerized right after openlane in most CLI invocations.

You'll need to bring your own compiled utilities, but otherwise, simply install OpenLane as follows:

python3 -m pip install --upgrade openlane

Python-only installations are presently unsupported and entirely at your own risk.

Usage

In the root folder of the repository, you may invoke:

python3 -m openlane --pdk-root <path/to/pdk> </path/to/config.json>

To start with, you can try:

python3 -m openlane --pdk-root $HOME/.volare ./designs/spm/config.json

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={}}

License and Information

The Apache License, version 2.0.

Docker images distributed by Efabless Corporation under the same license.

Binaries bundled with OpenLane either via Cachix or Docker are distributed by Efabless Corporation and may fall under stricter open source licenses.

Description
The next generation of OpenLane, rewritten from scratch with a modular architecture
Readme 49 MiB
Languages
Python 83%
Tcl 10.6%
Jupyter Notebook 2.3%
Nix 2.2%
Verilog 1.5%
Other 0.4%