Examples - quickstart

Purpose

Minimal end-to-end examples for first-time users, mirroring notebooks/beginner/ in code form.

Scope

Example scripts and their direct documentation. No test code, no package implementation.

Responsibilities

• House quickstart usage examples.

Contents

• 01_five_minute_tour.py - the shortest path from "just installed" to "computed a real number": model a truck (ontology), record two haul cycles, and read PROD.TPH off the KPI Standard Library (kpis), in about 50 lines. Points to the deeper per-package examples (examples/{ontology,events,connectors,kpis}/) for what it deliberately skips.

Dependencies

mineproductivity (base install - no extras required).

Future Work

Author further quickstart examples (registry/plugins) as the subsystems they demonstrate mature past their first flagship example.

References

• Developer & Cookbook Guide - Part I
• Developer & Cookbook Guide - Part II