Dashboard & User Interface

This section documents the Steel Model’s web interface and desktop application, including the Django web application, Electron standalone app, and the parallel worker management system.

Getting Started

The Steel Model UI comes in two flavors:

  • Django Web Application for shared, server-hosted deployments.

  • Electron Standalone App for self-contained desktop use.

Both experiences share the same workflows for configuring simulations, launching runs, and reviewing results. Start with the Django & Electron Overview for a tour of the interface, and browse the User Stories for common tasks the UI supports.

Overview

The Steel Model provides two deployment options:

  • Django Web Application: Browser-based interface for server deployments with multi-user support

  • Electron Standalone App: Self-contained desktop application with embedded Django server

Both options provide an intuitive web interface for configuring and running steel industry simulations, with support for parallel execution, real-time progress tracking, and interactive result visualization.

Getting Started

Django & Electron Overview

Comprehensive guide to both deployment options, covering:

  • Architecture and key components

  • Installation and setup

  • Building the Electron standalone app

  • Feature comparison between Django and Electron

  • User workflows and system requirements

  • Security considerations and troubleshooting

Concept Document

High-level requirements and design goals for the web UI:

  • Core functionality requirements

  • Technical constraints and performance considerations

  • User experience goals

  • Target users and use cases

Implementation Details

Parallel Worker Management

Detailed documentation of the parallel execution system:

  • Worker architecture and lifecycle

  • Resource management and scaling

  • Task queue and scheduling

  • Monitoring and troubleshooting

Design Approaches

UI/UX design decisions and patterns:

  • Interface design principles

  • User interaction patterns

  • Visualization approaches

  • Responsive design considerations

Custom Repositories

Data management and repository system:

  • Repository pattern implementation

  • Data storage and retrieval

  • Version control for configurations

  • Custom data source integration

User Stories

Use cases and user requirements:

  • Key user workflows

  • Feature requirements

  • User personas and scenarios

  • Acceptance criteria