docs: Update README and architecture documents with build instructions and detailed data models
Some checks failed
Build and Push Docker Image / build-and-push (push) Failing after 1m59s
Deploy to Server / deploy (push) Failing after 3s

This commit is contained in:
2025-10-24 13:49:04 +02:00
parent ae19cd67c4
commit 28fea1f3fe
3 changed files with 132 additions and 2 deletions

View File

@@ -42,6 +42,10 @@ The domain model consists of the following key entities:
- `Attachment`: Files associated with scenarios, such as documents or images.
- `Version`: Tracks different versions of scenarios and their configurations.
### Detailed Domain Models
See [Domain Models](08_concepts/08_01_domain_models.md) document for detailed class diagrams and entity relationships.
## Data Model Highlights
- `scenario`: central entity describing a mining scenario; owns relationships to cost, consumption, production, equipment, and maintenance tables.
@@ -53,3 +57,7 @@ The domain model consists of the following key entities:
- `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.
### Detailed Data Models
See [Data Models](08_concepts/08_02_data_models.md) document for detailed ER diagrams and table descriptions.