Installing Topwrap¶

1. Install required system packages¶

Caution

Topwrap has been tested on Debian Bullseye and Bookworm, both of which include ANTLR4 version 4.7.2.
This specific version is required for the proper operation of one of Topwrap’s dependencies, hdlConvertor.
While other distributions may also be compatible, Bullseye and Bookworm reflect environments where functionality has been verified.

On Debian and Debian-based distributions, follow these steps to install the required dependencies:

apt install -y python3 python3-pip yosys npm antlr4 libantlr4-runtime-dev pipx

2. Install the Topwrap user package¶

Recommended: Use pipx to directly install Topwrap as a user package:

pipx install "topwrap[parse]@git+https://github.com/antmicro/topwrap"

If you can’t use pipx, you can use regular pip instead. It may be necessary to do it in a Python virtual environment, such as venv:

python3 -m venv venv
source venv/bin/activate
pip install "topwrap[parse]@git+https://github.com/antmicro/topwrap"

3. Verify the installation¶

Make sure that Topwrap was installed correctly and is available in your shell:

topwrap --help

This should print out the help string with Topwrap subcommands listed out.