Compatibility

WHAD is only available on Linux/Mac machines (at the moment) and does not work on Windows system. This is due to some specific under-the-hood internals that are not compatible with Microsoft Windows systems.

Easy install with pip

WHAD is available on pypi and can be easily installed on a Linux-based host using pip. We highly recommend to setup a dedicated virtual environment to avoid any dependency issue or collision.

The following commands will install WHAD on your machine in a dedicated virtual environment:

$ python -m venv whad
$ . ./whad/bin/activate
(whad)$ pip install whad

Install from git repository

WHAD can also be installed from the official git repository. This option may be useful if you want to try an unstable or in-development version of WHAD. It is recommended to install WHAD in a virtual environment:

git clone --recurse-submodules https://github.com/whad-team/whad-client.git
cd whad-client
python -m venv my_venv
. /my_venv/bin/activate
pip install .

Need help ?

Our documentation features an installation section detailing all available options with their corresponding prerequisites and dependencies. It also provides some tips and guidelines that may be useful if you face any unexpected issue while trying to install our framework.

You can also join our Discord server and ask for help !