Other Linux

Installing Dependencies

For OpenLane you need a couple of tools installed:

  • Docker 19.03.12+

    • Docker post-installation steps for running without root

  • Git 2.35+

  • Python 3.8+ with pip and tkinter

Please install all of these dependencies using your package manager. Please note that while alternative container services such as podman do work, they are not officially supported.

Installing Docker

First, install Docker following the steps provided in this link.

Test if installation was successful:

sudo docker run hello-world

A successful installation of Docker looks like this:

Hello from Docker!
This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:
1. The Docker client contacted the Docker daemon.
2. The Docker daemon pulled the "hello-world" image from the Docker Hub. (amd64)
3. The Docker daemon created a new container from that image which runs the executable that produces the output you are currently reading.
4. The Docker daemon streamed that output to the Docker client, which sent it to your terminal.

To try something more ambitious, you can run an Ubuntu container with:
$ docker run -it ubuntu bash

Share images, automate workflows, and more with a free Docker ID:
https://hub.docker.com/

For more examples and ideas, visit:
https://docs.docker.com/get-started/

Making Docker available without root (Linux only)

Warning

The steps below might become outdated. It is recommended to follow the link to the official Docker documentation here: instructions here.

Important

This is a mandatory step. Without this, most OpenLane scripts will error out with permission issues. A majority of installation issues from users come from people skipping this so, once again, DO NOT SKIP!

sudo groupadd docker
sudo usermod -aG docker $USER
sudo reboot # REBOOT!

You must restart your operating system for the group permissions to apply.

Checking the Docker Installation

After that, you can run Docker Hello World without root. To test it use the following command:

# After reboot
docker run hello-world

You will get a little happy message of Hello world, once again, but this time without root.

Hello from Docker!
This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:
1. The Docker client contacted the Docker daemon.
2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
   (amd64)
3. The Docker daemon created a new container from that image which runs the
   executable that produces the output you are currently reading.
4. The Docker daemon streamed that output to the Docker client, which sent it
   to your terminal.

To try something more ambitious, you can run an Ubuntu container with:
$ docker run -it ubuntu bash

Share images, automate workflows, and more with a free Docker ID:
https://hub.docker.com/

For more examples and ideas, visit:
https://docs.docker.com/get-started/

Troubleshooting Docker permission issues (Linux only)

If you get Docker permission error when running any Docker images, then likely, you forgot to follow the steps to make Docker available without root or you need to restart your Operating System.

OpenLane> docker run hello-world
docker: Got permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Post "http://%2Fvar%2Frun%2Fdocker.sock/v1.24/containers/create": dial unix /var/run/docker.sock: connect: permission denied.
See 'docker run --help'.
OpenLane>

Checking Installation Requirements

In order to check the installation, you can use the following commands:

docker --version
python3 --version
python3 -m pip --version

Successful outputs will look like this:

$ docker --version
Docker version 20.10.16, build aa7e414fdc
$ python3 --version
Python 3.10.5
$ python3 -m pip --version
pip 21.0 from /usr/lib/python3.10/site-packages/pip (python 3.10)
...
Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.

Download and Install OpenLane

  • Download OpenLane using PIP:

python3 -m pip install openlane
  • Run a smoke test for OpenLane:

python3 -m openlane --dockerized --smoke-test

If the smoke test finishes successfully, congratulations. You’re ready to use OpenLane.

Note

You can run simply invoke python3 -m openlane --dockerized without any arguments to drop into an interactive shell inside the Docker environment, with your home directory and your PDK root directory mounted.