# jayparmar1301/solar-parameter-optimization-using-jaya-algorithm architecture

> Architecture diagram of the GitHub repository jayparmar1301/solar-parameter-optimization-using-jaya-algorithm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm
- Repository: https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm

## Overview

##### Project type and purpose
- This is a standalone Python-based scientific tool for parameter estimation of photovoltaic (PV) modules using the JAYA metaheuristic.
- It combines numerical modeling, optimization, data handling, and visualization in a CLI/scriptable format.

##### File structure
- Top-level script: `main.py` – entry point orchestrating the workflow.
- `config/` – definitions of PV module specifications (data driven).
- `models/` – implementation of the solar module electrical model and its objective function.
- `optimization/` – abstract `BaseOptimizer` plus a concrete `JAYAOptimizer` (Strategy pattern).
- `utils/` – I/O (JSON/CSV), data loading & saving, and plotting utilities (visualization).
- `results/` – output artifacts: CSV, JSON, MATLAB‐format, summary files.

##### README for additional insights
- Confirms modular structure, how to extend modules and optimizers (plugin‐style).
- Describes workflows:
a. instantiate a `SolarModuleModel`
b. plug it into a `JAYAOptimizer`
c. run `optimize()`
d. save results via `DataHandler`

##### Main components & their relationships
a. Components:
- CLI/Orchestrator (main.py)
- Configuration Store (config/solar_modules.py)
- Model Layer (`models.SolarModuleModel`)
- Optimizer Layer (`optimization.BaseOptimizer` + `JAYAOptimizer`)
- Data Handler (`utils.DataHandler`)
- Visualization (`utils.Visualizer`)
- Results Storage (results/ directory)
b. Data flow and interactions:
1. User invokes `main.py` (or imports classes).
2. `main.py` loads module specs from `config`.
3. Builds `SolarModuleModel` with parameters.
4. Initializes `JAYAOptimizer` with objective function from model.
5. `optimize()` iterates, producing best parameters & MSE.
6. `DataHandler` writes JSON/CSV/MAT files to `results/`.
7. `Visualizer` reads results, generates I–V/P–V plots and 3D distributions.
c. Architectural patterns & principles:
- Separation of Concerns – each folder has distinct responsibility.
- Strategy pattern – multiple optimizers can be swapped by subclassing.
- Plugin extension points – add new modules in `config` or new optimizers in `optimization`.
- Data‐driven design – module specs and bounds are configured via code/dicts.
d. Key technologies & libraries:
- Core: Python 3.8+
- Dependencies: NumPy, Pandas, Matplotlib (via `requirements.txt`)
- I/O: JSON, CSV, MATLAB text
- Build & env: venv, pip

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Nodes
    Orchestrator["CLI/Orchestrator"]:::core
    Config["Config Store"]:::extension
    Model["Model Layer"]:::core
    Base["BaseOptimizer"]:::extension
    JAYA["JAYAOptimizer"]:::core
    DataHandler["Data Handler"]:::io
    Results["Results Storage"]:::io
    Visualizer["Visualizer"]:::io
    External["Plots (I-V, P-V, 3D)"]:::external

    %% Flow
    Orchestrator -->|"loads specs (dict)"| Config
    Orchestrator -->|"builds model"| Model
    Model -->|"provides objective fn"| Base
    Base -->|"subclassed by"| JAYA
    JAYA -->|"best params + MSE"| DataHandler
    DataHandler -->|"writes JSON/CSV/MAT"| Results
    Results -->|"reads results"| Visualizer
    Visualizer -->|"generates plots"| External

    %% Plugin extension points
    Config -.->|"add new modules"| Config
    Base -.->|"add new optimizers"| Base

    %% Click Events
    click Orchestrator "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/main.py"
    click Config "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/config/solar_modules.py"
    click Model "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/models/solar_module.py"
    click Base "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/optimization/base_optimizer.py"
    click JAYA "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/optimization/jaya.py"
    click DataHandler "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/utils/data_handler.py"
    click Visualizer "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/blob/main/utils/visualization.py"
    click Results "https://github.com/jayparmar1301/solar-parameter-optimization-using-jaya-algorithm/tree/main/results/"

    %% Styles
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef io fill:#90EE90,stroke:#333,stroke-width:1px
    classDef extension fill:#FFA500,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
```
