Installation¶

The MQT Bench Python package is available on PyPI and can be installed on all major operating systems using all modern Python versions.

Tip

We highly recommend using uv for working with Python projects. It is an extremely fast Python package and project manager, written in Rust and developed by Astral (the same team behind ruff). It can act as a drop-in replacement for pip and virtualenv, and provides a more modern and faster alternative to the traditional Python package management tools. It automatically handles the creation of virtual environments and the installation of packages, and is much faster than pip. Additionally, it can even set up Python for you if it is not installed yet.

If you do not have uv installed yet, you can install it via:

macOS and Linux

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

Windows

$ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Check out their excellent documentation for more information.

uv (recommended)

$ uv pip install mqt.bench

pip

(.venv) $ python -m pip install mqt.bench

Once installed, you can check if the installation was successful by running:

(.venv) $ python -c "import mqt.bench; print(mqt.bench.__version__)"

which should print the installed version of the library.

Integrating MQT Bench into your project¶

If you want to use the MQT Bench Python package in your own project, you can simply add it as a dependency in your pyproject.toml or setup.py file. This will automatically install the MQT Bench package when your project is installed.

uv (recommended)

$ uv add mqt.bench

pyproject.toml

[project]
# ...
dependencies = ["mqt.bench>=2.0.0"]
# ...