Skip to content

Commit

Permalink
Merge branch 'heads/github/release' into github-release
Browse files Browse the repository at this point in the history
# Conflicts:
#	pm4py/visualization/heuristics_net/variants/__init__.py
  • Loading branch information
fit-sebastiaan-van-zelst committed Jan 25, 2022
2 parents e4eab40 + 30b8f0d commit 466f74e
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# PM4Py
PM4Py is a python library that supports (state-of-the-art) process mining algorithms in python.
It is completely open source and intended to be used in both academia and industry projects.
PM4Py is a python library that supports (state-of-the-art) process mining algorithms in python. It is completely open source and intended to be used in both academia and industry projects.
PM4Py is a product of the Fraunhofer Institute for Applied Information Technology.

## Documentation / API
Full documentation of PM4Py is available at http://pm4py.org/
The documentation about PM4Py is offered at http://pm4py.org/

## First Example
A very simple example, to whet your appetite:

```python
import pm4py

log = pm4py.read_xes('<path_to_xes_file>')
process_model = pm4py.discover_bpmn_inductive(log)
pm4py.view_bpmn(process_model)
```
log = pm4py.read_xes('<path-to-xes-log-file.xes>')

net, initial_marking, final_marking = pm4py.discover_petri_net_inductive(log)

pm4py.view_petri_net(pnet, initial_marking, final_marking, format="svg")

## Installation
PM4Py can be installed on Python 3.7.x / 3.8.x / 3.9.x by doing:
`pip install -U pm4py`
*pip install -U pm4py*

## Change Log
We track all changes in our [*CHANGELOG*](https://github.com/pm4py/pm4py-core/blob/release/CHANGELOG.md) file.
## Release Notes
To track the incremental updates, we offer a *RELEASE_NOTES* file.

## Third Party Dependencies
As scientific library in the Python ecosystem, we rely on external libraries to offer our features.
Expand Down

0 comments on commit 466f74e

Please sign in to comment.