Skip to main content

PM4Py

PM4Py is a python library that supports state-of-the-art process mining algorithms in Python. It is open source and intended to be used in both academia and industry projects.

PM4Py is managed and developed by PIS — Process Intelligence Solutions (https://processintelligence.solutions/), a spin-off from the Fraunhofer Institute for Applied Information Technology FIT where PM4Py was initially developed.

Licensing

The open-source version of PM4Py, available on GitHub (https://github.com/process-intelligence-solutions/pm4py), is licensed under the GNU Affero General Public License version 3 (AGPL-3.0).

We offer a separate version of PM4Py for commercial use in closed-source environments under a different license. For more information about the licensing options for using PM4Py in closed-source settings, please visit https://processintelligence.solutions/pm4py#licensing.

Documentation / API

The documentation of PM4Py can be found at https://processintelligence.solutions/pm4py/.

First Example

Here is a simple example to spark your interest:

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.9.x / 3.10.x / 3.11.x / 3.12.x / 3.13.x / 3.14.x by invoking:

pip install -U pm4py

Optional features can be installed through extras. For example:

pip install -U "pm4py[polars,ml]"

Use pip install -U "pm4py[all]" to install every optional feature supported on the current platform.

For a reproducible installation using the exact dependency versions validated by the project, use:

pip install -U "pm4py[stable]"

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

  • Python 3.8 (3.8.10): third_party/old_python_deps/requirements_py38.txt

Requirements

The default installation contains the dependencies needed for mainstream usage. Additional integrations are grouped by feature in pyproject.toml:

  • calendars: workalendar
  • connectors: requests
  • llm: openai and requests
  • ml: pyemd and scikit-learn
  • ocel: jsonschema and pyarrow
  • polars: Polars dataframe support
  • solvers: cvxopt
  • stable: the exact dependency versions validated by the project and used by CI
  • visualization: pyvis
  • windows: pygetwindow, pynput, and pywin32 (Windows only)

For a source checkout, install the project with python -m pip install -e .. Build, CI, and lint dependencies are standard dependency groups and can be installed with, for example, python -m pip install --group lint.

For optional PuLP support, PM4Py selects the backend for the installed PuLP version (3.x or 4.x). PuLP 4 requires CBC to be installed separately: use python -m pip install 'pulp[cbc]' or put cbc on PATH. SciPy remains the default LP solver.

Release Notes

To track the incremental updates, please refer to the CHANGELOG.md file.

Contributing

If you want to contribute to PM4Py, please review the contributing guidelines and Contributor License Agreement (CLA).

Third Party Dependencies

As scientific library in the Python ecosystem, we rely on external libraries to offer our features. In the /third_party folder, we list all the licenses of our direct dependencies. Please check the /third_party/LICENSES_TRANSITIVE file to get a full list of all transitive dependencies and the corresponding license.

Citing PM4Py

If you are using PM4Py in your scientific work, please cite PM4Py as follows:

Alessandro Berti, Sebastiaan van Zelst, Daniel Schuster. (2023). PM4Py: A process mining library for Python. Software Impacts, 17, 100556. doi: 10.1016/j.simpa.2023.100556

DOI | Article Link

BiBTeX:

@article{pm4py,  
title = {PM4Py: A process mining library for Python},  
journal = {Software Impacts},  
volume = {17},  
pages = {100556},  
year = {2023},  
issn = {2665-9638},  
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},  
}

This repository is managed by Process Intelligence Solutions (PIS). Further information about PIS can be found online at https://processintelligence.solutions.

Metadata

Release files for pm4py 2.7.23.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pm4py 2.7.23.9
File Size Uploaded
pm4py-2.7.23.9.tar.gz 1.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pm4py 2.7.23.9
File Interpreter ABI Platform
pm4py-2.7.23.9-py3-none-any.whl Python 3 none any Details

Total release size: 3.9 MB

Release files / pm4py-2.7.23.9.tar.gz

Download URL pm4py-2.7.23.9.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
4215d570a3a1aa75cabfdb146cbc59a5c6d768b38f7f407d60f45e1ff561ffc2
BLAKE2b-256 checksum
How to use checksums
a319fceef81e71d01e908fa4544b92efcf6c55245eb5a01a46849e5ad211eca9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / pm4py-2.7.23.9-py3-none-any.whl

Download URL pm4py-2.7.23.9-py3-none-any.whl
Size 2.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
dba8f49464e57402a85ef20024e828bcef64fc7f4fa5516365001781b751085e
BLAKE2b-256 checksum
How to use checksums
2cdd190673ad5360353a93aa634feb214707e1d77030bae06adbb71579e2f8cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

2.7.23.9 This release

2 release files

2.7.23

2 release files

2.7.22

2 release files

2.7.21

2 release files

2.7.20

2 release files

2.7.18

2 release files

2.7.17

2 release files

2.7.16

2 release files

2.7.15

2 release files

2.7.14

2 release files

2.7.13

2 release files

2.7.11

2 release files

2.7.8

2 release files

2.7.7

2 release files

2.7.6

2 release files

2.7.5

2 release files

2.7.4

2 release files

2.7.3

2 release files

2.7.2

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.3

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.4

2 release files

2.3.3

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.32

2 release files

2.2.30

2 release files

2.2.29

2 release files

2.2.27

2 release files

2.2.25

2 release files

2.2.24

2 release files

2.2.23

2 release files

2.2.22

2 release files

2.2.21

2 release files

2.2.19

2 release files

2.2.17

2 release files

2.2.16

2 release files

2.2.15

2 release files

2.2.12

2 release files

2.2.9

2 release files

2.2.8

2 release files

2.2.7

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.4

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.13

2 release files

1.2.12

2 release files

1.2.11

2 release files

1.2.10

2 release files

1.2.9

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.28

2 release files

1.1.27

2 release files

1.1.26

2 release files

1.1.25

2 release files

1.1.23

2 release files

1.1.22

2 release files

1.1.21

2 release files

1.1.18

2 release files

1.1.17

2 release files

1.1.16

2 release files

1.1.15

2 release files

1.1.13

2 release files

1.1.12

2 release files

1.1.11

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.25

2 release files

1.0.24

2 release files

1.0.23

2 release files

1.0.20

2 release files

1.0.19

2 release files

1.0.17

2 release files

1.0.16

2 release files

1.0.13

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.1.1

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page