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 and OCELs stay in Rust memory and are referred to by string IDs. 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.
How do I...
- Discover a process modelTurn an event log into a directly-follows graph or a Petri net, and export the model for other tools.
- Check conformanceMeasure how well a Petri net explains an event log with alignments, and find the behavior it does not cover.
- Analyze object-centric dataDirectly-follows graphs per object type 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. The file extensions do all the work.
- Use Rust4PM with PM4PyRead event data with Rust4PM and analyze it with PM4Py, using DataFrames and PM4Py's own OCEL objects.
Reference
Modules
discovery7 functions, 2 submodulesobject_centric / case_centriccore22 functions, 2 submodulesevent_data / process_modelsanalysis7 functions, 2 submodulescase_centric / object_centricconformance5 functions, 2 submodulescase_centric / object_centricbindings56 functions, 2 submodulesslim_ocel_bindings / path_schema_bindings
Popular functions
- project_oc_arcsdiscovery::object_centric::oc_declare
- reduce_oc_arcsdiscovery::object_centric::oc_declare
- discover_oc_declarediscovery::object_centric::oc_declare
- get_variants_of_object_typediscovery::object_centric::variants
- get_dfg_of_object_typediscovery::object_centric::dfg
- discover_dfgdiscovery::case_centric::dfg