MineProductivity¶

Enterprise-grade Python framework for mining analytics, Digital Twins, optimization and AI

Architecture complete & locked - certified v2.0.0

All eleven domain packages plus the three cross-cutting infrastructure packages are implemented, tested (2,986 passing tests, mypy --strict clean across 314 files), documented, and released. Public APIs are stable by contract. New value ships as plugins and applications - not as changes to the locked packages.

Why MineProductivity?¶

Ontology-first

A shared, explicit domain vocabulary (assets, processes, events, KPIs) precedes any code that operates on it.
Event-first

The system of record is an immutable event stream; all derived state (KPIs, twins, analytics) is a rebuildable projection.
Metadata-first

Every KPI, dataset, and model ships with machine-readable metadata (units, provenance, versioning) before it ships with logic.
Plugin-first

Connectors, KPIs, analytics, agents, and renderers are discovered through a registry/plugin system - never hard-wired into the core.
Clean architecture

Dependencies point inward toward core/ontology. Layering is mechanically enforced by per-package tests, both directions.
Enterprise quality

Strict typing, 99% branch coverage, cross-platform CI, and a recorded certification gate.

The platform at a glance¶

The locked dependency chain - lower layers never import higher ones:

graph TD
    core --> ontology --> events --> kpis --> analytics --> decision
    decision --> digital_twin --> simulation --> optimization --> agents --> visualization
    registry -.-> kpis
    plugins -.-> kpis
    connectors -.-> kpis

Explore the documentation¶

Quick Start

One truck, one shift, one KPI - the platform end-to-end in ~50 lines.
Learning Suite - Fundamentals

New here? Start with this. Ten lessons teaching the platform from first principles, using real mining problems.
Tutorials

Runnable, package-by-package walkthroughs from Foundation to Intelligence.
Packages

Per-package architecture, dependency rules, and extension guides.
API Reference

Symbol-level reference generated from the packages' own docstrings.
Architecture Handbook

The twelve locked design specifications and the ADRs behind them.
Certification

The v2.0.0 enterprise certification record and quality-gate results.

Install¶

pip install git+https://github.com/imanojkumar/MineProductivity.git

The base install has zero third-party dependencies. Optional extras add capability only where you need it - see Installation.

Citation¶

If you use MineProductivity in research or industry, please cite it via the Zenodo Concept DOI 10.5281/zenodo.21172767.