# myoldmopar/energyplusapihelper architecture

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

- Interactive diagram: https://gitdiagram.com/myoldmopar/energyplusapihelper
- Repository: https://github.com/myoldmopar/energyplusapihelper

## Overview

This is a small EnergyPlus Python API helper library whose main workflow is to locate an EnergyPlus installation, load its API, and let a client create a state and run a simulation. The helper also resolves example and weather-file paths and creates temporary run directories. The README identifies the demos as a major part of the project; their individual implementations were not sampled, so they are represented together without inferred internal flows.

Main entry points: [`energyplus_api_helpers/import_helper.py`](https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py) (EPlus API helper), [`energyplus_api_helpers/demos`](https://github.com/myoldmopar/energyplusapihelper/tree/main/energyplus_api_helpers/demos) (Demo scripts)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_helper["Helper library"]
  node_helper["EPlus API helper<br/>[import_helper.py]"]
  node_asset_paths["Asset paths<br/>[import_helper.py]"]
  node_temp_dir["Temporary run directory<br/>[import_helper.py]"]
end

subgraph group_demos["API demos"]
  node_demo_scripts["Demo scripts"]
end

node_client(("Python client"))
node_energyplus["EnergyPlus API"]
node_simulation["Simulation run"]

node_client -->|"configures install"| node_helper
node_client -->|"requests API"| node_helper
node_helper -->|"imports API"| node_energyplus
node_client -->|"creates state"| node_energyplus
node_client -->|"runs simulation"| node_simulation
node_client -->|"resolves paths"| node_helper
node_client -->|"creates temp dir"| node_helper
node_client -->|"uses demos"| node_demo_scripts

click node_helper "https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py"
click node_asset_paths "https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py"
click node_temp_dir "https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py"
click node_demo_scripts "https://github.com/myoldmopar/energyplusapihelper/tree/main/energyplus_api_helpers/demos"

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_helper,node_asset_paths,node_temp_dir,node_client toneBlue
class node_demo_scripts toneAmber
class node_energyplus toneMint
class node_simulation toneIndigo
```

## Components

### Helper library

- [EPlus API helper](https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py): `energyplus_api_helpers/import_helper.py`
- [Asset paths](https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py): `energyplus_api_helpers/import_helper.py`
- [Temporary run directory](https://github.com/myoldmopar/energyplusapihelper/blob/main/energyplus_api_helpers/import_helper.py): `energyplus_api_helpers/import_helper.py`

### API demos

- [Demo scripts](https://github.com/myoldmopar/energyplusapihelper/tree/main/energyplus_api_helpers/demos): `energyplus_api_helpers/demos`

### Other components

- **Python client**
- **EnergyPlus API**
- **Simulation run**

## Connections

- Python client → EPlus API helper: configures install (evidence: `README.md`)
- Python client → EPlus API helper: requests API (evidence: `README.md`)
- EPlus API helper → EnergyPlus API: imports API (evidence: `energyplus_api_helpers/import_helper.py`)
- Python client → EnergyPlus API: creates state (evidence: `README.md`)
- Python client → Simulation run: runs simulation (evidence: `README.md`)
- Python client → EPlus API helper: resolves paths (evidence: `energyplus_api_helpers/import_helper.py`)
- Python client → EPlus API helper: creates temp dir (evidence: `energyplus_api_helpers/import_helper.py`)
- Python client → Demo scripts: uses demos (evidence: `README.md`)
