https://github.com/munich-quantum-toolkit/syrec

SyReC Synthesizer - A Tool for HDL-based Synthesis of Reversible Circuits
https://github.com/munich-quantum-toolkit/syrec

cpp17 python quantum-computing reversible-computation synthesis

Last synced: 10 months ago
JSON representation

SyReC Synthesizer - A Tool for HDL-based Synthesis of Reversible Circuits

• Host: GitHub
• URL: https://github.com/munich-quantum-toolkit/syrec
• Owner: munich-quantum-toolkit
• License: mit
• Created: 2022-01-05T16:58:07.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-05-12T03:43:03.000Z (11 months ago)
• Last Synced: 2025-05-12T04:33:49.468Z (11 months ago)
• Topics: cpp17, python, quantum-computing, reversible-computation, synthesis
• Language: C++
• Homepage: https://mqt.readthedocs.io/projects/syrec
• Size: 1.51 MB
• Stars: 28
• Watchers: 2
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/contributing.rst
  • License: LICENSE.md
  • Support: .github/support.rst

Awesome Lists containing this project

README

          
[![PyPI](https://img.shields.io/pypi/v/mqt.syrec?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.syrec/)

![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)

[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)

[![CI](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/syrec/ci.yml?branch=main&style=flat-square&logo=github&label=c%2B%2B)](https://github.com/munich-quantum-toolkit/syrec/actions/workflows/ci.yml)

[![Bindings](https://img.shields.io/github/actions/workflow/status/munich-quantum-toolkit/syrec/deploy.yml?branch=main&style=flat-square&logo=github&label=python)](https://github.com/munich-quantum-toolkit/syrec/actions/workflows/deploy.yml)

[![codecov](https://img.shields.io/codecov/c/github/munich-quantum-toolkit/syrec?style=flat-square&logo=codecov)](https://codecov.io/gh/munich-quantum-toolkit/syrec)

> [!NOTE]

> This project is currently in low maintenance mode. We will still fix bugs and accept pull requests, but we will not actively develop new features.



  

   

     

     

   

  



# SyReC Synthesizer: A Tool for HDL-based Synthesis of Reversible Circuits

A tool for HDL-based synthesis of reversible circuits developed as part of the [_Munich Quantum Toolkit (MQT)_](https://mqt.readthedocs.io) [^1].

It builds upon [MQT Core](https://github.com/munich-quantum-toolkit/core), which forms the backbone of the MQT.



  

  

  



If you have any questions, feel free to contact us by creating an issue on [GitHub](https://github.com/munich-quantum-toolkit/syrec/issues).

## Getting Started

The _SyReC Synthesizer_ is available via [PyPI](https://pypi.org/project/mqt.syrec/) for Linux, macOS, and Windows.

- In order to make the library as easy to use as possible (without compilation), we provide pre-built wheels for most common platforms (64-bit Linux, MacOS, Windows). These can be installed using

  ```bash

  (venv) $ pip install mqt.syrec

  ```

- Once installed, start the _SyReC Synthesizer_ GUI by running:

  ```bash

  (venv) $ syrec-editor

  ```

**Detailed documentation on all available methods, options, and input formats is available at [ReadTheDocs](https://mqt.readthedocs.io/projects/syrec).**

## System Requirements and Building

The implementation is compatible with any C++17 compiler and a minimum CMake version of 3.24.

Please refer to the [documentation](https://mqt.readthedocs.io/projects/syrec) on how to build the project.

Building (and running) is continuously tested under Linux, macOS, and Windows using the [latest available system versions for GitHub Actions](https://github.com/actions/virtual-environments).

## References

_SyReC Synthesizer_ has been developed based on methods proposed in the following papers:

[[1]](https://doi.org/10.1016/j.simpa.2022.100451)

S. Adarsh, L. Burgholzer, T. Manjunath and R. Wille. SyReC Synthesizer: An MQT tool for synthesis of reversible circuits. Software Impacts, 2022.

[[2]](http://www.informatik.uni-bremen.de/agra/doc/konf/10_syrec_reversible_hardware_language.pdf)

R. Wille, S. Offermann, and R. Drechsler. SyReC: A Programming Language for Synthesis of Reversible Circuits. In Forum on Specification and Design Languages (FDL), 2010.

[[3]](https://doi.org/10.1016/j.vlsi.2015.10.001)

R. Wille, E. Schönborn, M. Soeken, and R. Drechsler. SyReC: A hardware description language for the specification and synthesis of reversible circuits. Integration (The VLSI Journal), 2016.

[[4]](https://www.cda.cit.tum.de/files/eda/2019_iccad_hdl_based_reversible_circuit_synthesis_without_additional_lines.pdf)

R. Wille, M. Haghparast, S. Adarsh, and T. Manjunath. Towards HDL-based Synthesis of Reversible Circuits with No Additional Lines. In International Conference on Computer Aided Design (ICCAD), 2019.

[^1]: The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is a collection of software tools for quantum computing developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) as well as the [Munich Quantum Software Company (MQSC)](https://munichquantum.software). Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem, which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.

---

## Acknowledgements

The Munich Quantum Toolkit has been supported by the European

Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement

No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the

Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.