Skip to content

Commit

Permalink
Merge branch '145-improving-formatting-of-readme-md' into 'hotfixes'
Browse files Browse the repository at this point in the history
improving README.md

See merge request process-mining/pm4py/pm4py-core!1099
  • Loading branch information
fit-alessandro-berti committed Aug 28, 2023
2 parents 6e3f18b + 3cc7ec2 commit 750e4ea
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ The full documentation of pm4py can be found at https://pm4py.fit.fraunhofer.de
## First Example
A very simple example, to whet your appetite:

```python
import pm4py

if __name__ == "__main__":
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(net, initial_marking, final_marking, format="svg")
```

## Installation
pm4py can be installed on Python 3.8.x / 3.9.x / 3.10.x / 3.11.x by invoking:
Expand All @@ -41,6 +43,7 @@ If you are using pm4py in your scientific work, please cite pm4py as follows:

BiBTeX:

```bibtex
@article{pm4py,
title = {PM4Py: A process mining library for Python},
journal = {Software Impacts},
Expand All @@ -52,4 +55,5 @@ doi = {https://doi.org/10.1016/j.simpa.2023.100556},
url = {https://www.sciencedirect.com/science/article/pii/S2665963823000933},
author = {Alessandro Berti and Sebastiaan van Zelst and Daniel Schuster},
}
```

0 comments on commit 750e4ea

Please sign in to comment.