🔧 Installation Guide

Set up the complete open-source VLSI EDA toolchain. Choose your operating system below.

Prerequisites

Make sure your Ubuntu/Debian system is up to date:

# Update package lists
sudo apt update && sudo apt upgrade -y

# Install essential build tools
sudo apt install -y build-essential git cmake python3 python3-pip
OS: Ubuntu 20.04+ / Debian 11+
RAM: 4 GB minimum
Disk: ~5 GB free space
Shell: bash / zsh
1

Icarus Verilog

RTL Simulation — compile & run Verilog designs
sudo apt install -y iverilog

✅ Verify

$ iverilog -V
# Should show: Icarus Verilog version 12.0 (or similar)
2

GTKWave

Waveform Viewer — view .vcd simulation dumps
sudo apt install -y gtkwave

✅ Verify

$ gtkwave --version
3

Covered

Code Coverage — analyze toggle, line, FSM coverage
git clone https://github.com/hpretl/verilog-covered.git
cd verilog-covered
./configure
make
sudo make install
⚠️Build from source required. If you get a TCL_DSTRING error, check the project's GitHub issues for the patch.

✅ Verify

$ covered --version
4

Yosys

Logic Synthesis — RTL to gate-level netlist
sudo apt install -y yosys

# (Optional) Graphviz for circuit diagrams
sudo apt install -y graphviz

✅ Verify

$ yosys -V
5

OpenROAD

Physical Design Automation — floorplan, place, CTS, route
git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD.git
cd OpenROAD
sudo ./etc/DependencyInstaller.sh
mkdir build && cd build
cmake ..
make -j$(nproc)
sudo make install
💡Build takes ~30-60 min. The DependencyInstaller.sh handles all libraries (Boost, TCL, SWIG, etc.).

✅ Verify

$ openroad -version
0

Install WSL (Windows Subsystem for Linux)

Run a full Ubuntu environment inside Windows

Step 1: Open PowerShell as Administrator

# Install WSL with Ubuntu (default distro)
wsl --install

# Restart your PC when prompted
# After restart, Ubuntu will launch — create a username & password
⚠️Requires Windows 10 (version 2004+) or Windows 11. If wsl --install fails, go to Turn Windows features on or off → enable Windows Subsystem for Linux and Virtual Machine Platform, then restart.

Step 2: Update Ubuntu Inside WSL

# Open Ubuntu from Start Menu or type 'wsl' in PowerShell
sudo apt update && sudo apt upgrade -y

Step 3: GUI Support (for GTKWave) 

# Windows 11 / WSL2: GUI apps work out of the box via WSLg!
# Just run: gtkwave file.vcd — opens a native window

# Windows 10: Install VcXsrv or Xming on Windows, then in WSL:
export DISPLAY=:0
echo 'export DISPLAY=:0' >> ~/.bashrc

✅ Verify WSL

# In PowerShell:
$ wsl --list --verbose
# Should show: Ubuntu  Running  2

# Inside WSL terminal:
$ lsb_release -a
# Should show: Ubuntu 22.04 (or similar)
📂File access: Windows files → /mnt/c/Users/YourName/ · WSL files from Explorer → \\wsl$\Ubuntu\home\
✅WSL is ready! Now follow the same steps as Linux below. All commands run inside your WSL Ubuntu terminal.

Prerequisites

sudo apt update && sudo apt upgrade -y
sudo apt install -y build-essential git cmake python3 python3-pip
1

Icarus Verilog

RTL Simulation
sudo apt install -y iverilog
2

GTKWave

Waveform Viewer
sudo apt install -y gtkwave
💡Windows 11: GTKWave GUI opens natively via WSLg. Windows 10: Make sure your X server (VcXsrv) is running first.
3

Covered

Code Coverage
git clone https://github.com/hpretl/verilog-covered.git
cd verilog-covered && ./configure && make && sudo make install
4

Yosys

Logic Synthesis
sudo apt install -y yosys graphviz
5

OpenROAD

Physical Design Automation
git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD.git
cd OpenROAD
sudo ./etc/DependencyInstaller.sh
mkdir build && cd build
cmake .. && make -j$(nproc) && sudo make install

Prerequisites

Install Homebrew (the macOS package manager) and Xcode Command Line Tools:

# Install Xcode Command Line Tools
xcode-select --install

# Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Verify Homebrew
brew --version
OS: macOS 12+ (Monterey)
RAM: 4 GB minimum
Disk: ~5 GB free space
Arch: Intel or Apple Silicon
1

Icarus Verilog

RTL Simulation — compile & run Verilog designs
brew install icarus-verilog

✅ Verify

$ iverilog -V
2

GTKWave

Waveform Viewer — view .vcd simulation dumps
brew install --cask gtkwave
⚠️Apple Silicon (M1/M2/M3): If GTKWave doesn't open, you may need to install it via brew install --cask --no-quarantine gtkwave or use Surfer as an alternative waveform viewer.

✅ Verify

$ gtkwave --version
3

Covered

Code Coverage — analyze toggle, line, FSM coverage
git clone https://github.com/hpretl/verilog-covered.git
cd verilog-covered
./configure
make
sudo make install
💡Build from source. You need Tcl/Tk: brew install tcl-tk before building.
4

Yosys

Logic Synthesis — RTL to gate-level netlist
brew install yosys

# (Optional) Graphviz for circuit diagrams
brew install graphviz

✅ Verify

$ yosys -V
5

OpenROAD

Physical Design Automation — floorplan, place, CTS, route
# Install dependencies
brew install cmake boost swig tcl-tk eigen

# Clone and build
git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD.git
cd OpenROAD
mkdir build && cd build
cmake ..
make -j$(sysctl -n hw.ncpu)
sudo make install
⚠️Apple Silicon note: Some OpenROAD dependencies may need Rosetta. If you encounter issues, try: arch -x86_64 brew install ... for problematic packages, or build in an x86_64 environment.

✅ Verify

$ openroad -version

🎉 You're All Set!

All 5 tools installed. You can now run the complete RTL → Simulation → Synthesis → PDA flow.

← Back to Projects