FuzzyMiner

<h1 align="center">Fuzzy Miner</h1> <div align="center"> <strong>A fuzzy miner web application by which you can generate process models as per your requirements. Import a <a href="http://xes-standard.org/" target="_blank">XES</a> log file and just wait for the miner to generate the process model. The metrics and the filters are at your disposal and can be modified as per your requirements. The project is based on this <a href="https://www.researchgate.net/publication/221586306_Fuzzy_Mining_-_Adaptive_Process_Simplification_Based_on_Multi-perspective_Metrics" target="_blank">paper</a>. </strong> </div> <div align="center">

<br>

<!-- Stability --> <a href="https://nodejs.org/api/documentation.html#documentation_stability_index"> <img src="https://img.shields.io/badge/stability-stable-orange.svg?style=flat-square" alt="API stability" /> </a> <a href="https://github.com/fnc11/FuzzyMiner/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/fnc11/FuzzyMiner"></a> <!-- Standard --> <a href="https://standardjs.com"> <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square" alt="Standard" /> </a>

</div> <div align="center">

<br><br>

</div>

Table of Contents

1. Features
2. Technology used
3. Installation
   • Docker Way
     • Requirements
     • Running the project
   • Traditional Way
     • Requirements
       • Windows
       • MacOS
       • Linux
     • Running the project
4. How to use
5. Contributors
6. Credits
7. Reference
8. License

Features

(Back to top)

• Easy to use: our package makes it easy for generating process models for unstructured data
• User friendly UI: clean and simple UI
• Fast: Can handle large log files. Well in case of too large, you need to wait a bit!

Technology used

(Back to top)

<b>Built with</b>

• Python
• Django
• Vue JS
• Element

<b>Tested with</b>

• PyUnit

Installation

Docker Way

(Back to top)<br> Note: First change the branch to docker branch, if you want to checkout the project the docker way.

Docker Requirements

Only requirements is to install Docker on your system from here Docker.

Docker Running

1. For first time you need the below command. It will take around 10-15 mins to build the image and start the container.

docker-compose up

2. If there was some error and you need to run the command again, then use the below one. As it will proceed from the last successful point.

docker-compose up --build

3. Now the server inside the container is configured to run on your IP address. So if you have wired network connection then find the value of eth0 or if you are connected via WiFi then find the value of wlo1. These could be different for your system, the goal is to find the IP address. Use the below command, this is one way of knowing IP address on Linux/MacOS. For Windows you need to check network setting of your connection.

ifconfig

4. Once you have that IP address, type it in the browser and you should see the home page of the application.
5. If you already ran the application successfully once and you want to just use it, then use the below two commands to start and stop the container.

docker-compose start
docker-compose stop

Traditional Way

(Back to top)

Traditional Requirements

Windows

1. Install Python from here. <br> <br> Four Python 3.6 installers are available for download - two each for the 32-bit and 64-bit versions of the interpreter. The web installer is a small initial download, and it will automatically download the required components as necessary.<br> After starting the installer, one of two options may be selected:<br> <b>If you select “Install Now”:</b>

• You will not need to be an administrator (unless a system update for the C Runtime Library is required or you install the Python Launcher for Windows for all users)
• Python will be installed into your user directory
• The Python Launcher for Windows will be installed according to the option at the bottom of the first page
• The standard library, test suite, launcher and pip will be installed
• If selected, the install directory will be added to your PATH
• Shortcuts will only be visible for the current user<br><br> <b>Selecting “Customize installation” will allow you to select the features to install, the installation location and other options or post-install actions. To install debugging symbols or binaries, you will need to use this option.</b><br><br>
• To perform an all-users installation, you should select “Customize installation”. In this case:
• You may be required to provide administrative credentials or approval
• Python will be installed into the Program Files directory
• The Python Launcher for Windows will be installed into the Windows directory
• Optional features may be selected during installation
• The standard library can be pre-compiled to bytecode
• If selected, the install directory will be added to the system PATH
• Shortcuts are available for all users <br>

2. Install Node.js from here. <br> <br> The node package manager (npm) will also be installed with NodeJS and is required for project.<br>

3. Install virtualenv

pip install virtualenv

MacOS

1. Install homebrew

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

2. Install python

brew install python

3. Install pip

curl -O http://python-distribute.org/distribute_setup.py
python distribute_setup.py
curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
python get-pip.py

4. Install virtualenv

pip install virtualenv

5. Install nodejs and npm

brew update
brew install node

Linux

1. Python3 comes preinstalled in Ubuntu 18.04 and 20.04 so no need to separately do anything, however you may need to update it, for that follow below commands:

sudo apt update
sudo apt -y upgrade

2. To install virtualenv pacakge do the following:

sudo apt-get install python3-venv

3. Install nodejs related packages.

sudo apt-get install nodejs
sudo apt-get install npm

(If there are errors install this first sudo apt-get install nodejs-dev node-gyp libssl1.0-dev and then retry installing npm.)

Traditional Running

1. Clone the repository:

git clone URL

2. Create a virtual environment inside this package. For windows use the below command:

virtualenv mypython

In case of MacOS/Linux use the following command to create virtual environment:

python3 -m venv mypython

3. Activate the virtual environment

Windows command

mypthon\Scripts\activate

MacOS/Linux command

source mypython/bin/activate

4. Assuming you have virtual environment inside the project, activate it and install necessary softwares by running following command.

pip install -r requirements.txt 

Note: (For Windows only) There can be some errors while installing Levenstein library, either you can change the code to calculate Edit Distance otherwise you need to install or upgrade Microsoft C++ Build Tools. To do that please head over to here. <br>

5. Go to /miner-web folder and run the following

npm install
npm run build

6. Change FuzzyMiner/FuzzyMiner/settings.py.example to settings.py
7. Run the script secret.py

python3 secret.py

8. Copy the displayed key in previous step and paste it in as value for SECRET_KEY variable in the settings.py file
9. Run the following command after navigating to FuzzyMiner/FuzzyMiner

python3 manage.py runserver

How to use?

(Back to top)

Please refer to the <b>Help</b> page of the web application when you run it.

Contributors

(Back to top)

Built with ❤ by:

• Praveen Yadav
• Pruthvi Hegde
• Prantik Chatterjee
• Iftekhar Ahmed
• Yongzhao Li

Reference

(Back to top)

• PADS Chair of RWTH Aachen University
• This project is based on Business Process Management: 5th International Conference, BPM 2007, Brisbane, Australia, September 24-28, 2007. Proceedings

License

(Back to top)

The Fuzzy Miner Web Application is released under the under terms of the Apache License V2.0.