Installation

SyReC Synthesizer is mainly developed as a C++ library. In order to make the tool as accessible as possible, it comes with an easy-to-use Python interface.

We encourage installing SyReC Synthesizer via pip (preferably in a virtual environment):

(venv) $ pip install mqt.syrec

Once installed, start the SyReC Synthesizer editor GUI by running:

(venv) $ syrec-editor

In most practical cases (under 64-bit Linux, MacOS incl. Apple Silicon, and Windows), this requires no compilation and merely downloads and installs a platform-specific pre-built wheel.

Note

In order to set up a virtual environment, you can use the following commands:

$ python3 -m venv venv
$ source venv/bin/activate

If you are using Windows, you can use the following commands instead:

$ python3 -m venv venv
$ venv\Scripts\activate.bat

It is recommended to make sure that you are using the latest version of pip, setuptools, and wheel before trying to install the project:

(venv) $ pip install --upgrade pip setuptools wheel

Building from Source for Performance

In order to get the best performance out of SyReC Synthesizer and enable platform-specific compiler optimizations that cannot be enabled on portable wheels, it is recommended to build the package from source via:

(venv) $ pip install mqt.syrec --no-binary mqt.syrec

This requires a C++ compiler compiler supporting C++17, a minimum CMake version of 3.19, and the Boost libraries with a minimum version of 1.71.0.

The library is continuously tested under Linux, MacOS, and Windows using the latest available system versions for GitHub Actions. In order to access the latest build logs, visit syrec/actions/workflows/ci.yml.

Note

We noticed some issues when compiling with Microsoft’s MSCV compiler toolchain. If you want to start development on this project under Windows, consider using the clang compiler toolchain. A detailed description of how to set this up can be found here.