zwitschi
4b3a15ed15
- 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.
CalMiner
A web application to plan mining projects and estimate costs, returns and profitability.
Focuses on ore mining operations and covering parameters such as capital and operational expenditures, resource consumption, production output, and Monte Carlo simulations for risk analysis.
The system is designed to help mining companies make informed decisions by simulating various scenarios and analyzing potential outcomes based on stochastic variables.
A range of features are implemented to support these functionalities.
Features
- Scenario Management: Manage multiple mining scenarios with independent parameter sets and outputs.
- Process Parameters: Define and persist process inputs via FastAPI endpoints and template-driven forms.
- Cost Tracking: Capture capital (
capex) and operational (opex) expenditures per scenario. - Consumption Tracking: Record resource consumption (chemicals, fuel, water, scrap) tied to scenarios.
- Production Output: Store production metrics such as tonnage, recovery, and revenue drivers.
- Equipment Management: Register scenario-specific equipment inventories.
- Maintenance Logging: Log maintenance events against equipment with dates and costs.
- Reporting Dashboard: Surface aggregated statistics for simulation outputs with an interactive Chart.js dashboard.
- Unified UI Shell: Server-rendered templates extend a shared base layout with a persistent left sidebar linking scenarios, parameters, costs, consumption, production, equipment, maintenance, simulations, and reporting views.
- Operations Overview Dashboard: The root route (
/) surfaces cross-scenario KPIs, charts, and maintenance reminders with a one-click refresh backed by aggregated loaders. - Theming Tokens: Shared CSS variables in
static/css/main.csscentralize the UI color palette for consistent styling and rapid theme tweaks. - Modular Frontend Scripts: Page-specific interactions now live in
static/js/modules, keeping templates lean while enabling browser caching and reuse. - Monte Carlo Simulation (in progress): Services and routes are scaffolded for future stochastic analysis.
Documentation & quickstart
This repository contains detailed developer and architecture documentation in the docs/ folder. For a short quickstart, troubleshooting notes, migration/backfill instructions and the current implementation status, see docs/quickstart.md.
Key architecture documents: see docs/architecture/README.md for the arc42-based architecture documentation.
For contributors: the routes/, models/ and services/ folders contain the primary application code. Tests and E2E specs are in tests/.