Installation¶

Install required system packages:

Debian:

apt install -y git g++ make python3 python3-pip yosys npm

Arch:

pacman -Syu git gcc make python3 python-pip yosys npm

Fedora:

dnf install git g++ make python3 python3-pip python3-devel yosys npm

Install the Topwrap package (It is highly recommended to run this step in a Python virtual environment, e.g. venv):
```
python3 -m venv venv
source venv/bin/activate
pip install .
```

Note

To use topwrap parse command you also need to install optional dependencies:

apt install -y antlr4 libantlr4-runtime-dev
pip install ".[topwrap-parse]"

On Arch-based distributions a symlink to antlr4 runtime library needs to created and an environment variable set:

pacman -Syu antlr4 antlr4-runtime
ln -s /usr/share/java/antlr-complete.jar antlr4-complete.jar
ANTLR_COMPLETE_PATH=`pwd` pip install ".[topwrap-parse]"

On Fedora-based distributions symlinks need to be made inside /usr/share/java directory itself:

dnf install antlr4 antlr4-cpp-runtime-devel
sudo ln -s /usr/share/java/stringtemplate4/ST4.jar /usr/share/java/stringtemplate4.jar
sudo ln -s /usr/share/java/antlr4/antlr4.jar /usr/share/java/antlr4.jar
sudo ln -s /usr/share/java/antlr4/antlr4-runtime.jar /usr/share/java/antlr4-runtime.jar
sudo ln -s /usr/share/java/treelayout/org.abego.treelayout.core.jar /usr/share/java/treelayout.jar
pip install ".[topwrap-parse]"

If you want to contribute to the project please see the Developer’s setup guide.

Last update: 2024-11-12