/Desbordante

Primary LanguageC++GNU General Public License v3.0GPL-3.0

https://github.com/cupertank implemented essential data structures presented in src/model, src/parser, src/tests and src/util

Installation guide

  • Ubuntu

    The following instructions were tested on Ubuntu 18.04.4 LTS.

    Dependencies

    Prior to cloning the repository and attempting to build the project, ensure that you have the following software:

    • GNU g++ compiler, version 10+
    • CMake, version 3.10+
    • Boost library, version 1.72.0+

    Building the project

    Firstly, navigate to a desired directory. Then, clone the repository, cd into the project directory and launch the build script:

    git clone https://github.com/Mstrutov/Desbordante/
cd Desbordante
./build.sh

    Launching the binaries

    The script generates the following file structure in /path/to/Desbordante/build/target:

    ├───inputData
│   └───some-sample-csv's.csv
├───Desbordante_test
├───Desbordante_run

    The inputData directory contains several .csv files that may be used by Desbordante_test. Run Desbordante_test to perform unit testing:

    cd build/target
./Desbordante_test

    The tool itself is launched via the following line:

    ./Desbordante_run --algo=tane --data=<dataset_name>.csv

    The <dataset_name>.csv, which is a user-provided dataset, should be placed in the /path/to/Desbordante/build/target directory.

  • Windows

    The following instructions were tested on Windows 10 .

    Dependencies

    Prior to cloning the repository and attempting to build the project, ensure that you have the following software:

    • Microsoft Visual Studio 2019
    • CMake, version 3.10+
    • Boost library, version 1.65.1+
      The recommended way to install Boost is by using chocolatey

    Building the project

    Firstly, launch the command prompt and navigate to a desired directory. Then, clone the repository, cd into the project directory and launch the build script:

    git clone https://github.com/Mstrutov/Desbordante/
cd Desbordante
build.bat

    Note: to compile the project, the script uses hard-coded path to MSVC developer command prompt, which is located by default at C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsDevCmd.bat. You should change the path in the script if it differs from the default one.

    Launching the binaries

    The script generates the following file structure in \path\to\Desbordante\build\target:

    ├───inputData
│   └───some-sample-csv's.csv
├───Desbordante_test.exe
├───Desbordante_run.exe

    The inputData directory contains several .csv files that may be used by Desbordante_test. Run Desbordante_test to perform unit testing:

    cd build\target
Desbordante_test.exe

    The tool itself is launched via the following line:

    Desbordante_run.exe --algo=tane --data=<dataset_name>.csv

    The <dataset_name>.csv, which is a user-provided dataset, should be placed in the \path\to\Desbordante\build\target directory.

Developers

Alexandr Smirnov — DFD implementation

Ilya Shchuckin — FD_Mine implementation

Michael Polyntsov — FastFDs implementation

Ilya Vologin — core classes

Maxim Strutovsky — team lead, Pyro & TANE implementation

Nikita Bobrov — product owner, consult, papers

Kirill Smirnov — product owner, code quality, infrastructure, consult

George Chernishev — product owner, consult, papers

Cite

If you use this software for research, please cite the paper (https://fruct.org/publications/fruct29/files/Strut.pdf, https://ieeexplore.ieee.org/document/9435469) as follows:

M. Strutovskiy, N. Bobrov, K. Smirnov and G. Chernishev, "Desbordante: a Framework for Exploring Limits of Dependency Discovery Algorithms," 2021 29th Conference of Open Innovations Association (FRUCT), 2021, pp. 344-354, doi: 10.23919/FRUCT52173.2021.9435469.

Contacts

Email me at strutovksy.m.a@gmail.com