Ubuntu/Other Linux¶
Minimum Requirements
Quad-core CPU running at 2.0 GHz+
8 GiB of RAM
Recommended Requirements
6th Gen Intel® Core CPU or later OR AMD Ryzen™️ 1000-series or later
16 GiB of RAM
We will primarily support Ubuntu 20.04+ for OpenLane.
If you’re looking to build a virtual machine, we recommend Ubuntu 22.04.
Installing Nix¶
Warning
Do not install Nix using apt
. The version of Nix offered by apt
is more
often than not severely out-of-date and may cause issues.
You will need curl
to install Nix.
To install curl on Ubuntu, simply type in the following in your terminal:
$ sudo apt-get install -y curl
After that, simply run this command:
$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix/pr/1145 | sh -s -- install --no-confirm --extra-conf "
extra-substituters = https://openlane.cachix.org
extra-trusted-public-keys = openlane.cachix.org-1:qqdwh+QMNGmZAuyeQJTH9ErW57OWSvdtuwfBKdS254E=
"
Enter your password if prompted. This should take around 5 minutes.
Make sure to close all terminals after you’re done with this step.
If you already have Nix set up…
You will need to enable OpenLane’s Binary Cache manually.
If you don’t know what that means:
We use a service called Cachix, which allows the reproducible Nix builds to be stored on a cloud server so you do not have to build OpenLane’s dependencies from scratch on every computer, which will take a long time.
First, you want to install Cachix by running the following in your terminal:
$ nix-env -f "<nixpkgs>" -iA cachix
Then set up the OpenLane binary cache as follows:
$ sudo env PATH="$PATH" cachix use openlane
…and restart the Nix daemon.
$ sudo pkill nix-daemon
If you do know what this means, the values are as follows:
extra-substituters = https://openlane.cachix.org
extra-trusted-public-keys = openlane.cachix.org-1:qqdwh+QMNGmZAuyeQJTH9ErW57OWSvdtuwfBKdS254E=
Make sure to restart nix-daemon
after updating /etc/nix/nix.conf
.
$ sudo pkill nix-daemon
Cloning OpenLane¶
With git installed, just run the following:
$ git clone https://github.com/efabless/openlane2
That’s it. Whenever you want to use OpenLane, nix-shell
in the repository root
directory and you’ll have a full OpenLane environment. The first time might take
around 10 minutes while binaries are pulled from the cache.
To quickly test your installation, simply run openlane --smoke-test
in the nix
shell.