https://github.com/msoeken/revkit

RevKit: Python quantum compilation library and framework
https://github.com/msoeken/revkit

Last synced: about 2 months ago
JSON representation

RevKit: Python quantum compilation library and framework

• Host: GitHub
• URL: https://github.com/msoeken/revkit
• Owner: msoeken
• License: mit
• Created: 2019-02-07T18:39:36.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-29T13:29:05.000Z (over 5 years ago)
• Last Synced: 2024-10-26T07:59:09.768Z (2 months ago)
• Language: C++
• Size: 945 KB
• Stars: 24
• Watchers: 5
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/msoeken/revkit.svg?branch=master)](https://travis-ci.org/msoeken/revkit)

# RevKit 3.1

RevKit 3.1 is a Python quantum compilation library.  RevKit is based on the C++

libraries [tweedledum](https://github.com/boschmitt/tweedledum) and

[caterpillar](https://github.com/gmeuli/caterpillar) (as well as other C++

libraries from the

[EPFL logic synthesis libraries](https://github.com/lsils/lstools-showcase)),

and exposes their functionality by means of simple Python APIs.  It also

contains the module `revkit.export` with several functions for interoperability

with other quantum programming languages and frameworks.

## Example

The following example creates a quantum circuit that computes the oracle

function `(a ∧ b) ⊕ (c ∧ d)` onto an ancilla qubit.

```python

from revkit import netlist, oracle_synth, truth_table

import revkit.export.qiskit

function = truth_table.from_expression("[(ab)(cd)]") # (a ∧ b) ⊕ (c ∧ d)

circuit = oracle_synth(function)

qcircuit = circuit.to_qiskit()

```

## Installation

From PyPi *(not yet available)*

```

pip install revkit

```

From Github with `setuptools`

```

pip install git+https://github.com/msoeken/revkit@develop

```

From Github with `make`

```

git clone -b develop https://github.com/msoeken/revkit

cd revkit

make devbuild

```

A very recent C++ compiler with support for C++ 17 is required to build RevKit.

If compilation with the default compiler on your system does not work, try to

setting the `CC` environment variable to a more recent compiler.

## Previous versions

RevKit has a 10-year long history. The rapidly changing requirements for

quantum computing also influenced RevKit, such that it was redesigned several

times. Previous versions of RevKit can be found online, but are no longer

maintained. Since version 3.1, RevKit does no longer exist as a standalone

command line application, but solely as a Python library, with the focus of an

easy integration with other Python-based quantum programming frameworks. In

order to access the various functionality in other applications, the libraries

[tweedledum](https://github.com/boschmitt/tweedledum) and

[caterpillar](https://github.com/gmeuli/caterpillar) can be used directly

instead.

## EPFL logic sythesis libraries

RevKit is based on the [EPFL logic synthesis](https://lsi.epfl.ch/page-138455-en.html) libraries.  The other libraries and several examples on how to use and integrate the libraries can be found in the [logic synthesis tool showcase](https://github.com/lsils/lstools-showcase).