- Introduced multiple architecture documentation files covering building block view, runtime view, deployment view, concepts, architecture decisions, quality requirements, technical risks, glossary, UI and styling, testing, CI, and development setup. - Migrated existing content from `architecture_overview.md` and `implementation_plan.md` into structured documentation. - Created scripts for checking broken links in documentation and formatting Markdown files for consistency. - Updated quickstart guide to provide clearer setup instructions and usage overview. - Removed outdated MVP features and testing strategy documents to streamline documentation.
18 lines
1.0 KiB
Markdown
18 lines
1.0 KiB
Markdown
# 08 — Concepts
|
|
|
|
Status: skeleton
|
|
|
|
Document key concepts, domain models, and terminology used throughout the architecture documentation.
|
|
|
|
## Data Model Highlights
|
|
|
|
- `scenario`: central entity describing a mining scenario; owns relationships to cost, consumption, production, equipment, and maintenance tables.
|
|
- `capex`, `opex`: monetary tracking linked to scenarios.
|
|
- `consumption`: resource usage entries parameterized by scenario and description.
|
|
- `parameter`: scenario inputs with base `value` and optional distribution linkage via `distribution_id`, `distribution_type`, and JSON `distribution_parameters` to support simulation sampling.
|
|
- `production_output`: production metrics per scenario.
|
|
- `equipment` and `maintenance`: equipment inventory and maintenance events with dates/costs.
|
|
- `simulation_result`: staging table for future Monte Carlo outputs (not yet populated by `run_simulation`).
|
|
|
|
Foreign keys secure referential integrity between domain tables and their scenarios, enabling per-scenario analytics.
|