openprocess 0.7.1__tar.gz → 0.8.0__tar.gz

{openprocess-0.7.1/openprocess.egg-info → openprocess-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openprocess
-Version: 0.7.1
+Version: 0.8.0
 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
@@ -754,19 +754,26 @@ Miner, a fitness check), *Compare discovery* (three miners side by side),
 confidence* (bootstrap intervals, a test and a plot; needs the `science`
 extra) and *Predict the next activity*. Or start empty.
 
-- **Boxes** are listed on the left in groups (Input, Filter, Discover, Check,
-  Compare, Output, Science, Predict, Coloured nets, Sweep, Yours) with a
-  search field. Click one to add it, or double-click the canvas.
+- **The page is the canvas.** Three buttons in its header: **+ Add box**,
+  **Run ▶**, and **⋯** for Re-run, Record, Export experiment and Save.
+- **+ Add box** (or a double-click on the canvas) opens every box, by group:
+  the six core groups side by side (Input, Filter, Discover, Check, Compare,
+  Output) and one line for the rest (Science, Predict, Coloured nets, Sweep,
+  your own boxes) with *Show all*. Type to search them all: "alpha" finds the
+  α-algorithm; Enter adds the first match.
 - **Connect** by dragging from the dot on the right of a box: while you drag,
   only the inputs that take that kind of result light up, so a wrong
   connection cannot be made. Click a wire and press Delete to remove it.
-- **Click a box** for the side panel: **Result** (the net, the log's figures,
-  the table, the figure), **How** (what the box reported: notes, intermediate
-  values, the derivation), **Code** (the box's few lines and, under them, the
-  actual algorithm it calls: the α-algorithm's eight steps, the Inductive
-  Miner's cuts, with the work each follows and *Whole file* for the module)
-  and **Settings** (a control per setting; *Sweep* a number over a range).
-  **⤢** opens the tab in a window of its own.
+- **Click a box** and the side panel appears beside the canvas, on
+  **Result** (the net, the log's figures, the table, the figure; a log's
+  Result has *Open as log ›* for the dotted chart, process map, footprint,
+  variants and cases). Its other tabs: **How** (what the box reported: notes,
+  intermediate values, the derivation), **Code** (the box's few lines and,
+  under them, the actual algorithm it calls: the α-algorithm's eight steps,
+  the Inductive Miner's cuts, with the work each follows and *Whole file* for
+  the module) and **Settings** (a control per setting; *Sweep* a number over
+  a range). **⤢** opens the tab in a window of its own; **✕**, or a click
+  on the canvas, puts the panel away.
 - **Only what changed runs again.** Every box shows a status dot: waiting,
   running, done, failed (the error is on the Result tab; the rest keeps
   working), or waiting for your OK.
@@ -780,16 +787,12 @@ extra) and *Predict the next activity*. Or start empty.
   connections that reach outside; double-click it to open its own canvas,
   ⇧⌘G to ungroup. *Save as a box* in the side panel writes the group to
   `boxes/`, so it is listed under *Yours* and can be used in any workflow.
-- **From a page**: *As a workflow* on a log's Discover tab or a model page,
-  and *Use in a workflow* on the net canvas, open a workflow with that file
-  as its source.
-- **Export experiment** writes a zip with the workflow file and its record,
+- **Export experiment** (under ⋯) writes a zip with the workflow file and its record,
   the inputs, your boxes, every result as a file (CSV, PNML, SVG, XES), a
   `requirements.lock` and a README that says what was run: supplementary
   material for a paper, which `openprocess run --check` can verify.
-- **The three panels** (box list, canvas, side panel) resize by dragging the
-  gaps, hide with *⇤ Boxes* / *Panel ⇥* or the View menu, and come back with
-  *View ▸ Reset Workflow Layout*.
+- **The side panel** resizes by dragging the gap beside it; double-click the
+  gap, or *View ▸ Reset Workflow Layout*, for its default width.
 
 ## Workflows from Python
 

{openprocess-0.7.1 → openprocess-0.8.0}/README.md

@@ -715,19 +715,26 @@ Miner, a fitness check), *Compare discovery* (three miners side by side),
 confidence* (bootstrap intervals, a test and a plot; needs the `science`
 extra) and *Predict the next activity*. Or start empty.
 
-- **Boxes** are listed on the left in groups (Input, Filter, Discover, Check,
-  Compare, Output, Science, Predict, Coloured nets, Sweep, Yours) with a
-  search field. Click one to add it, or double-click the canvas.
+- **The page is the canvas.** Three buttons in its header: **+ Add box**,
+  **Run ▶**, and **⋯** for Re-run, Record, Export experiment and Save.
+- **+ Add box** (or a double-click on the canvas) opens every box, by group:
+  the six core groups side by side (Input, Filter, Discover, Check, Compare,
+  Output) and one line for the rest (Science, Predict, Coloured nets, Sweep,
+  your own boxes) with *Show all*. Type to search them all: "alpha" finds the
+  α-algorithm; Enter adds the first match.
 - **Connect** by dragging from the dot on the right of a box: while you drag,
   only the inputs that take that kind of result light up, so a wrong
   connection cannot be made. Click a wire and press Delete to remove it.
-- **Click a box** for the side panel: **Result** (the net, the log's figures,
-  the table, the figure), **How** (what the box reported: notes, intermediate
-  values, the derivation), **Code** (the box's few lines and, under them, the
-  actual algorithm it calls: the α-algorithm's eight steps, the Inductive
-  Miner's cuts, with the work each follows and *Whole file* for the module)
-  and **Settings** (a control per setting; *Sweep* a number over a range).
-  **⤢** opens the tab in a window of its own.
+- **Click a box** and the side panel appears beside the canvas, on
+  **Result** (the net, the log's figures, the table, the figure; a log's
+  Result has *Open as log ›* for the dotted chart, process map, footprint,
+  variants and cases). Its other tabs: **How** (what the box reported: notes,
+  intermediate values, the derivation), **Code** (the box's few lines and,
+  under them, the actual algorithm it calls: the α-algorithm's eight steps,
+  the Inductive Miner's cuts, with the work each follows and *Whole file* for
+  the module) and **Settings** (a control per setting; *Sweep* a number over
+  a range). **⤢** opens the tab in a window of its own; **✕**, or a click
+  on the canvas, puts the panel away.
 - **Only what changed runs again.** Every box shows a status dot: waiting,
   running, done, failed (the error is on the Result tab; the rest keeps
   working), or waiting for your OK.
@@ -741,16 +748,12 @@ extra) and *Predict the next activity*. Or start empty.
   connections that reach outside; double-click it to open its own canvas,
   ⇧⌘G to ungroup. *Save as a box* in the side panel writes the group to
   `boxes/`, so it is listed under *Yours* and can be used in any workflow.
-- **From a page**: *As a workflow* on a log's Discover tab or a model page,
-  and *Use in a workflow* on the net canvas, open a workflow with that file
-  as its source.
-- **Export experiment** writes a zip with the workflow file and its record,
+- **Export experiment** (under ⋯) writes a zip with the workflow file and its record,
   the inputs, your boxes, every result as a file (CSV, PNML, SVG, XES), a
   `requirements.lock` and a README that says what was run: supplementary
   material for a paper, which `openprocess run --check` can verify.
-- **The three panels** (box list, canvas, side panel) resize by dragging the
-  gaps, hide with *⇤ Boxes* / *Panel ⇥* or the View menu, and come back with
-  *View ▸ Reset Workflow Layout*.
+- **The side panel** resizes by dragging the gap beside it; double-click the
+  gap, or *View ▸ Reset Workflow Layout*, for its default width.
 
 ## Workflows from Python
 

{openprocess-0.7.1 → openprocess-0.8.0}/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.7.1"
+__version__ = "0.8.0"
 
 __all__ = [
     "Arc", "BindingElement", "CPNet", "Marking", "Multiset", "Page", "Place",

{openprocess-0.7.1 → openprocess-0.8.0}/openprocess/flow/library.py

@@ -28,7 +28,8 @@ from typing import Iterable
 
 from .box import Box, BoxError, BoxSpec
 
-#: The modules of the standard library, in the order the box list shows their groups.
+#: The modules of the standard library, in the order *+ Add box* shows their groups
+#: (the first six are the core groups it shows before *Show all*).
 STANDARD_MODULES = ("input", "filter", "discover", "check", "compare", "output",
                     "science", "predict", "cpn", "sweeps")
 GROUP_ORDER = ("Input", "Filter", "Discover", "Check", "Compare", "Output", "Science",

{openprocess-0.7.1 → openprocess-0.8.0}/openprocess/flow/runner.py

@@ -260,6 +260,13 @@ class Runner:
                     values.append(self._fit(value, port))
                     keys.append(upstream.key + ":" + output)
             inputs[port.name] = values if port.many else values[0]
+        # A file not chosen yet (a box just added from the list): wait and say
+        # so, rather than run and fail with a traceback about None.
+        for setting in spec.settings:
+            if setting.kind == "path" and settings.get(setting.name) in (None, ""):
+                result.status = IDLE
+                result.message = f"Choose the {setting.name} in Settings"
+                return result
         result.key = hashlib.sha256(
             (spec.fingerprint + "|" + settings_key(settings) + "|" + "|".join(keys)).encode()).hexdigest()
         cached = self.cache.get(result.key)

{openprocess-0.7.1 → openprocess-0.8.0}/openprocess/flow/workflow.py

@@ -102,7 +102,15 @@ class Workflow:
             title: str = "") -> Node:
         """Put a box on the canvas, with its default settings unless given."""
         spec = self.library.resolve(box)
-        node_id = id or fresh_id()
+        if id is None:
+            # The counter is per process, so a workflow opened from a file (or
+            # made in an earlier session) may already hold the next number:
+            # take the first one it does not.
+            node_id = fresh_id()
+            while node_id in self.nodes:
+                node_id = fresh_id()
+        else:
+            node_id = id
         if node_id in self.nodes:
             raise WorkflowError(f"There is already a box with id {node_id!r}")
         values = spec.defaults()
@@ -188,7 +196,11 @@ class Workflow:
                 raise WorkflowError(f"No box {m!r}")
             if self.group_of(m) is not None:
                 raise WorkflowError("A box can be in one group only")
-        group = Group(id or fresh_id("g"), name, list(members))
+        if id is None:
+            id = fresh_id("g")
+            while id in self.groups:                        # see add(): ids are per process
+                id = fresh_id("g")
+        group = Group(id, name, list(members))
         xs = [self.nodes[m].position[0] for m in members]
         ys = [self.nodes[m].position[1] for m in members]
         group.position = (min(xs), min(ys))
@@ -416,8 +428,8 @@ def record(function: Callable, name: str | None = None, library=None) -> Workflo
 
 class Recorded:
     """A ``@workflow`` function: still callable, with ``.workflow`` drawn on
-    first use.  One with typed parameters is also a *composite box*: in the
-    box list it is one box, on the canvas it can be opened as a group."""
+    first use.  One with typed parameters is also a *composite box*: under
+    *+ Add box* it is one box, on the canvas it can be opened as a group."""
 
     def __init__(self, fn: Callable, name: str | None, group: str) -> None:
         self.fn = fn

openprocess-0.8.0/openprocess/gui/flow/__init__.py

@@ -0,0 +1,9 @@
+"""The Workflows page: the workflow canvas, *+ Add box* and the side panel.
+
+Everything here draws :mod:`openprocess.flow`; nothing in :mod:`openprocess.flow`
+knows about Qt.  ``canvas.py`` is the canvas (boxes, wires, dragging a
+wire from a box to a box), ``picker.py`` is the *+ Add box* popover,
+``viewers.py`` shows a box's result, how it got there, its code and its
+settings, ``page.py`` puts them together with the runner, and
+``templates.py`` holds the ready-made workflows.
+"""