https://github.com/the-openroad-project/openlane

OpenLane is an automated RTL to GDSII flow based on several components including OpenROAD, Yosys, Magic, Netgen and custom methodology scripts for design exploration and optimization.
https://github.com/the-openroad-project/openlane

130nm asic caravel foundry klayout magic netgen openram openroad rtl rtl2gds skywater soc-design system-on-chip verilog vlsi yosys

Last synced: 3 days ago
JSON representation

OpenLane is an automated RTL to GDSII flow based on several components including OpenROAD, Yosys, Magic, Netgen and custom methodology scripts for design exploration and optimization.

• Host: GitHub
• URL: https://github.com/the-openroad-project/openlane
• Owner: The-OpenROAD-Project
• License: apache-2.0
• Created: 2020-07-20T19:35:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-20T11:22:15.000Z (2 months ago)
• Last Synced: 2024-12-19T16:08:22.243Z (3 days ago)
• Topics: 130nm, asic, caravel, foundry, klayout, magic, netgen, openram, openroad, rtl, rtl2gds, skywater, soc-design, system-on-chip, verilog, vlsi, yosys
• Language: Python
• Homepage: https://openlane.readthedocs.io/
• Size: 836 MB
• Stars: 1,375
• Watchers: 61
• Forks: 378
• Open Issues: 93
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
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](https://openlane.readthedocs.io/).

## Installation, the short version

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

> On Windows, install and launch the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install) before doing anything. We recommend and provide instructions for Ubuntu 20.04.

> On macOS, get [brew](https://brew.sh).

1. [Get Docker](https://docs.docker.com/get-docker/) (or a compatible container engine)

    * On Ubuntu, follow the [Docker post install instructions](https://docs.docker.com/engine/install/linux-postinstall/) after you install Docker.

2. Get Python 3.6 or higher ([macOS](https://formulae.brew.sh/formula/python3) | [Ubuntu](https://packages.ubuntu.com/focal/python3))

    * On Ubuntu, you may also need to install venv: `apt-get install python3-venv`

3. Get git ([macOS](https://formulae.brew.sh/formula/git) | [Ubuntu](https://packages.ubuntu.com/focal/git))

4. Get GNU Make ([macOS](https://formulae.brew.sh/formula/make) | [Ubuntu](https://packages.ubuntu.com/focal/make))

Run the following commands in your command-line prompt:

```sh

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/latest/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](./designs/spm).

```sh

./flow.tcl -design spm

```

## Need more help?

You can join the [Open Source Silicon Slack](https://invite.skywater.tools), where you can ask thousands of other open source hardware enthusiasts for help with setting up or running OpenLane.

## 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](https://ieeexplore.ieee.org/document/9256623)

```bibtex

@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

[The Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).

Docker images distributed by Efabless Corporation under the same license.

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