# aaryang21/micro-grid-planner architecture

> Architecture diagram of the GitHub repository aaryang21/micro-grid-planner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aaryang21/micro-grid-planner
- Repository: https://github.com/aaryang21/micro-grid-planner

## Overview

Microgrid Feasibility Dashboard combines a React planning interface with a Flask API. Users can scan a clicked site for nearby buildings and demand, then continue into a microgrid plan; city analysis adds demand, population, industry, emissions, ranked candidate cells, and map layers. The graph separates site planning, city analysis, interface, and persistence. Several backend stages are represented from the README and source index, but their internal calls are not asserted where excerpts do not show them.

Main entry points: [`city_scan/pipeline.py`](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/pipeline.py) (City analysis pipeline), [`src/App.jsx`](https://github.com/aaryang21/micro-grid-planner/blob/main/src/App.jsx) (Planning dashboard), [`src/hooks/useCityScan.js`](https://github.com/aaryang21/micro-grid-planner/blob/main/src/hooks/useCityScan.js) (City scan hook), [`city_scan/api.py`](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/api.py) (City scan routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["User interface"]
  node_landing["Landing experience<br/>[Landing.jsx]"]
  node_dashboard["Planning dashboard<br/>[App.jsx]"]
  node_city_hook["City scan hook<br/>[useCityScan.js]"]
  node_city_map["City map layers<br/>[CityLayers.jsx]"]
  node_city_summary["City summary<br/>[CitySummary.jsx]"]
end

subgraph group_site["Site feasibility"]
  node_site_scan["Building and load scan<br/>[site_scan.py]"]
  node_demand_model["Demand shaping model"]
  node_sizing["System sizing<br/>[solar_sizing.py]"]
  node_forecast["Load forecasting<br/>[load_forecast.py]"]
end

subgraph group_city["City analysis"]
  node_city_pipeline["City analysis pipeline<br/>[pipeline.py]"]
  node_boundary["City boundaries<br/>[boundary.py]"]
  node_grid["Spatial grid<br/>[grid.py]"]
  node_population["Population layer<br/>[population.py]"]
  node_consumption["Consumption estimates<br/>[consumption.py]"]
  node_calibration["Utility calibration<br/>[calibration.py]"]
  node_karnataka["Karnataka utility data<br/>[karnataka.py]"]
  node_industry["Industry layer<br/>[industry.py]"]
  node_emissions["Emissions layer<br/>[emissions.py]"]
  node_nightlights["Night-light layer<br/>[nightlights.py]"]
  node_scoring["Candidate scoring<br/>[scoring.py]"]
end

subgraph group_storage["API and persistence"]
  node_city_api["City scan routes<br/>[api.py]"]
  node_app_api["Flask application API<br/>[app.py]"]
  node_models[("Application data store<br/>[models.py]")]
end

node_user(("Planner"))

node_user -->|"opens"| node_landing
node_landing -->|"enters planning"| node_dashboard
node_user -.->|"selects site"| node_dashboard
node_dashboard -.->|"requests site scan"| node_site_scan
node_site_scan -->|"uses load shape"| node_demand_model
node_dashboard -.->|"requests system sizing"| node_sizing
node_dashboard -.->|"requests forecast"| node_forecast
node_dashboard -->|"starts city analysis"| node_city_hook
node_city_hook -->|"calls city endpoints"| node_city_api
node_city_api -->|"runs analysis"| node_city_pipeline
node_city_api -->|"reads and stores scans"| node_models
node_app_api -->|"registers routes"| node_city_api
node_app_api -->|"registers site routes"| node_site_scan
node_app_api -->|"uses persistence"| node_models
node_city_pipeline -->|"resolves city"| node_boundary
node_city_pipeline -->|"builds cells"| node_grid
node_city_pipeline -->|"loads population"| node_population
node_city_pipeline -->|"estimates demand"| node_consumption
node_city_pipeline -->|"calibrates demand"| node_calibration
node_city_pipeline -->|"loads industry"| node_industry
node_city_pipeline -->|"loads emissions"| node_emissions
node_city_pipeline -->|"uses night lights"| node_nightlights
node_city_pipeline -->|"ranks candidates"| node_scoring
node_calibration -->|"uses regional data"| node_karnataka
node_city_hook -->|"supplies layer data"| node_city_map
node_city_hook -->|"supplies scan summary"| node_city_summary

click node_landing "https://github.com/aaryang21/micro-grid-planner/blob/main/src/components/landing/Landing.jsx"
click node_dashboard "https://github.com/aaryang21/micro-grid-planner/blob/main/src/App.jsx"
click node_city_hook "https://github.com/aaryang21/micro-grid-planner/blob/main/src/hooks/useCityScan.js"
click node_city_map "https://github.com/aaryang21/micro-grid-planner/blob/main/src/components/city/CityLayers.jsx"
click node_city_summary "https://github.com/aaryang21/micro-grid-planner/blob/main/src/components/city/CitySummary.jsx"
click node_site_scan "https://github.com/aaryang21/micro-grid-planner/blob/main/site_scan.py"
click node_demand_model "https://github.com/aaryang21/micro-grid-planner/blob/main/train_demand_model.py"
click node_sizing "https://github.com/aaryang21/micro-grid-planner/blob/main/solar_sizing.py"
click node_forecast "https://github.com/aaryang21/micro-grid-planner/blob/main/load_forecast.py"
click node_city_api "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/api.py"
click node_city_pipeline "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/pipeline.py"
click node_boundary "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/boundary.py"
click node_grid "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/grid.py"
click node_population "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/population.py"
click node_consumption "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/consumption.py"
click node_calibration "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/calibration.py"
click node_karnataka "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/regional/karnataka.py"
click node_industry "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/industry.py"
click node_emissions "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/emissions.py"
click node_nightlights "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/nightlights.py"
click node_scoring "https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/scoring.py"
click node_app_api "https://github.com/aaryang21/micro-grid-planner/blob/main/app.py"
click node_models "https://github.com/aaryang21/micro-grid-planner/blob/main/models.py"

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_landing,node_dashboard,node_city_hook,node_city_map,node_city_summary toneBlue
class node_site_scan,node_demand_model,node_sizing,node_forecast toneAmber
class node_city_pipeline,node_boundary,node_grid,node_population,node_consumption,node_calibration,node_karnataka,node_industry,node_emissions,node_nightlights,node_scoring toneMint
class node_city_api,node_app_api,node_models toneRose
class node_user toneIndigo
```

## Components

### User interface

- [Landing experience](https://github.com/aaryang21/micro-grid-planner/blob/main/src/components/landing/Landing.jsx): `src/components/landing/Landing.jsx`
- [Planning dashboard](https://github.com/aaryang21/micro-grid-planner/blob/main/src/App.jsx): `src/App.jsx`
- [City scan hook](https://github.com/aaryang21/micro-grid-planner/blob/main/src/hooks/useCityScan.js): `src/hooks/useCityScan.js`
- [City map layers](https://github.com/aaryang21/micro-grid-planner/blob/main/src/components/city/CityLayers.jsx): `src/components/city/CityLayers.jsx`
- [City summary](https://github.com/aaryang21/micro-grid-planner/blob/main/src/components/city/CitySummary.jsx): `src/components/city/CitySummary.jsx`

### Site feasibility

- [Building and load scan](https://github.com/aaryang21/micro-grid-planner/blob/main/site_scan.py): `site_scan.py`
- [Demand shaping model](https://github.com/aaryang21/micro-grid-planner/blob/main/train_demand_model.py): `train_demand_model.py`
- [System sizing](https://github.com/aaryang21/micro-grid-planner/blob/main/solar_sizing.py): `solar_sizing.py`
- [Load forecasting](https://github.com/aaryang21/micro-grid-planner/blob/main/load_forecast.py): `load_forecast.py`

### City analysis

- [City analysis pipeline](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/pipeline.py): `city_scan/pipeline.py`
- [City boundaries](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/boundary.py): `city_scan/boundary.py`
- [Spatial grid](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/grid.py): `city_scan/grid.py`
- [Population layer](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/population.py): `city_scan/population.py`
- [Consumption estimates](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/consumption.py): `city_scan/consumption.py`
- [Utility calibration](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/calibration.py): `city_scan/calibration.py`
- [Karnataka utility data](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/regional/karnataka.py): `city_scan/regional/karnataka.py`
- [Industry layer](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/industry.py): `city_scan/industry.py`
- [Emissions layer](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/emissions.py): `city_scan/emissions.py`
- [Night-light layer](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/nightlights.py): `city_scan/nightlights.py`
- [Candidate scoring](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/scoring.py): `city_scan/scoring.py`

### API and persistence

- [City scan routes](https://github.com/aaryang21/micro-grid-planner/blob/main/city_scan/api.py): `city_scan/api.py`
- [Flask application API](https://github.com/aaryang21/micro-grid-planner/blob/main/app.py): `app.py`
- [Application data store](https://github.com/aaryang21/micro-grid-planner/blob/main/models.py): `models.py`

### Other components

- **Planner**

## Connections

- Planner → Landing experience: opens
- Landing experience → Planning dashboard: enters planning (evidence: `src/components/landing/Landing.jsx`)
- Planner → Planning dashboard: selects site
- Planning dashboard → Building and load scan: requests site scan
- Building and load scan → Demand shaping model: uses load shape (evidence: `site_scan.py`)
- Planning dashboard → System sizing: requests system sizing
- Planning dashboard → Load forecasting: requests forecast
- Planning dashboard → City scan hook: starts city analysis (evidence: `src/App.jsx`)
- City scan hook → City scan routes: calls city endpoints (evidence: `src/hooks/useCityScan.js`)
- City scan routes → City analysis pipeline: runs analysis (evidence: `city_scan/api.py`)
- City scan routes → Application data store: reads and stores scans (evidence: `city_scan/api.py`)
- Flask application API → City scan routes: registers routes (evidence: `app.py`)
- Flask application API → Building and load scan: registers site routes (evidence: `app.py`)
- Flask application API → Application data store: uses persistence (evidence: `app.py`)
- City analysis pipeline → City boundaries: resolves city (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Spatial grid: builds cells (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Population layer: loads population (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Consumption estimates: estimates demand (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Utility calibration: calibrates demand (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Industry layer: loads industry (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Emissions layer: loads emissions (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Night-light layer: uses night lights (evidence: `city_scan/pipeline.py`)
- City analysis pipeline → Candidate scoring: ranks candidates (evidence: `city_scan/pipeline.py`)
- Utility calibration → Karnataka utility data: uses regional data
- City scan hook → City map layers: supplies layer data (evidence: `src/App.jsx`)
- City scan hook → City summary: supplies scan summary (evidence: `src/App.jsx`)
