zhoudaxia233 / pyalpha

A process mining tool written in Python3

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pyalpha

A process mining tool written in Python3.

It generates a Petri net using the Alpha Algorithm from event logs.


Requirements

  1. Python3
  2. pip
  3. graphviz-2.38 (Only this version has been tested, other versions may also work).

On Ubuntu, simply type sudo apt install graphviz, and it will work!

On Windows, you may need this link Graphviz 2.38 Stable Release. Also, you need to add graphviz to your SYSTEM PATH. Just add the /bin/ folder is enough.


Installation

Install pyalpha:

sudo pip3 install pyalpha

Developing

Install pyalpha for development:

python3 setup.py develop

Usage

How to use pyalpha?

pyalpha name-of-your-file-which-contains-event-logs.txt  # e.g. tests/test0.txt

By default, it generates a dot file, a png file shows the Petri Net and a txt file describing the footprint.

How to run unit tests?

e.g. If you want to run unit tests of alpha_test.py, just type the command below:

python3 -m unittest tests.alpha_test

How can I use my custom event logs?

Please take a look at .txt files in folder tests/. Just follow the same style.

About

A process mining tool written in Python3

License:MIT License


Languages

Language:Python 100.0%