Documentation

Execution Tool

How to use the Execution Tool to run multiple notebooks in sequence, track progress, and insert all outputs into a document automatically.

The Execution Tool is a batch runner for notebooks. Instead of opening each notebook and pressing Run yourself, you build a queue of notebooks, press Run once, and InkRider executes them in order. Outputs are inserted into the document automatically as each notebook finishes.

Open it from the tools panel (the play-queue icon in the add-in header).


Building a Queue

Adding Notebooks

Click the queue builder button (the drawer icon) to open a slide-out panel that lists all notebooks in the virtual filesystem. Click any notebook to add it to the queue. You can also drag notebooks directly from the VFS Explorer into the queue.

The queue builder has a filter box so you can search by name when the filesystem has many files.

Reordering

Drag items in the queue list to reorder them. Notebooks execute in the order shown, top to bottom.

Enabling and Disabling Items

Each queue item has an enable/disable toggle. Disabled items are skipped during the run but stay in the queue so you can re-enable them later. This is useful for temporarily excluding a notebook from a batch without losing its position.

Removing Items

Click the remove button on any queue item to take it out of the queue. This does not delete the notebook from the filesystem.


Running the Queue

Press Run to start execution. InkRider works through the queue from top to bottom, running every cell in each enabled notebook in order.

Controls During a Run

Control Action
Pause Finish the currently running cell and then hold. The queue stays in place.
Resume Continue from where the queue was paused.
Cancel Stop after the current cell and clear the run state. Items already run keep their outputs.

Per-Notebook Progress

Each queue item expands to show per-cell progress: which cells have run, which are currently running, and which are still waiting. A green check marks a completed cell; a red badge marks a failed one.


Run Settings

Open the settings popover (gear icon in the Execution Tool header) to configure run behavior:

Continue on Error

When enabled, InkRider moves to the next cell and continues the run even if a cell throws an exception. The error is recorded in the session log and the failed cell is marked, but the queue does not stop.

When disabled (default), a failing cell halts the entire queue.

Parallel Execution

By default, notebooks run sequentially. Enable Parallel execution to let InkRider run multiple notebooks at the same time (up to the limit of the active runtime, three concurrent sessions for Pyodide and JupyterLite). Parallel runs are faster for independent notebooks that do not share kernel state.

Do not use parallel execution for notebooks that depend on each other (e.g., notebook B imports variables set by notebook A). Run those sequentially.

Auto-Insert Outputs

When enabled, the outputs of cells that have document anchors are inserted into the Word document automatically as each notebook finishes. When disabled, the cells run and outputs are stored in the notebook, but nothing is written to the document, so you insert manually afterward.

Terminate Sessions After Run

When enabled, InkRider closes every kernel session that was created during the batch run once the queue completes. This frees memory. Leave it disabled if you want to inspect variables in a session after the run.


The Session Log

The session log (log icon in the Execution Tool header) is a scrolling view of everything that happened during the run:

  • which notebooks started and finished
  • which cells ran and their execution times
  • error messages and tracebacks
  • auto-insert results (how many anchors were updated)

The log auto-scrolls as new entries arrive. Each entry is color-coded by level: info (white), warning (yellow), error (red). Scroll up to review earlier entries.


Opening a Notebook While Running

Click Open on any queue item to open that notebook in an editor tab while it is running. You can watch the cell execution states update in real time. This is read-only during the run, and you cannot edit cells while a batch run is in progress.


Typical Workflow

  1. Open the Execution Tool.
  2. Open the queue builder and add the notebooks you want to run.
  3. Set Auto-insert outputs to enabled if you want results in the document.
  4. Set Continue on error based on how you want failures handled.
  5. Press Run.
  6. Watch progress in the queue list and session log.
  7. When the run completes, review the document; anchored cells will have updated output.