# snow-know/electromagnetic-app architecture

> Architecture diagram of the GitHub repository snow-know/electromagnetic-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/snow-know/electromagnetic-app
- Repository: https://github.com/snow-know/electromagnetic-app

## Overview

##### Project Type and Purpose
- This is a standalone desktop simulation application built with Python and PyQt5.
- Purpose: to simulate electromagnetic wave propagation, incidence, and waveguide experiments in 2D/3D, allow pause/continue, and save snapshots.

##### File‐Structure Analysis
- Top‐level files:
- open.py       – Main entry point and application bootstrap
- field.py      – Core electromagnetic field calculation routines
- plot_pyqt.py  – Embeds 2D/3D Matplotlib or PyQtGraph canvases into Qt widgets
- plotvect.py   – Specialized vector‐field plotting logic
- infordia.py   – Dialog windows (parameters, “about”, etc.)
- *.ui files    – Qt Designer UI definitions for windows and dialogs
- image/        – Static assets and output directory for saved screenshots
- test*.py      – Unit or integration tests
- tips.txt      – User guidance or developer notes
- No external microservices or database—pure client‐side simulation.

##### README Insights
- Confirms PyQt5 as UI framework; mentions 2D/3D simulation modes, GUI beautification, save‐image feature.
- Main file: open.py.

a. Main Components
1. UI Layer
– MainWindow (from open.py + .ui)
– Parameter Dialogs (infordia.py + .ui)
2. Simulation Engine
– field.py (computes E/M wave fields over timesteps)
3. Visualization Engine
– plot_pyqt.py for general plots
– plotvect.py for vector‐field rendering
4. Persistence / I/O
– image/ directory for saving PNGs
5. Test Harness
– test*.py scripts verifying correctness
b. Relationships / Data Flow
1. User interacts with UI → triggers event handlers in open.py
2. Event handlers collect parameters → call simulation engine (field.py)
3. field.py returns numerical arrays → passed to plot modules
4. Visualization modules render into Qt Canvas → UI updates display
5. User issues “Save” command → I/O module writes image to image/
6. Test modules import and exercise each component in isolation
c. Architectural Patterns
– MVC‐style separation:
- Model = Simulation Engine (field.py)
- View = UI (.ui files + Canvas widgets)
- Controller = open.py + event callbacks
– Layered design: UI → Business Logic → Visualization → File I/O
d. Key Technologies
– PyQt5 for GUI
– Python + NumPy for numerics
– Matplotlib or PyQtGraph for plotting
– Qt Designer (.ui) for layout
– Standard file system for saving images

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        Open["open.py"]:::ui
        InforDiaPy["infordia.py"]:::ui
        InforDiaUI["infordia.ui"]:::ui
        FieldUI["field.ui"]:::ui
    end

    %% Simulation Engine (Model)
    subgraph "Simulation Engine"
        direction TB
        FieldPy["field.py"]:::model
    end

    %% Visualization Engine (View)
    subgraph "Visualization Engine"
        direction TB
        PlotPyQt["plot_pyqt.py"]:::viz
        PlotVect["plotvect.py"]:::viz
    end

    %% Persistence / I/O
    subgraph "Persistence / I/O"
        direction TB
        ImageDir["image/"]:::io
        ImageSubDir["image/images"]:::io
    end

    %% Test Harness
    subgraph "Test Harness"
        direction TB
        Test1["test.py"]:::test
        Test2["testinputlim.py"]:::test
    end

    %% Data/Control Flow
    Open -->|"triggers simulation"| FieldPy
    FieldPy -->|"returns NumPy arrays"| PlotPyQt
    FieldPy -->|"returns NumPy arrays"| PlotVect
    PlotPyQt -->|"renders 2D/3D plots"| Open
    PlotVect -->|"renders vector fields"| Open
    Open -->|"saves snapshot"| ImageDir
    ImageDir -->|"stores PNGs"| ImageSubDir

    Test1 -->|"imports modules"| Open
    Test1 -->|"imports modules"| FieldPy
    Test1 -->|"imports modules"| PlotPyQt
    Test1 -->|"imports modules"| PlotVect
    Test2 -->|"imports modules"| Open
    Test2 -->|"imports modules"| FieldPy
    Test2 -->|"imports modules"| PlotPyQt
    Test2 -->|"imports modules"| PlotVect

    %% Click Events
    click Open "https://github.com/snow-know/electromagnetic-app/blob/main/open.py"
    click InforDiaPy "https://github.com/snow-know/electromagnetic-app/blob/main/infordia.py"
    click InforDiaUI "https://github.com/snow-know/electromagnetic-app/blob/main/infordia.ui"
    click FieldUI "https://github.com/snow-know/electromagnetic-app/blob/main/field.ui"
    click FieldPy "https://github.com/snow-know/electromagnetic-app/blob/main/field.py"
    click PlotPyQt "https://github.com/snow-know/electromagnetic-app/blob/main/plot_pyqt.py"
    click PlotVect "https://github.com/snow-know/electromagnetic-app/blob/main/plotvect.py"
    click ImageDir "https://github.com/snow-know/electromagnetic-app/tree/main/image/"
    click ImageSubDir "https://github.com/snow-know/electromagnetic-app/tree/main/image/images"
    click Test1 "https://github.com/snow-know/electromagnetic-app/blob/main/test.py"
    click Test2 "https://github.com/snow-know/electromagnetic-app/blob/main/testinputlim.py"

    %% Styles
    classDef ui fill:#D0E6FF,stroke:#0B69A3,stroke-width:2px
    classDef model fill:#FFF5B1,stroke:#D8A700,stroke-width:2px
    classDef viz fill:#E8D0FF,stroke:#9B59B6,stroke-width:2px
    classDef io fill:#D0FFD1,stroke:#27AE60,stroke-width:2px
    classDef test fill:#F2F2F2,stroke:#7F8C8D,stroke-width:2px
```
