Installing Topwrap¶

1. Install required system packages¶

Caution

Topwrap has been tested on Debian Bullseye and Bookworm. 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:

Install required dependencies

apt install -y python3 python3-pip yosys npm

And uv if you want to use it to install Topwrap:

curl -LsSf https://astral.sh/uv/install.sh | sh

For more details see uv installation page

2. Install the Topwrap user package¶

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

uv tool install "topwrap @ git+https://github.com/antmicro/topwrap"

If you can’t use uv, 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@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.