Skip to content

Latest commit

 

History

History
282 lines (221 loc) · 10.3 KB

README.md

File metadata and controls

282 lines (221 loc) · 10.3 KB

Contributors Stargazers Issues


Logo

VDS Class Project
Group #4
Winter Semester 2022/2023

GitHub repository for the Verification of Digital Systems Class Project

Report Bug



Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contact
  5. Acknowledgments

About The Project

In the course of this Lab assignment, students are going to implement a minimal BDD package in C++. This package implements the fundamental manipulation methods for ROBDDs as they were introduced in the lecture Verification of Digital Systems by Prof. Kunz. The package will be implemented using the Test Driven Development (TDD) paradigm presented by Dr. Wedler.

The project is split into three parts.

(back to top)

Part1:

Implementation of the basic functionality of the BDD package using the TDD methodology. This is the biggest part of the project.

Main tasks in this part:

  • Set up and maintain a Git repository
  • Use CMake as a build system of the project
  • Verify the code using GTest
  • Set up a Continuous Integration (CI) pipeline with GitHub Actions (Mandatory)
  • Use Doxygen (or a similar tool) to generate documentation for the API. (Optional)

(back to top)

Part2:

Improvement of the performance of the implementation via provided benchmarks.

Main tasks in this part:

  • Learning how to identify performance bottlenecks within the code.
  • Analyzing benchmark results.
  • How to overcome bottlenecks.

(back to top)

Part3:

Extending the existing implementation by a practical application of BDD. Using BDDs, it is possible to symbolically represent a state-space. This representation allows to check quickly, whether a specific state is within the reachable state space or not.

(back to top)

Getting Started

Fork this repository and follow the instructions given in doc/ to complete the project.

Prerequisites

List of Ubuntu packages required to complete the project:

  • git-all
  • libboost-all-dev
  • build-essential
  • graphviz, libgraphviz-dev for visualise function

(back to top)

Installation

  1. Clone the repo
    git clone https://github.com/your_username_/VDSProject

Installation with CLion

CLion comes with CMake. 2. Open CLion and open VDSProject/CMakeLists.txt as a project. 3. Select your target and build the project.

Installation without CLion

  1. Navigate to the project folder and create a build directory
    cd VDSProject && mkdir build
  2. Navigate to the build folder and invoke CMake
    cd build && cmake ../
  3. Invoke make
    make
  4. To run benchmark run VDSProject_bench executable:
    cd ..
    ./build/src/bench/VDSProject_bench ./benchmarks/iscas85/<benchmark_name>.bench
    
  5. To verify result run VDSProject_verify executable with two arguments: model answer located in ./benchmarks folder and generated answer located in new ./results folder:
    ./build/src/verify/VDSProject_verify ./benchmarks/results/<benchmark_name>/txt/<graph_name>.txt ./results/<benchmark_name>/txt/<graph_name>.txt
    
    

(back to top)

Roadmap

Part-1

  • Set up and maintain a Git repository
  • Use CMake as a build system of the project
  • Verify the code using GTest
  • Set up a Continuous Integration (CI) pipeline with GitHub Actions (Mandatory)
  • Use Doxygen (or a similar tool) to generate documentation for the API. (Optional)

(back to top)

Part-2

  • learning how to identify performance bottlenecks within the code.
  • Analyzing benchmark results.
  • How to overcome bottlenecks.

(back to top)

Part-3

  • Extending the existing implementation by a practical application of BDD. Using BDDs, it is possible to symbolically represent a state-space. This representation allows to check quickly, whether a specific state is within the reachable state space or not.

(back to top)

Contact

Lucas Deutschmann & Philipp Schmitz - eit-vds-cp@rptu.de

Collaborators

  1. Piotr Mikulowski - xal27fes@rptu.de
  2. Adam Firay Gebregziabher - cot71rop@rptu.de
  3. Emanuel Cortez -

(back to top)

Acknowledgments

Thank you Veli Durmuşcan, Shreya Vithal Kulhalli and Osama Omar Youssif Ayoub for the work on this README.md.

You might find helpful links below.

Project Related Resources

Given Task Links

(back to top)

Additional Materials

(back to top)