# cirkit

**Repository Path**: xCodeleaner/cirkit

## Basic Information

- **Project Name**: cirkit
- **Description**: No description available
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: cirkit3
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/msoeken/cirkit.svg?branch=cirkit3)](https://travis-ci.org/msoeken/cirkit)
[![Build status](https://ci.appveyor.com/api/projects/status/201o4wdh0gmb56et?svg=true)](https://ci.appveyor.com/project/msoeken/cirkit)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# CirKit (version 3)

CirKit is a logic synthesis and optimization framework.  It is
implemented based on various [EPFL logic sythesis libraries](https://github.com/lsils/lstools-showcase).

## Clone

CirKit depends on submodules, so make sure to clone recursively:

```bash
git clone --recursive https://github.com/msoeken/cirkit.git
```

If you update the repository, then also update the submodules:

```bash
git pull origin cirkit3
git submodule update --recursive
```

## Installation (shell interface)

```bash
mkdir build
cd build
cmake ..
make cirkit
cli/cirkit
```

## Installation (Python library)

```bash
python3 setup.py install
```

But you can also use the `Makefile` to build the Python library in a virtual
environment:

```bash
make devbuild
```

## With custom compiler

CirKit is implemented using C++-17 features and therefore a recent compiler is
required (e.g., GCC ≥ 7.3.0 and Clang ≥ 7.0.0).  If your recent compiler is not
on the `PATH` prefix, extend the `cmake` command as follows:

```bash
cmake -DCMAKE_CXX_COMPILER=/path/to/c++-compiler ..
```

and prefix the `python3` command as follows:

```bash
CC=/path/to/c++-compiler python3 setup.py install
```

## Example (stand-alone application)

```bash
$ cirkit
read_aiger --aig file.aig
ps
cut_rewrite
lut_mapping
collapse_mapping
ps
write_bench file.bench
```

## Example (Python interface)

```python
import cirkit
cirkit.read_aiger(aig=True, filename="file.aig")
cirkit.ps(aig=True)
cirkit.cut_rewrite(aig=True)
cirkit.lut_mapping(aig=True)
cirkit.collapse_mapping(aig=True)
cirkit.ps(lut=True)
cirkit.write_bench(lut=True, filename="file.bench")
```

## RevKit 3.1

RevKit 3.1 is a Python library without a stand-alone interface as in CirKit.
It can be found at [the RevKit repository](https://github.com/msoeken/revkit).

## CirKit and RevKit 2.0

The 2.0 versions of CirKit and RevKit can be found
in the [develop](https://github.com/msoeken/cirkit/tree/develop/) branch.


## EPFL logic sythesis libraries

CirKit and Revkit are based on the [EPFL logic synthesis](https://lsi.epfl.ch/page-138455-en.html) libraries.  The 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).