pm4py-ucm 0.7.10__py3-none-any.whl

pm4py_ucm/__init__.py

@@ -0,0 +1,77 @@
+"""``pm4py-ucm`` — Use Case Map (URN/UCM) extension for PM4Py.
+
+This package adds first-class support for the Use Case Map modelling
+notation — part of the ITU-T Z.151 *User Requirements Notation* (URN)
+standard and supported by the open-source jUCMNav tool — to PM4Py-style
+process-mining workflows.
+
+The high-level API mirrors PM4Py's BPMN helpers; see :mod:`pm4py_ucm.api`
+for the details. The most common entry points are re-exported here::
+
+    import pm4py
+    import pm4py_ucm
+
+    log = pm4py.read_xes("log.xes")
+    ucm = pm4py_ucm.discover_ucm_inductive(log)
+    pm4py_ucm.write_ucm(ucm, "log.jucm")
+"""
+
+from .api import (
+    read_ucm,
+    write_ucm,
+    discover_ucm_inductive,
+    discover_resources,
+    discover_components,
+    bind_performers,
+    convert_to_ucm,
+    view_ucm,
+    save_vis_ucm,
+    discover_scenarios,
+    write_variants_report,
+    write_case_variant_map,
+    write_condition_mining_report,
+    discover_ucm_family,
+    rank_partition_attributes,
+    write_ucm_family,
+    assemble_ucm_family,
+    save_vis_ucm_family,
+    view_ucm_family,
+    compute_family_stats,
+    write_family_report,
+    annotate_performance,
+    compute_traversal_stats,
+    suggest_decomposition,
+    suggest_loop_iterations,
+)
+from .objects.ucm.obj import UCM
+
+__all__ = [
+    "UCM",
+    "read_ucm",
+    "write_ucm",
+    "discover_ucm_inductive",
+    "discover_resources",
+    "discover_components",
+    "bind_performers",
+    "convert_to_ucm",
+    "view_ucm",
+    "save_vis_ucm",
+    "discover_scenarios",
+    "write_variants_report",
+    "write_case_variant_map",
+    "write_condition_mining_report",
+    "discover_ucm_family",
+    "write_ucm_family",
+    "assemble_ucm_family",
+    "save_vis_ucm_family",
+    "view_ucm_family",
+    "compute_family_stats",
+    "write_family_report",
+    "annotate_performance",
+    "compute_traversal_stats",
+    "suggest_decomposition",
+    "suggest_loop_iterations",
+    "rank_partition_attributes",
+]
+
+__version__ = "0.7.10"

pm4py_ucm/algo/dashboards/__init__.py

@@ -0,0 +1,77 @@
+"""User-defined dashboards over an event log.
+
+A dashboard is an ordered list of *widget specs* plus a dashboard-level
+filter. A widget spec — the core artifact, serialised as JSON — names a
+catalog metric, its parameters, an aggregation, a filter, segmentation
+axes, a visualisation and an optional target::
+
+    {
+      "id": "w1", "title": "avg Send Fine → Payment",
+      "metric": "timeBetween",
+      "params": {"from": "Send Fine", "to": "Payment"},
+      "agg": "avg",
+      "filter": [{"field": "attr:amount", "op": ">", "value": 100}],
+      "segment": {"rows": "resource", "cols": "quarter"},
+      "viz": "table",
+      "target": {"on": true, "dir": "<=", "value": 14, "warn": 18,
+                 "mode": "aggregate"}
+    }
+
+Modules:
+
+* :mod:`.contract` — the per-case fact table shipped to the client;
+* :mod:`.catalog` — what a widget can measure;
+* :mod:`.engine` — per-case values, filters, segmentation, aggregation,
+  targets and widget computation;
+* :mod:`.view` — assembles the self-contained HTML artifact that serves
+  as *both* the app's Dashboards view and the exported report.
+
+The engine exists twice: here, and in JS (``web/assets/dash-engine.js``)
+for the browser and the self-contained HTML export. Both read the same
+:mod:`.contract` payload and return the same widget structure. The pair
+is pinned by a parity test rather than by good intentions — see
+``tests/test_dashboards.py``.
+"""
+
+from .contract import (  # noqa: F401
+    CONTRACT_VERSION,
+    CaseAttribute,
+    FactTable,
+    NumericBin,
+    build_fact_table,
+)
+from .catalog import (  # noqa: F401
+    CATALOG,
+    BY_ID,
+    MetricSpec,
+    Param,
+    catalog_json,
+)
+from .view import (  # noqa: F401
+    bundle_script,
+    dashboard_html,
+    write_dashboard,
+)
+from .formula import (  # noqa: F401
+    FUNCTIONS,
+    FormulaError,
+    compile_formula,
+    parse as parse_formula,
+    result_type,
+)
+from .engine import (  # noqa: F401
+    AGGS,
+    STATE_UI,
+    aggregate,
+    apply_filters,
+    compute_widget,
+    fmt,
+    per_case_values,
+    predicate_case_ids,
+    scorecard,
+    segment_axes,
+    segment_keys,
+    series_values,
+    target_state,
+    worst_state,
+)