Files
calminer/docs/architecture/03_context_and_scope.md
zwitschi ef4fb7dcf0
Some checks failed
Run Tests / e2e tests (push) Failing after 1m20s
Run Tests / unit tests (push) Has been cancelled
Run Tests / lint tests (push) Has been cancelled
Refactor architecture documentation and enhance security features
- Updated architecture constraints documentation to include detailed sections on technical, organizational, regulatory, environmental, and performance constraints.
- Created separate markdown files for each type of constraint for better organization and clarity.
- Revised the architecture scope section to provide a clearer overview of the system's key areas.
- Enhanced the solution strategy documentation with detailed explanations of the client-server architecture, technology choices, trade-offs, and future considerations.
- Added comprehensive descriptions of backend and frontend components, middleware, and utilities in the architecture documentation.
- Migrated UI, templates, and styling notes to a dedicated section for better structure.
- Updated requirements.txt to include missing dependencies.
- Refactored user authentication logic in the users.py and security.py files to improve code organization and maintainability, including the integration of OAuth2 password bearer token handling.
2025-10-27 12:46:51 +01:00

1.3 KiB

title, description, status
title description status
03 — Context and Scope Describe system context, external actors, and the scope of the architecture. draft

03 — Context and Scope

System Context

The CalMiner system operates within the context of mining project management, providing tools for scenario analysis and decision support. It interacts with various data sources, including historical project data and real-time operational metrics.

External Actors

  • Project Managers: Utilize the platform for scenario planning and risk assessment.
  • Data Analysts: Analyze simulation results and derive insights.
  • Executives: Review high-level reports and dashboards for strategic decision-making.

Scope of the Architecture

See Architecture Scope for details.

Diagram

sequenceDiagram
    participant PM as Project Manager
    participant DA as Data Analyst
    participant EX as Executive
    participant CM as CalMiner System

    PM->>CM: Create and manage scenarios
    DA->>CM: Analyze simulation results
    EX->>CM: Review reports and dashboards
    CM->>PM: Provide scenario planning tools
    CM->>DA: Deliver analysis insights
    CM->>EX: Generate high-level reports

This diagram illustrates the key components of the CalMiner system and their interactions with external actors.