Quick Start

The fastest way to see the whole platform work: one truck, one shift, one KPI.

Run it yourself

The complete script lives at examples/quickstart/01_five_minute_tour.py. Install with the analytics extra and run it:

pip install "mineproductivity[analytics] @ git+https://github.com/imanojkumar/MineProductivity.git"
python examples/quickstart/01_five_minute_tour.py

Compute your first KPI

Every KPI in MineProductivity is a discoverable, versioned, self-describing object — never a formula buried in a script:

from mineproductivity.kpis import REGISTRY

# Look a KPI up by its governed identifier, then compute it.
# One CAT 793F's shift: 40 cycles x 220 t at ~18 min (0.3 h) each.
cycles = [{"payload_t": 220.0, "operating_h": 0.3} for _ in range(40)]
tph = REGISTRY.get("PROD.TPH")().compute(cycles)
print(tph.value, tph.unit)   # 733.33... t/h

Discover what's available

from mineproductivity.kpis import REGISTRY

print(len(REGISTRY), "KPIs in the Standard Library")
for code in sorted(REGISTRY):
    print(code)

Where to go next

• Tutorials

  Package-by-package, runnable walkthroughs - KPIs, events, ontology, connectors, and the full Intelligence tier.

• Packages

  Read the full public API and extension guide for any package.

• Next Steps

  A curated route through the platform for first-time users.