openprocess 0.12.0__tar.gz → 0.12.2__tar.gz

{openprocess-0.12.0/openprocess.egg-info → openprocess-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openprocess
-Version: 0.12.0
+Version: 0.12.2
 Summary: Process mining, Petri nets and workflows in one open app: every algorithm visible, every result reproducible, every step teachable
 Author: Sam Struthers
 License: MIT
@@ -873,7 +873,11 @@ extra) and *Predict the next activity*. Or start empty.
   and cleared an invoice?) and *Compliance by attribute* (per vendor: cases,
   share that fits, value), with *Case attribute* to keep one category and
   *Bubble chart* to draw it. [examples/bpi2019](examples/bpi2019/README.md)
-  uses them on the BPI Challenge 2019.
+  uses them on the BPI Challenge 2019. *Dotted chart* saves a dotted chart
+  as a figure (the same dots as the log page's tab), and *Who does what*
+  counts each activity per resource;
+  [examples/energy_contracts](examples/energy_contracts/README.md) uses them
+  with the course's miners and checks on the 2AMI10 exam log.
 - **Connections** (at the bottom of the sidebar, or *View ▸ Connections*)
   draws what flows in, OpenProcess and its boxes, what flows out, and the
   optional tools (pandas, numpy, scipy, matplotlib, …) with whether each is

{openprocess-0.12.0 → openprocess-0.12.2}/README.md

@@ -834,7 +834,11 @@ extra) and *Predict the next activity*. Or start empty.
   and cleared an invoice?) and *Compliance by attribute* (per vendor: cases,
   share that fits, value), with *Case attribute* to keep one category and
   *Bubble chart* to draw it. [examples/bpi2019](examples/bpi2019/README.md)
-  uses them on the BPI Challenge 2019.
+  uses them on the BPI Challenge 2019. *Dotted chart* saves a dotted chart
+  as a figure (the same dots as the log page's tab), and *Who does what*
+  counts each activity per resource;
+  [examples/energy_contracts](examples/energy_contracts/README.md) uses them
+  with the course's miners and checks on the 2AMI10 exam log.
 - **Connections** (at the bottom of the sidebar, or *View ▸ Connections*)
   draws what flows in, OpenProcess and its boxes, what flows out, and the
   optional tools (pandas, numpy, scipy, matplotlib, …) with whether each is

{openprocess-0.12.0 → openprocess-0.12.2}/openprocess/__init__.py

@@ -48,7 +48,7 @@ from .sim.simulator import Simulator
 #: The one place the version number is written (pyproject.toml, the update
 #: check and packaging/build.py read it from here).  A release is tagged
 #: "v" + this, e.g. v0.2.0.
-__version__ = "0.12.0"
+__version__ = "0.12.2"
 
 __all__ = [
     "Arc", "BindingElement", "CPNet", "Marking", "Multiset", "Page", "Place",

{openprocess-0.12.0 → openprocess-0.12.2}/openprocess/flow/boxes/measure.py

@@ -5,7 +5,9 @@ the goods receipt?  Did one user record an invoice and also clear it?  How
 compliant is each vendor, and with how much money?  Each box answers one such
 question for every case, in a table (and, where it helps, the cases
 themselves, to analyse further), and works on a large log without building
-its events (:func:`openprocess.mining.cases.cases`).  The BPI Challenge 2019
+its events (:func:`openprocess.mining.cases.cases`).  The dotted chart and
+*Who does what* are the first look at a log: when things happen, and who
+does them.  The BPI Challenge 2019
 analysis in ``examples/bpi2019`` is built from them.
 """
 
@@ -18,10 +20,11 @@ from typing import Literal
 
 from ... import flow
 from ...mining.cases import case_value, cases
+from ...mining.dotted import SORT_MODES, X_MODES, DotSettings, Dots, how_to_read, svg
 from ...mining.log import EventLog
 from ...mining.petrinet import PetriNet
 from ..box import box
-from ..types import Table
+from ..types import Figure, Table
 
 UNITS = {"hours": 3600.0, "days": 86400.0}
 
@@ -192,4 +195,70 @@ def compliance_by(model: PetriNet, log: EventLog, attribute: str = "Vendor",
     return Table(f"Compliance by {attribute}", columns, rows)
 
 
-__all__ = ["RuleResult", "compliance_by", "order_rule", "segregation_of_duties", "time_between"]
+@box(name="Dotted chart", group="Measure")
+def dotted_chart(log: EventLog,
+                 x: Literal["Actual time", "Time since case start", "Relative to case duration (%)",
+                            "Logical: order in log", "Logical: position in case"] = "Actual time",
+                 rows: str = "Case", colour: str = "Activity",
+                 sort: Literal["First event", "Last event", "Duration", "Number of events", "Name"] = "First event",
+                 unit: Literal["Auto", "Seconds", "Minutes", "Hours", "Days", "Weeks"] = "Auto") -> Figure:
+    """Every event as a dot (Song & van der Aalst, 2007): *x* says when, the
+    row what it belongs to, the colour one more attribute; the same dots as
+    the dotted chart in Mine, saved as a figure. Patterns to look for: the
+    arrival rate (the slope of the first dots), batches (vertical lines),
+    waiting (long gaps in a row), and in Time since case start, how long
+    each step takes after the case begins.
+
+    x: when: actual time, time since the case started, the share of the case's duration, or a logical position
+    rows: Case, Activity, Resource, Lifecycle or any event attribute
+    colour: Activity, Resource, Lifecycle, Case, None or any event attribute
+    sort: the order of the rows
+    unit: the time unit of the x axis (Auto: dates and durations)
+    """
+    settings = DotSettings(x_mode=X_MODES.index(x), rows=rows, colour_by=colour, sort=SORT_MODES.index(sort))
+    dots = Dots(log, log.default_classifier(), settings)
+    if not len(dots):
+        raise ValueError(f"{log.name} has no events to draw")
+    if dots.mode != settings.x_mode:
+        flow.note(f"The log has no timestamps, so x is {X_MODES[dots.mode].lower()}")
+    flow.note(f"{len(dots):,} events in {len(dots.row_values):,} rows ({rows}), "
+              f"{len(dots.colour_values):,} colours ({colour})")
+    if dots.mode == 0 and dots.origin is not None:
+        from datetime import timedelta
+        flow.note(f"From {dots.origin:%d %b %Y %H:%M} to "
+                  f"{dots.origin + timedelta(seconds=dots.x_max - dots.x_min):%d %b %Y %H:%M}")
+    title = f"{log.name}: {rows.lower()} by {X_MODES[dots.mode].lower()}, colour by {colour.lower()}"
+    return Figure("Dotted chart", svg=svg(dots, title, unit),
+                  caption=f"{how_to_read(settings, dots.mode)} Colour: {colour}.")
+
+
+@box(name="Who does what", group="Measure")
+def who_does_what(log: EventLog, by: str = "org:resource") -> Table:
+    """How often each activity is done by each value of the event attribute
+    *by* (each resource, say): one row per activity, one column per value,
+    most frequent first. It shows the roles in a process: who only does one
+    step, who does several, and which steps nobody else does.
+
+    by: the event attribute to count by (org:resource, or any other)
+    """
+    counts: dict[str, Counter] = {}
+    totals: Counter = Counter()
+    for case in cases(log, (by,)):
+        for activity, value in zip(case.activities, case.columns[by]):
+            name = "–" if value is None else str(value)
+            counts.setdefault(activity, Counter())[name] += 1
+            totals[name] += 1
+    if not totals or set(totals) == {"–"}:
+        raise ValueError(f"No event of {log.name} has the attribute {by!r}")
+    values = [v for v, _ in totals.most_common()]
+    activities = sorted(counts, key=lambda a: -sum(counts[a].values()))
+    rows = [[a, *[counts[a][v] for v in values], sum(counts[a].values())] for a in activities]
+    for value in values:
+        done = [a for a in activities if counts[a][value]]
+        if len(done) == 1:
+            flow.note(f"{value} only does {done[0]}")
+    return Table(f"Who does what ({by})", ["activity", *values, "events"], rows)
+
+
+__all__ = ["RuleResult", "compliance_by", "dotted_chart", "order_rule", "segregation_of_duties",
+           "time_between", "who_does_what"]

{openprocess-0.12.0 → openprocess-0.12.2}/openprocess/gui/flow/viewers.py

@@ -398,17 +398,10 @@ def result_widget(value, page=None, node=None) -> QWidget:
         if value.note:
             add(label(value.note, "muted", wrap=True))
     elif isinstance(value, Figure):
-        shown = False
+        shown, svg = False, None
         if value.svg:
             try:
-                from PySide6.QtSvgWidgets import QSvgWidget
-                svg = QSvgWidget()
-                svg.load(value.svg.encode("utf-8"))
-                svg.setMinimumHeight(260)
-                svg.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-                size = svg.renderer().defaultSize()
-                if size.width() > 0:
-                    svg.setMaximumHeight(int(min(600, max(260, size.height() * 1.4))))
+                svg = SvgFigure(value.svg)
                 add(svg)
                 shown = True
             except ImportError:
@@ -425,8 +418,11 @@ def result_widget(value, page=None, node=None) -> QWidget:
             add(label("The figure has no SVG or PNG form.", "muted"))
         if value.caption:
             add(label(value.caption, "muted", wrap=True))
+        buttons = [button("Open larger", lambda: open_figure(value, svg))] if value.svg and shown else []
         if page is not None:
-            add(hbox(button("Save as SVG…", lambda: page.save_figure(value)), None))
+            buttons.append(button("Save as SVG…", lambda: page.save_figure(value)))
+        if buttons:
+            add(hbox(*buttons, None))
     elif isinstance(value, Text):
         text = QPlainTextEdit(value.text)
         text.setReadOnly(True)
@@ -1047,3 +1043,75 @@ def status_text(result: Result | None) -> tuple[str, str]:
     if result.status == "blocked":
         return result.message or "Not allowed to run yet", "warning"
     return result.message or "Waiting", "muted"
+
+
+class SvgFigure(QWidget):
+    """An SVG figure drawn at the width it is given and in its own
+    proportions, never stretched: text stays readable and nothing is cut
+    off. Click it to see it at full size."""
+
+    def __init__(self, svg: str, parent=None) -> None:
+        from PySide6.QtSvg import QSvgRenderer
+        super().__init__(parent)
+        self.renderer = QSvgRenderer(svg.encode("utf-8"), self)
+        size = self.renderer.defaultSize()
+        self.ratio = size.height() / size.width() if size.width() > 0 else 0.6
+        self.svg = svg
+        policy = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Preferred)
+        policy.setHeightForWidth(True)
+        self.setSizePolicy(policy)
+        self.setMinimumWidth(200)
+        self.setCursor(Qt.PointingHandCursor)
+        self.setToolTip("Click to see the figure at full size")
+
+    def hasHeightForWidth(self) -> bool:
+        return True
+
+    def heightForWidth(self, width: int) -> int:
+        return max(1, round(width * self.ratio))
+
+    def sizeHint(self):
+        from PySide6.QtCore import QSize
+        size = self.renderer.defaultSize()
+        return QSize(size.width(), size.height()) if size.width() > 0 else QSize(560, 336)
+
+    def paintEvent(self, event) -> None:
+        from PySide6.QtCore import QRectF
+        from PySide6.QtGui import QPainter
+        painter = QPainter(self)
+        painter.setRenderHint(QPainter.Antialiasing)
+        width = min(self.width(), round(self.height() / self.ratio)) if self.ratio else self.width()
+        height = round(width * self.ratio)
+        self.renderer.render(painter, QRectF((self.width() - width) / 2, 0, width, height))
+        painter.end()
+
+    def mouseReleaseEvent(self, event) -> None:
+        if event.button() == Qt.LeftButton:
+            open_figure(None, self)
+        super().mouseReleaseEvent(event)
+
+
+def open_figure(figure, widget: "SvgFigure | None") -> None:
+    """The figure in a window of its own, as large as the screen allows;
+    resizing the window resizes the figure, in proportion."""
+    if widget is None:
+        return
+    window = QDialog(widget.window())
+    window.setWindowTitle(getattr(figure, "name", None) or "Figure")
+    full = SvgFigure(widget.svg)
+    full.setCursor(Qt.ArrowCursor)
+    full.setToolTip("")
+    full.mouseReleaseEvent = lambda event: None
+    full.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+    layout = QVBoxLayout(window)
+    layout.setContentsMargins(12, 12, 12, 12)
+    layout.addWidget(full)
+    size = full.sizeHint()
+    width, height = size.width() + 24, size.height() + 24
+    screen = widget.screen().availableGeometry() if widget.screen() else None
+    if screen is not None:
+        scale = min(1.0, (screen.width() - 80) / width, (screen.height() - 80) / height)
+        width, height = round(width * scale), round(height * scale)
+    window.resize(width, height)
+    window.setAttribute(Qt.WA_DeleteOnClose)
+    window.show()

{openprocess-0.12.0 → openprocess-0.12.2}/openprocess/gui/studio/app.py

@@ -101,6 +101,7 @@ from .workspace import (
     exercise_files, file_kind, file_stem, file_suffix,
     made_by_openprocess, safe_file_name, unique_path,
 )
+from .loading import Loading, LoadingPage
 from .workers import run_in_background
 
 APPLICATION_NAME = "OpenProcess Studio"
@@ -181,6 +182,17 @@ def _same_file(a: Path, b: Path) -> bool:
         return False
 
 
+#: How long a read may take before the loading page shows (a small file never flashes it).
+LOADING_DELAY_MS = 350
+
+
+def _file_size(path: str) -> int:
+    try:
+        return Path(path).stat().st_size
+    except OSError:
+        return 0
+
+
 def _signature(path: str | Path) -> tuple[int, int] | None:
     """(modification time, size) of a file, or None when it is not there."""
     try:
@@ -581,6 +593,12 @@ class StudioWindow(QMainWindow):
         self.connections_page = ConnectionsPage()
         self.connections_page.install_requested.connect(self.install_tool)
         self.content.addWidget(self.connections_page)
+        #: What the main area shows while a file you opened is read (see _start_loading).
+        self.loading_page = LoadingPage()
+        self.loading_page.cancel_requested.connect(self._cancel_loading)
+        self.content.addWidget(self.loading_page)
+        self._loads: dict[str, Loading] = {}
+        self._before_loading = None
         # Above the pages: "a new version is out" (see check_automatically).
         from .updates import UpdateBar
         self.update_bar = UpdateBar()
@@ -1572,8 +1590,7 @@ class StudioWindow(QMainWindow):
             page = ComparePage(document)
             page.tabs.changed.connect(lambda i: self.remembered.__setitem__("compare_tab", i))
         elif isinstance(document, WorkflowDocument):
-            page = WorkflowPage(document, self.library(),
-                                self.workspace.folder if self.workspace is not None else None)
+            page = WorkflowPage(document, self.library(), self._workflow_folder(document))
             page.open_document.connect(lambda doc, source=document: self.add_document(doc, near=source.path))
             page.edit_requested.connect(lambda net, origin, doc=document: self.edit_petri_net(net, origin, doc))
             page.keep_requested.connect(lambda doc=document: self.keep_workflow(doc))
@@ -2527,14 +2544,24 @@ class StudioWindow(QMainWindow):
                         self._rebuild_sidebar()
                         return
                     mapping = dialog.mapping()
-                log = read_csv(path, mapping)
-                self.add_document(LogDocument(log, path=path),
-                                  options={"csv_mapping": asdict(mapping)})
+                self._start_loading(path, "Reading the event log")
+                folder = self._folder_switches
+
+                def csv_loaded(log, mapping=mapping) -> None:
+                    self._finish_loading(path)
+                    if folder != self._folder_switches:
+                        self._opening.discard(self._key(path))
+                        return
+                    self.add_document(LogDocument(log, path=path), options={"csv_mapping": asdict(mapping)})
+
+                run_in_background(lambda: read_csv(path, mapping), csv_loaded,
+                                  lambda message: self._load_failed(path, message, size))
             elif lower.endswith((".xes", ".xes.gz", ".gz")):
-                self.statusBar().showMessage(f"Reading {name}…")
+                loading = self._start_loading(path, "Reading the event log")
                 folder = self._folder_switches
 
                 def loaded(log) -> None:
+                    self._finish_loading(path)
                     if folder != self._folder_switches:
                         # The folder was switched or closed while this was
                         # loading: it belongs to the folder that was left.
@@ -2543,8 +2570,8 @@ class StudioWindow(QMainWindow):
                     self.add_document(LogDocument(log, path=path))
                     self.statusBar().showMessage(f"Opened {name}: {len(log):,} cases", 6000)
 
-                run_in_background(lambda: read_xes(path), loaded,
-                                  lambda message: self._could_not_open(path, message, size))
+                run_in_background(lambda: read_xes(path, progress=loading.report), loaded,
+                                  lambda message: self._load_failed(path, message, size))
             else:
                 QMessageBox.information(self, "Unsupported file",
                                         f"{name}: open .xes, .csv, .pnml or .cpn files (or a "
@@ -2554,6 +2581,61 @@ class StudioWindow(QMainWindow):
         except Exception as error:  # noqa: BLE001 - surface any import problem
             self._could_not_open(path, str(error), size)
 
+    # -- reading a large file: the loading page --------------------------------------------------
+    def _start_loading(self, path: str, title: str) -> Loading:
+        """Start reading ``path`` on a worker.  For a file the user opened (not
+        one reopened with its folder), the main area shows the loading page
+        if the read takes more than a moment, so a large log never leaves the
+        window looking stuck; the window keeps working meanwhile."""
+        key = self._key(path)
+        loading = Loading(path, title, size=_file_size(path))
+        self._loads[key] = loading
+        self.statusBar().showMessage(f"Reading {Path(path).name}…")
+        if key not in self._restore_paths:
+            origin = self.content.currentWidget()
+            QTimer.singleShot(LOADING_DELAY_MS, lambda: self._show_loading(key, origin))
+        return loading
+
+    def _show_loading(self, key: str, origin) -> None:
+        loading = self._loads.get(key)
+        if loading is None or self.in_learn:
+            return                                       # done already, or Learn has the window
+        if self.content.currentWidget() not in (origin, self.loading_page):
+            return                                       # you went to another page meanwhile: stay there
+        if self.content.currentWidget() is not self.loading_page:
+            self._before_loading = self.content.currentWidget()
+        self.loading_page.show_loading(loading)
+        self.content.setCurrentWidget(self.loading_page)
+
+    def _finish_loading(self, path: str) -> None:
+        """The read ended (done, failed or stopped): leave the loading page if it shows this file."""
+        loading = self._loads.pop(self._key(path), None)
+        if loading is None or self.loading_page.loading is not loading:
+            return
+        self.loading_page.stop()
+        self.loading_page.loading = None
+        waiting = next(iter(self._loads.values()), None)
+        if waiting is not None and self.content.currentWidget() is self.loading_page:
+            self.loading_page.show_loading(waiting)       # another file you opened is still coming
+        elif self.content.currentWidget() is self.loading_page:
+            back = self._before_loading
+            self.content.setCurrentWidget(back if back is not None and self.content.indexOf(back) >= 0
+                                          else self.content.widget(0))
+
+    def _cancel_loading(self, path: str) -> None:
+        self.statusBar().showMessage(f"Stopping {Path(path).name}…")
+
+    def _load_failed(self, path: str, message: str, before: tuple | None) -> None:
+        loading = self._loads.get(self._key(path))
+        cancelled = loading is not None and loading.cancelled
+        self._finish_loading(path)
+        if cancelled:
+            self._opening.discard(self._key(path))
+            self._rebuild_sidebar()
+            self.statusBar().showMessage(f"Stopped reading {Path(path).name}", 6000)
+            return
+        self._could_not_open(path, message, before)
+
     def _could_not_open(self, path: str, message: str, before: tuple | None) -> None:
         self._opening.discard(self._key(path))
         self._rebuild_sidebar()
@@ -2762,6 +2844,18 @@ class StudioWindow(QMainWindow):
         self.statusBar().showMessage(f"{document.name} against {Path(path).name}: click Check fit for the "
                                      "scores and how they were computed", 10000)
 
+    def _workflow_folder(self, document) -> str | None:
+        """The folder a workflow's files are relative to: the open folder, or
+        the workflow file's own folder when it was opened from somewhere else
+        (an example double-clicked, a file from a download), as
+        ``openprocess run`` reads it."""
+        folder = self.workspace.folder if self.workspace is not None else None
+        if document.path:
+            own = Path(document.path).resolve().parent
+            if folder is None or not own.is_relative_to(Path(folder).resolve()):
+                return str(own)
+        return folder
+
     def library(self):
         """The boxes available in this window (the folder's boxes/ included)."""
         from ...flow.library import library_for