Skip to content

Commit 722ef22

Browse files
fix readme
1 parent f158f15 commit 722ef22

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,23 @@ The documentation of PM4Py can be found at https://processintelligence.solutions
2323

2424
Here is a simple example to spark your interest:
2525

26+
```python
2627
import pm4py
2728

2829
if __name__ == "__main__":
2930
log = pm4py.read_xes('<path-to-xes-log-file.xes>')
3031
net, initial_marking, final_marking = pm4py.discover_petri_net_inductive(log)
3132
pm4py.view_petri_net(net, initial_marking, final_marking, format="svg")
33+
```
3234

3335
## Installation
3436
PM4Py can be installed on Python 3.9.x / 3.10.x / 3.11.x / 3.12.x / 3.13.x / 3.14.x by invoking:
3537

36-
pip install -U pm4py
38+
`pip install -U pm4py`
3739

3840
PM4Py is also running on older Python environments with different requirements sets, including:
3941

40-
- Python 3.8 (3.8.10): third_party/old_python_deps/requirements_py38.txt
42+
- Python 3.8 (3.8.10): `third_party/old_python_deps/requirements_py38.txt`
4143

4244
## Requirements
4345

@@ -51,13 +53,13 @@ PM4Py depends on some other Python packages, with different levels of importance
5153

5254
## Release Notes
5355

54-
To track the incremental updates, please refer to the CHANGELOG.md file.
56+
To track the incremental updates, please refer to the `CHANGELOG.md` file.
5557

5658
## Third Party Dependencies
5759

5860
As scientific library in the Python ecosystem, we rely on external libraries to offer our features.
59-
In the /third_party folder, we list all the licenses of our direct dependencies.
60-
Please check the /third_party/LICENSES_TRANSITIVE file to get a full list of all transitive dependencies and the
61+
In the `/third_party` folder, we list all the licenses of our direct dependencies.
62+
Please check the `/third_party/LICENSES_TRANSITIVE` file to get a full list of all transitive dependencies and the
6163
corresponding license.
6264

6365
## Citing PM4Py
@@ -71,6 +73,7 @@ If you are using PM4Py in your scientific work, please cite PM4Py as follows:
7173

7274
BiBTeX:
7375

76+
```bibtex
7477
@article{pm4py,
7578
title = {PM4Py: A process mining library for Python},
7679
journal = {Software Impacts},
@@ -82,6 +85,7 @@ doi = {https://doi.org/10.1016/j.simpa.2023.100556},
8285
url = {https://www.sciencedirect.com/science/article/pii/S2665963823000933},
8386
author = {Alessandro Berti and Sebastiaan van Zelst and Daniel Schuster},
8487
}
88+
```
8589

8690
## Legal Notice
8791

0 commit comments

Comments
 (0)