Roadmap¶
MineProductivity's overall architecture (Master Architecture Handbook v1.0) is
locked and documentation-complete. The software implementing it is versioned
independently via Semantic Versioning; the current
software release is 2.0.0 (see CHANGELOG.md for the full
milestone history). This roadmap tracks implementation phases against the
Reference Implementation Blueprint v1.0 and reflects the repository's actual,
current state — not a plan for a future not-yet-executed sequence.
Each phase below is one of three states: Implemented (real code, tested, merged), Architecture Complete (a locked Design Specification, Implementation Checklist, and ADR exist; no production code yet), or Not Started (neither exists yet).
Learning Suite. Separately from the software phases below, the platform ships an educational Learning Suite that teaches the framework from first principles. Its Fundamentals milestone (ten lessons + tutorials) is complete and released — see the Learning Roadmap for its own six-milestone plan (Fundamentals → Package Tutorials → Mining Workflows → Reference Applications → AI Examples → Research Examples), the Fundamentals tutorials, and the release notes in
docs/releases/. The Learning Roadmap is versioned independently of this one.
Phase 0 — Repository Skeleton¶
Status: Complete.
- Full directory structure for
src/,tests/,docs/,datasets/,notebooks/,examples/,benchmark/,certification/,scripts/. - Packaging, governance, and CI/CD placeholders.
- Zero business logic.
Phase 1 — Foundation Layer¶
Status: Partially implemented.
core— Implemented. Base entities, value objects, identifiers.ontology— Implemented. Domain vocabulary and schema definitions.registry,plugins— Implemented. Extension mechanisms.exceptions,config,utils,io— Not started. Cross-cutting primitives; each remains a structural placeholder. (coredefines its own internal exception hierarchy directly and does not currently depend on the separate top-levelexceptionspackage.)
Phase 2 — Event & KPI Layer¶
Status: Partially implemented.
events— Implemented. Event schema, event store, event bus, replay/time-travel.kpis— Implemented. KPI metadata model and the standard KPI library (per Developer & Cookbook Guide — Part III).validation— Not started. Schema and data-quality validation framework; remains a structural placeholder.
Phase 3 — Data & Connectivity Layer¶
Status: Partially implemented.
connectors— Implemented. Source-system integration interfaces and six reference connectors, plus five documentation-only OEM adapter shapes.datasets— Not started. Dataset abstractions and canonical/golden dataset loaders; remains a structural placeholder. (The implementedkpispackage uses its own, separatetests/fixtures/kpissample-dataset loader in the meantime.)
Phase 4 — Analytical Layer¶
Status: Implemented for analytics, simulation, and
optimization.
analytics— Implemented (v1.5.0 milestone, architecture approved at the v0.8.0 milestone). Statistical and analytical processing built onkpis/events— trend, baseline, and benchmark analysis, rolling and aggregate statistics, data-quality scoring, batch/streaming/incremental execution modes, and a self-registering plugin registry; interface-only forecasting/anomaly/outlier-detection models (zero concrete subclasses by design, seeADR-0006-Analytics-Engine.md).simulation— Fully implemented (architecture approved at the v1.1.0 milestone; software release v1.8.0). The platform's projection layer —SimulationModel/SimulationContext,Scenario/ScenarioStatusas a versioned, governed artifact with publish/supersede conflict enforcement,SimulationRun(the series' secondcore.BaseEntity[str]abstraction)/RunStatus/SimulationExecutor(category-driven dispatch, terminalCompleted/Failed),SimulationState/SimulationClock/TimeProgressionMode,seed_from_replayoverevents.EventStore.replay, the four interface-only ABCs (Monte Carlo/discrete-event/system-dynamics/ calibration, zero concrete subclasses by design),Experiment/ExperimentRunner(concurrent, seed-reproducible trials),ScenarioComparator/SensitivityAnalyzer(statistics delegated entirely toanalytics),by_category/by_scopediscovery,SimulationRunRepositoryas a literal type alias overcore.BaseRepository[SimulationRun, str],SimulationStateCache, theSimulationResult/ExperimentResultfamily, and theREGISTRY/registerplugin mechanism.simulationis feature-complete per the Reference Implementation Blueprint's design spec §6 module list (seesrc/mineproductivity/simulation/README.md).optimization— Fully implemented (architecture approved at the v1.2.0 milestone; software release v1.9.0). The platform's prescriptive search layer, built directly onsimulation— solved-plan search over six interface-only paradigms (linear programming, mixed-integer programming, constraint programming, multi-objective, evolutionary/metaheuristic, network optimization, zero concrete subclasses by design),OptimizationProblem/ProblemStatusas a versioned, governed artifact with publish/supersede conflict enforcement,OptimizationRun/RunStatus/OptimizationExecutor(category-driven dispatch with an iterative evolutionary branch),PlanComparator/SensitivityAnalyzer(statistics delegated entirely toanalytics),by_category/by_scopediscovery,OptimizationRunRepositoryas a literal type alias overcore.BaseRepository[OptimizationRun, str], theOptimizationResult/ParetoResultfamily, and theREGISTRY/registerplugin mechanism.optimizationis feature-complete per the Reference Implementation Blueprint's design spec §6 module list (seesrc/mineproductivity/optimization/README.md).
Phase 5 — Decision & Twin Layer¶
Status: decision, digital_twin, and agents fully implemented.
decision— Fully implemented (Phases 07.1-07.4, architecture approved at the v0.9.0 milestone; software release v1.6.0). Decision-support and recommendation frameworks that translateanalytics' statistical judgments into actionable, explained recommendations.DecisionModel/DecisionContext,DecisionMetadata/DecisionCategory, the fullDecisionResultfamily,DecisionPipeline/PipelineStage/ModelStage, and theREGISTRY/registerplugin mechanism (07.1); rule composition/evaluation (Rule,RuleEngine,RuleEngineStage), versioned policy governance (Policy,DecisionStatus), and the default, concreteThresholdDecisionStrategywith real threshold-breach evaluation (07.2);DecisionScorer/ConfidenceScorer,RankingStrategy/WeightedScoreRanking,ExplanationBuilder/ExplanationStage,ActionPrioritizer, and the interface-onlyRootCauseAnalyzer(07.3); and the interface-onlyWhatIfEngine,ActionPlanner,AlertGenerator,RealTimeDecisionSession/BatchDecisionRunner, andDecisionAuditTrail/DecisionAuditEntry(07.4) are all implemented.decisionis now feature-complete per the Reference Implementation Blueprint's design spec §6 module list (seesrc/mineproductivity/decision/README.md).digital_twin— Fully implemented (architecture approved at the v1.0.0 milestone; software release v1.7.0). The platform's stateful representation layer —Twin(acore.BaseEntity[str]subclass, the first entity-shaped central abstraction in the series)/TwinContext,TwinMetadata/TwinCategory, the eleven twin category base classes,TwinStatus,TwinState/TwinSnapshot,TwinSynchronizer/SyncPolicy(liveEventBussubscription and cold-startEventStore.replayreconstruction, provably convergent),TelemetryReading, the interface-onlyTwinSimulationModel(zero concrete subclasses by design),by_category/by_scopediscovery,TwinRepositoryas a literal type alias overcore.BaseRepository[Twin, str],TwinStateCache, theTwinResult/SyncResult/TwinSimulationResultfamily, and theREGISTRY/registerplugin mechanism.digital_twinis feature-complete per the Reference Implementation Blueprint's design spec §6 module list (seesrc/mineproductivity/digital_twin/README.md).agents— Fully implemented (architecture approved at the v1.3.0 milestone; software release v1.10.0). The platform's model-independent agent-orchestration layer, built directly onoptimization— the interface-onlyAgent/Tool/AgentMemoryextension points,Task/TaskStatus(with theAwaitingApprovalstate) as acore.BaseEntity[str],TaskExecutor(policy gate → dispatch → retry → persist → audit, plusresume()for approval resolution),PolicyEngine/AgentPolicygovernance with capability sets,WorkflowEnginegoal decomposition and multi-agent delegation (composingsimulation/optimizationdirectly),AgentAuditTrail,by_category/by_scopediscovery,TaskRepositoryas a literal type alias overcore.BaseRepository[Task, str], and the dualREGISTRY/TOOLSregistries.agentsis feature-complete per the Reference Implementation Blueprint's design spec §6 module list (seesrc/mineproductivity/agents/README.md).
Phase 6 — Experience Layer¶
Status: visualization fully implemented; not started for cli.
visualization— Fully implemented (architecture approved at the v1.4.0 milestone; software release v1.11.0). The platform's final package, built directly onagents— dashboards, reports, and rendering-backend-independent presentation of every lower package's already-structured output. The interface-onlyVisualization/Rendererextension points,PresentationModel,Dashboard(a lifecycle-freecore.BaseEntity)/Widget/Layout/Theme,DashboardBuilder/ReportBuilder(the series' first concretecore.BaseBuildersubclasses), the singleRenderingPipelinecode path (live and exported),Report/ExportRequest/ExportResult,by_owner/by_themediscovery,DashboardRepositoryas a literal type alias overcore.BaseRepository[Dashboard, str], and the dualREGISTRY/RENDERERSregistries.visualizationis feature-complete per the Reference Implementation Blueprint's design spec §6 module list (seesrc/mineproductivity/visualization/README.md), and is the final package in the platform's architecture — nothing depends on it.cli— command-line interface. No architecture specification exists yet.
Phase 7 — Quality & Certification¶
Status: Not started (as packages; lightweight standalone substitutes
already exist under scripts/quality/).
benchmark— conformance/reference benchmark scenarios and reporting as a package remain a structural placeholder;scripts/quality/perf_smoke.pyalready provides a lightweight, standalone performance smoke test used by CI in the meantime.certification— conformance test suite and reference output validation; remains a structural placeholder.- A
1.0-line software release milestone tagged specifically for "Reference Implementation Blueprint fully satisfied, certification suite passing" has not yet been reached — see Versioning Policy below for how this differs from the software's own SemVer track, which has already passed1.0.0for unrelated reasons. - The software's own
v2.0.0enterprise-certification milestone has been reached: every domain package is implemented, released, and documented, and the repository-wide acceptance-proof record is captured indocs/certification/2.0-certification.md. This certifies the implemented platform; it is distinct from the Phase 7certificationpackage (a future conformance-suite artifact), which remains a documented placeholder — seedocs/adr/ADR-0013-Placeholder-Package-Rationalization.md.
Future Architecture Proposals¶
Entries here are proposals, not phases: no Design Specification, Implementation Checklist, or ADR exists for them, they are not scheduled, and no code may be written against them. They are recorded so the intent survives until their revisit trigger is reached.
Analytics Maturity Assessment (post-v2.0)¶
- What: An analytics maturity assessment framework for mining enterprises — structured maturity scoring that helps leadership prioritize AI investments, quantify business-value assurance, accelerate digital transformation initiatives, and support governance.
- Status: Proposal only, captured July 2026 (software v1.6.0). Explicitly out of scope for every phase above.
- Revisit trigger: Only after the MineProductivity core platform is complete (the Reference Implementation Blueprint phases above reach Implemented).
- Deferred packaging decision: Either a separate package (e.g.
mineproductivity.assessment) or an application built on top of the framework. The locked architecture namesvisualizationas the final package in the platform's dependency chain, so the package option would require an explicit architecture amendment, while the application option leaves the locked chain untouched. Neither option is chosen yet; the evaluation belongs to the revisit, not to any current phase.
Versioning Policy¶
- Architecture documents are versioned independently and are already
locked at
v1.0(Master Architecture Handbook, Reference Implementation Blueprint). - Software follows Semantic Versioning, starting
at
0.1.0. The single authoritative source issrc/mineproductivity/__init__.py's__version__;pyproject.tomlreads it dynamically and nothing else should hardcode it (tests compare against installed package metadata instead — seetests/unit/core/test_public_api.py). - In practice, this repository has bumped the software's MINOR version once
per completed architecture or implementation milestone (
v0.7.0KPI Engine throughv1.6.0Decision Intelligence implementation) — a deliberate, precedented convention distinct from waiting for a certification-gated1.0release. Under this convention, the software's SemVer track and the "Phase 7 certification-gated 1.0" milestone described above are two different concepts that happen to share the digit1.0: the software already carries a version number at or past1.0.0, while the certification-gated milestone Phase 7 describes has not been reached. A future decision may rename or otherwise reconcile this overlap; until then, treat "software version" (SemVer,CHANGELOG.md) and "Reference Implementation Blueprint completion" (this roadmap's phases) as two independently-tracked measures of progress, not one.