# direct-energy-partners/interoperability-data-model architecture

> Architecture diagram of the GitHub repository direct-energy-partners/interoperability-data-model, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/direct-energy-partners/interoperability-data-model
- Repository: https://github.com/direct-energy-partners/interoperability-data-model

## Overview

##### Project type and purpose
- This is an open-source data-model library for microgrid equipment (“Interoperability Data Models” or IDM).
- It provides standardized JSON definitions (schemas or attribute listings) for devices like batteries, chargers, breakers, etc.
- Its goal is to harmonize equipment attributes, lower integration costs, and enable machine-readable datasheets.

##### File structure
- Top level:
- README.md – project overview, vision, usage context
- *.json files – battery.json, breaker.json, charger.json, converter.json, fuse.json, hvac.json, meter.json, solar.json
- No code directories (src, lib) or build scripts present; it’s largely a static collection of JSON artifacts.
- These JSON files represent the core components; they are intended to be consumed by external systems or tooling.

##### README for additional insights
- Emphasizes machine-readable format, community contributions, and integration with dcide.app/components.
- Mentions open-source governance via Emerge Alliance.
- No in-repo server or application code; the repo is the canonical source for the data models.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Community & Governance
    Contributors["Contributors"]:::community
    Governance["Emerge Alliance & Community"]:::community

    %% Repository Layer
    subgraph "JSON Model Repository"
        direction TB
        JSONRepo["JSON Model Repository"]:::repo
        README["README.md"]:::repo
        battery["battery.json"]:::repo
        breaker["breaker.json"]:::repo
        charger["charger.json"]:::repo
        converter["converter.json"]:::repo
        fuse["fuse.json"]:::repo
        hvac["hvac.json"]:::repo
        meter["meter.json"]:::repo
        solar["solar.json"]:::repo
    end

    %% CI & Docs
    subgraph "CI / Validation Pipeline"
        direction TB
        CI["Schema Validation & Linting"]:::process
        Docs["Documentation Generator"]:::process
    end

    %% Publishing
    subgraph "Artifact Publishing"
        direction TB
        Publisher["Package Registry / CDN"]:::process
    end

    %% Consumers
    subgraph "Consumer Applications"
        direction TB
        DCIDE["dcide.app Frontend"]:::consumer
        Analysis["3rd-Party Analysis Tools"]:::consumer
        Datasheets["Manufacturer Datasheet Generators"]:::consumer
    end

    %% Flows
    Contributors -->|"Pull Request"| JSONRepo
    Governance -->|"Standards & Review"| JSONRepo
    JSONRepo -->|"On PR / Merge"| CI
    CI -->|"Generate Docs"| Docs
    Docs -->|"Publish Artifacts"| Publisher
    CI -->|"Publish Artifacts"| Publisher
    Publisher -->|"Consume Models"| DCIDE
    Publisher -->|"Consume Models"| Analysis
    Publisher -->|"Consume Models"| Datasheets

    %% Click Events
    click JSONRepo "https://github.com/direct-energy-partners/interoperability-data-model/tree/main/./"
    click README "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/README.md"
    click battery "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/battery.json"
    click breaker "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/breaker.json"
    click charger "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/charger.json"
    click converter "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/converter.json"
    click fuse "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/fuse.json"
    click hvac "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/hvac.json"
    click meter "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/meter.json"
    click solar "https://github.com/direct-energy-partners/interoperability-data-model/blob/main/solar.json"

    %% Styles
    classDef repo fill:#d0e6f5,stroke:#036,stroke-width:1px
    classDef process fill:#f0f0f0,stroke:#333,stroke-width:1px
    classDef consumer fill:#c8e6c9,stroke:#256,stroke-width:1px
    classDef community fill:#ffe0b2,stroke:#c60,stroke-width:1px
```
