pm4py/docs/source/index.rst

Welcome to pm4py's Documentation!
===================================

``pm4py`` is a Python library implementing a variety of `process mining <https://en.wikipedia.org/wiki/Process_mining>`_ algorithms.

A simple example of ``pm4py`` in action:

.. code-block:: python

   import pm4py

   if __name__ == "__main__":
       log = pm4py.read_xes('<path-to-xes-log-file.xes>')
       process_model = pm4py.discover_bpmn_inductive(log)
       pm4py.view_bpmn(process_model)
					
In this documentation, you can find all relevant information to set up ``pm4py`` and start your process mining journey. 
Please consult the Contents listed below to navigate the documentation.

Happy #processmining!


Contents
--------

.. toctree::
   :maxdepth: 2

   install
   getting_started
   api
   release_notes