# shubhamcore/feederflex architecture

> Architecture diagram of the GitHub repository shubhamcore/feederflex, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shubhamcore/feederflex
- Repository: https://github.com/shubhamcore/feederflex

## Overview

FeederFlex is a synthetic feeder-coordination testbench and evidence/demo package, not a live grid-control or settlement system. Its main workflow prepares household and weather inputs, simulates forecasts and coordinated dispatch across scenarios, then presents validated results as an offline dashboard and explanatory receipts. The repository also produces research and pitch deliverables. Some simulator internals and output wiring are unsampled; those relationships are shown only where the README or excerpts support them.

Main entry points: [`scripts/simulate_feeder.py`](https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py) (Scenario simulation), [`results/scenario_timeseries.csv`](https://github.com/shubhamcore/feederflex/blob/main/results/scenario_timeseries.csv) (Simulation results), [`scripts/build_dashboard.py`](https://github.com/shubhamcore/feederflex/blob/main/scripts/build_dashboard.py) (Dashboard generation), [`dashboard.html`](https://github.com/shubhamcore/feederflex/blob/main/dashboard.html) (Interactive dashboard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_inputs["Data inputs"]
  node_ceew["CEEW load profiles"]
  node_profileprep["Profile preparation<br/>[prepare_ceew.py]"]
  node_weatherfetch["Weather retrieval"]
  node_weather["NASA weather series"]
end

subgraph group_model["Feeder simulation"]
  node_simulator["Scenario simulation<br/>[simulate_feeder.py]"]
  node_dispatch["Coordinated dispatch<br/>[simulate_feeder.py]"]
  node_forecast["Forecast evaluation<br/>[simulate_feeder.py]"]
end

subgraph group_evidence["Results and evidence"]
  node_results["Simulation results"]
  node_validate["Result checks"]
  node_dashdata["Dashboard payload"]
end

subgraph group_experience["Dashboard experience"]
  node_dashbuild["Dashboard generation<br/>[build_dashboard.py]"]
  node_dashboard["Interactive dashboard<br/>[dashboard.html]"]
  node_server["Local dashboard server<br/>[serve_dashboard.py]"]
end

subgraph group_deliverables["Research and pitch"]
  node_report["Research report"]
  node_docx["DOCX report builder"]
  node_docxout["Formatted report"]
  node_pitchbuild["Pitch deck builder"]
  node_pitch["Competition pitch deck"]
end

node_operator(("Judge or analyst"))

node_profileprep -->|"prepares profiles"| node_ceew
node_weatherfetch -->|"writes series"| node_weather
node_ceew -.->|"load input"| node_simulator
node_weather -.->|"weather input"| node_simulator
node_simulator -->|"evaluates forecasts"| node_forecast
node_simulator -->|"runs dispatch"| node_dispatch
node_simulator -.->|"writes run outputs"| node_results
node_results -->|"checks outputs"| node_validate
node_results -->|"reads results"| node_dashbuild
node_dashbuild -->|"builds payload"| node_dashdata
node_dashbuild -->|"generates dashboard"| node_dashboard
node_server -->|"serves at root"| node_dashboard
node_operator -->|"explores results"| node_dashboard
node_report -.->|"rendered report"| node_docxout
node_docx -->|"reads markdown"| node_report
node_docx -.->|"writes document"| node_docxout
node_pitchbuild -.->|"builds deck"| node_pitch

click node_ceew "https://github.com/shubhamcore/feederflex/blob/main/data/ceew_bareilly_2019_profiles_15m.csv"
click node_profileprep "https://github.com/shubhamcore/feederflex/blob/main/scripts/prepare_ceew.py"
click node_weatherfetch "https://github.com/shubhamcore/feederflex/blob/main/scripts/fetch_nasa_power.py"
click node_weather "https://github.com/shubhamcore/feederflex/blob/main/data/nasa_power_bihta_2019_hourly.csv"
click node_simulator "https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py"
click node_dispatch "https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py"
click node_forecast "https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py"
click node_results "https://github.com/shubhamcore/feederflex/blob/main/results/scenario_timeseries.csv"
click node_validate "https://github.com/shubhamcore/feederflex/blob/main/scripts/validate_results.py"
click node_dashbuild "https://github.com/shubhamcore/feederflex/blob/main/scripts/build_dashboard.py"
click node_dashdata "https://github.com/shubhamcore/feederflex/blob/main/results/dashboard_data.json"
click node_dashboard "https://github.com/shubhamcore/feederflex/blob/main/dashboard.html"
click node_server "https://github.com/shubhamcore/feederflex/blob/main/scripts/serve_dashboard.py"
click node_report "https://github.com/shubhamcore/feederflex/blob/main/docs/FeederFlex_Research_Report.md"
click node_docx "https://github.com/shubhamcore/feederflex/blob/main/scripts/render_report_docx.py"
click node_docxout "https://github.com/shubhamcore/feederflex/blob/main/docs/FeederFlex_Competition_Report.docx"
click node_pitchbuild "https://github.com/shubhamcore/feederflex/blob/main/scripts/build_pitch_deck.py"
click node_pitch "https://github.com/shubhamcore/feederflex/blob/main/docs/FeederFlex_Competition_Pitch.pptx"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ceew,node_profileprep,node_weatherfetch,node_weather toneBlue
class node_simulator,node_dispatch,node_forecast toneAmber
class node_results,node_validate,node_dashdata toneMint
class node_dashbuild,node_dashboard,node_server toneRose
class node_report,node_docx,node_docxout,node_pitchbuild,node_pitch,node_operator toneIndigo
```

## Components

### Data inputs

- [CEEW load profiles](https://github.com/shubhamcore/feederflex/blob/main/data/ceew_bareilly_2019_profiles_15m.csv): `data/ceew_bareilly_2019_profiles_15m.csv`
- [Profile preparation](https://github.com/shubhamcore/feederflex/blob/main/scripts/prepare_ceew.py): `scripts/prepare_ceew.py`
- [Weather retrieval](https://github.com/shubhamcore/feederflex/blob/main/scripts/fetch_nasa_power.py): `scripts/fetch_nasa_power.py`
- [NASA weather series](https://github.com/shubhamcore/feederflex/blob/main/data/nasa_power_bihta_2019_hourly.csv): `data/nasa_power_bihta_2019_hourly.csv`

### Feeder simulation

- [Scenario simulation](https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py): `scripts/simulate_feeder.py`
- [Coordinated dispatch](https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py): `scripts/simulate_feeder.py`
- [Forecast evaluation](https://github.com/shubhamcore/feederflex/blob/main/scripts/simulate_feeder.py): `scripts/simulate_feeder.py`

### Results and evidence

- [Simulation results](https://github.com/shubhamcore/feederflex/blob/main/results/scenario_timeseries.csv): `results/scenario_timeseries.csv`
- [Result checks](https://github.com/shubhamcore/feederflex/blob/main/scripts/validate_results.py): `scripts/validate_results.py`
- [Dashboard payload](https://github.com/shubhamcore/feederflex/blob/main/results/dashboard_data.json): `results/dashboard_data.json`

### Dashboard experience

- [Dashboard generation](https://github.com/shubhamcore/feederflex/blob/main/scripts/build_dashboard.py): `scripts/build_dashboard.py`
- [Interactive dashboard](https://github.com/shubhamcore/feederflex/blob/main/dashboard.html): `dashboard.html`
- [Local dashboard server](https://github.com/shubhamcore/feederflex/blob/main/scripts/serve_dashboard.py): `scripts/serve_dashboard.py`

### Research and pitch

- [Research report](https://github.com/shubhamcore/feederflex/blob/main/docs/FeederFlex_Research_Report.md): `docs/FeederFlex_Research_Report.md`
- [DOCX report builder](https://github.com/shubhamcore/feederflex/blob/main/scripts/render_report_docx.py): `scripts/render_report_docx.py`
- [Formatted report](https://github.com/shubhamcore/feederflex/blob/main/docs/FeederFlex_Competition_Report.docx): `docs/FeederFlex_Competition_Report.docx`
- [Pitch deck builder](https://github.com/shubhamcore/feederflex/blob/main/scripts/build_pitch_deck.py): `scripts/build_pitch_deck.py`
- [Competition pitch deck](https://github.com/shubhamcore/feederflex/blob/main/docs/FeederFlex_Competition_Pitch.pptx): `docs/FeederFlex_Competition_Pitch.pptx`

### Other components

- **Judge or analyst**

## Connections

- Profile preparation → CEEW load profiles: prepares profiles (evidence: `scripts/prepare_ceew.py`)
- Weather retrieval → NASA weather series: writes series (evidence: `scripts/fetch_nasa_power.py`)
- CEEW load profiles → Scenario simulation: load input (evidence: `README.md`)
- NASA weather series → Scenario simulation: weather input (evidence: `README.md`)
- Scenario simulation → Forecast evaluation: evaluates forecasts (evidence: `scripts/simulate_feeder.py`)
- Scenario simulation → Coordinated dispatch: runs dispatch (evidence: `scripts/simulate_feeder.py`)
- Scenario simulation → Simulation results: writes run outputs (evidence: `README.md`)
- Simulation results → Result checks: checks outputs (evidence: `scripts/validate_results.py`)
- Simulation results → Dashboard generation: reads results (evidence: `scripts/build_dashboard.py`)
- Dashboard generation → Dashboard payload: builds payload (evidence: `scripts/build_dashboard.py`)
- Dashboard generation → Interactive dashboard: generates dashboard (evidence: `README.md`)
- Local dashboard server → Interactive dashboard: serves at root (evidence: `scripts/serve_dashboard.py`)
- Judge or analyst → Interactive dashboard: explores results (evidence: `README.md`)
- Research report → Formatted report: rendered report (evidence: `README.md`)
- DOCX report builder → Research report: reads markdown (evidence: `scripts/render_report_docx.py`)
- DOCX report builder → Formatted report: writes document (evidence: `README.md`)
- Pitch deck builder → Competition pitch deck: builds deck (evidence: `README.md`)
