# LogicFactory

**Repository Path**: oscc-project/LogicFactory

## Basic Information

- **Project Name**: LogicFactory
- **Description**: LogicFactory is an open-source logic synthesis platform for integrated cross-tool flow.
- **Primary Language**: C++
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-03
- **Last Updated**: 2025-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LogicFactory

LogicFactory is an open-source logic synthesis platform for integrated cross-tool flow.

<div style="text-align: center;">
    <img src="img/LogicFactory.svg" alt="Framework" style="width: 40%;">
</div>

# Build
- method1: build with docker env (recommend)
```
$ git clone https://github.com/Logic-Factory/LogicFactory.git
$ cd LogicFactory
$ git submodule update --init --recursive
$ docker build -t logic-factory:latest .
$ docker run -it -v ./LogicFactory:/workspace logic-factory:latest
$ cd /workspace
$ mkdir -p build && cd build
$ cmake -G Ninja ..
$ ninja
```

- method2: install dependencies and compile 
    - install build essential
    ```
    $ sudo apt-get update && sudo apt-get upgrade -y --no-install-recommends apt-utils
    $ sudo apt-get install -y software-properties-common build-essential wget curl cmake ninja-build git
    $ sudo apt-get install -y libreadline6-dev tcl-dev pkg-config bison flex rustc cargo libboost-all-dev libeigen3-dev libgtest-dev libgoogle-glog-dev libyaml-cpp-dev libcairo2-dev libunwind-dev libgmp-dev libgmpxx4ldbl libhwloc-dev libffi-dev libgflags-dev libmetis-dev
    ```
    - install gcc-10/g++-10
    ```
    $ sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
    $ sudo apt-get update
    $ sudo apt-get install -y gcc-10 g++-10
    $ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 60 --slave /usr/bin/g++ g++ /usr/bin/g++-10
    ```
    - install rust
    ```
    $ export RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup
    $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
    $ export PATH="/root/.cargo/bin:${PATH}"
    ```
    - compile
    ```
    $ git clone https://github.com/Logic-Factory/LogicFactory.git
    $ cd LogicFactory
    $ git submodule update --init --recursive
    $ mkdir -p build && cd build
    $ cmake -G Ninja ..
    $ ninja
    ```


# Getting Started
- RUN with tcl \
  before run this, you need to modify the datapath in the "demo/test.tcl" and  "config/layer_netlist/ieda/config_sky130.json".
```
$ ./build/app/logicfactory -s "demo/test.tcl"
```

- RUN with command sequence
```
$ ./build/app/logicfactory -c "help; start;"
```

- RUN with command line
```
$ ./build/app/logicfactory
--------------------------------------------
*    Welcome to LogicFactory (Platform)    *
*               Version 0.1                *
*     https://github.com/Logic-Factory     *
--------------------------------------------
% help
```

# Scheme
Anchor-based tool and logic type location
<div style="text-align: center;">
    <img src="img/scheme.svg" alt="Framework" style="width: 100%;">
    <img src="img/scheme-example.svg" alt="Framework" style="width: 100%;">
</div>

# Acknowledgement
- [yosys](https://github.com/YosysHQ/yosys)
- [berkeley-abc](https://github.com/berkeley-abc/abc)
- [epfl-lsils](https://github.com/lsils/lstools-showcase)
- [iEDA](https://github.com/OSCC-Project/iEDA)

# Q&A
- slack \
    [https://join.slack.com/t/open-logic-factory/shared_invite/zt-2sjpzqk1y-1SM9Xcx8CNTULq72l80H~w](https://join.slack.com/t/open-logic-factory/shared_invite/zt-2sjpzqk1y-1SM9Xcx8CNTULq72l80H~w)

# Contact
- email \
    Liwei Ni: nlwmode at gmail dot com