Documentation
Rust4PM is written in Rust and exposes its functions to Python, the command line and Propel through one binding system. The guides below get you set up, and the reference lists every function.
Get started
Apps
Concepts
- Event data typesRust4PM has five data types for event data. Which one a function needs depends on whether the data is case-centric or object-centric, and on how it is accessed.
- Item registry (Python)In Python, event logs, OCELs and other large items stay in Rust memory, and Python holds handles to them. This page explains how to create, use, export and free these items.
- File formatsThe file extension decides the format, for import and export alike. This page lists which formats each data type supports.
- Installation and featuresHow to install Rust4PM for Python, the command line and Rust, and which optional features exist.
- Progress, cancellation and threadsHow to follow the progress of long-running calls, cancel them, and control how many threads they use, in Python and Rust.
How do I...
- Discover a process modelTurn an event log into a directly-follows graph or a Petri net with the Inductive Miner or Alpha+++, and export or draw the model.
- Check conformanceMeasure how well a Petri net explains an event log with alignments, and how much of the model's behavior the log backs up with escaping-edges precision.
- Analyze object-centric dataDirectly-follows graphs per object type, object-centric Petri nets and OC-DECLARE constraints on an OCEL 2.0 log, without flattening it first.
- Flatten logs and explore variantsTurn an OCEL into a classic event log for one object type, and list the most frequent trace variants of a log.
- Convert between formatsRead a log in one format and write it in another, with the format chosen by the file extension.
- Use Rust4PM with PM4PyExchange event data and Petri nets between Rust4PM and PM4Py, and check the conformance of PM4Py nets with Rust4PM.
- Visualize modelsDraw Petri nets, process trees, DFGs and object-centric models as SVG images, in a notebook or as files.
Reference
Modules
core10 functions, 2 submodulesevent_data / process_modelsconformance8 functions, 2 submodulescase_centric / object_centricanalysis10 functions, 2 submodulesobject_centric / case_centricvisualization46 functions, 3 submodulesbindings / engine / oc_declarediscovery11 functions, 2 submodulescase_centric / object_centricbindings64 functions, 5 submodulesextraction_dbcon_bindings / extraction_bindings / slim_ocel_bindings / path_schema_bindings / reflow_bindings
Popular functions
- add_init_exit_events_to_ocelcore::event_data::object_centric::utils::init_exit_events
- flatten_ocel_oncore::event_data::object_centric::utils::flatten
- stream_ocel_file_to_duckdbcore::event_data::object_centric::ocel_sql::duckdb::schema::stream
- write_ocel_to_duckdbcore::event_data::object_centric::ocel_sql::duckdb::schema::stream
- get_projection_activitiescore::event_data::case_centric::utils::activity_projection
- get_top_n_variantscore::event_data::case_centric::utils::activity_projection

