# quantum-visualizations/qmsolve architecture

> Architecture diagram of the GitHub repository quantum-visualizations/qmsolve, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/quantum-visualizations/qmsolve
- Repository: https://github.com/quantum-visualizations/qmsolve

## Overview

##### Main Components and Architecture

a) Core Components:
- Hamiltonian System (hamiltonian.py)
- Eigenstate Solver (eigenstates.py)
- Time-Dependent Solver
- Particle System
- Visualization System

b) Supporting Components:
- Utilities
- Examples
- External Dependencies

##### Component Relationships

**[Input Layer]**

- ▼
**[Core Processing Layer]**

- ▼
**[Solver Layer]**

- ▼
**[Visualization Layer]**

##### Specific Implementation Details

a) Input Processing:
- Particle System Configuration
- Hamiltonian Definition
- Initial Conditions

b) Solver Components:
- Eigenstate Solver
- ARPACK/LOBPCG Methods
- GPU Acceleration (CuPy)
- Time-Dependent Solver
- Split-Step Fourier Method
- Crank-Nicolson Method

c) Visualization System:
- 1D, 2D, and 3D Visualization
- Interactive Components
- Real-time Animation

##### Notes for Implementation

- The modular nature of the solver system
- The flexibility in choosing numerical methods
- The separation between computation and visualization
- The integration points with external libraries (Mayavi, CuPy)

This system design should be implemented using a professional diagramming tool that supports:
- Clear hierarchical layouts
- High-resolution export options

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Legend
        L1[Core Component]:::core
        L2[Input Component]:::input
        L3[Visualization Component]:::viz
        L4[External Dependency]:::external
        L5[Utility Component]:::util
        L6[/"Processing Flow"/]
    end

    subgraph Input["Input Layer"]
        PS[Particle System]:::input
        HC[Hamiltonian Configuration]:::input
        IC[Initial Conditions]:::input
    end

    subgraph Core["Core Processing Layer"]
        HS[Hamiltonian System]:::core
        PS --> HS
        HC --> HS
        IC --> HS
    end

    subgraph Solvers["Solver Layer"]
        ES[Eigenstate Solver]:::core
        TDS[Time-Dependent Solver]:::core
        
        subgraph TD["Time-Dependent Methods"]
            CN[Crank-Nicolson]:::core
            SF[Split-Step Fourier]:::core
        end
        
        subgraph ES_Methods["Eigenstate Methods"]
            ARPACK[ARPACK]:::external
            LOBPCG[LOBPCG]:::external
        end
    end

    subgraph Viz["Visualization Layer"]
        VIZ1D[1D Visualization]:::viz
        VIZ2D[2D Visualization]:::viz
        VIZ3D[3D Visualization]:::viz
    end

    subgraph Utils["Utility Components"]
        CONST[Constants]:::util
        COLOR[Color Functions]:::util
        FILE[File Handling]:::util
    end

    subgraph External["External Dependencies"]
        CUPY[CuPy]:::external
        MAYAVI[Mayavi]:::external
    end

    %% Connections
    HS --> ES
    HS --> TDS
    ES --> |Results| VIZ1D
    ES --> |Results| VIZ2D
    ES --> |Results| VIZ3D
    TDS --> |Results| VIZ1D
    TDS --> |Results| VIZ2D
    TDS --> |Results| VIZ3D
    TDS --> CN
    TDS --> SF
    ES --> ARPACK
    ES --> LOBPCG
    ES -.-> CUPY
    TDS -.-> CUPY
    VIZ3D --> MAYAVI

    %% Click events
    click HS "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/hamiltonian.py"
    click ES "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/eigenstates.py"
    click TDS "https://github.com/quantum-visualizations/qmsolve/tree/main/qmsolve/time_dependent_solver/"
    click CN "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/time_dependent_solver/crank_nicolson.py"
    click SF "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/time_dependent_solver/split_step.py"
    click PS "https://github.com/quantum-visualizations/qmsolve/tree/main/qmsolve/particle_system/"
    click VIZ1D "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/visualization/single_particle_1D.py"
    click VIZ2D "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/visualization/single_particle_2D.py"
    click VIZ3D "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/visualization/single_particle_3D.py"
    click CONST "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/util/constants.py"
    click COLOR "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/util/colour_functions.py"
    click FILE "https://github.com/quantum-visualizations/qmsolve/blob/main/qmsolve/util/file_handling.py"

    %% Styling
    classDef core fill:#a2d2ff,stroke:#333,stroke-width:2px
    classDef input fill:#caffbf,stroke:#333,stroke-width:2px
    classDef viz fill:#ffd6a5,stroke:#333,stroke-width:2px
    classDef external fill:#bdb2ff,stroke:#333,stroke-width:2px
    classDef util fill:#9c9c9c,stroke:#333,stroke-width:2px
```
