# isc-konstanz/lori architecture

> Architecture diagram of the GitHub repository isc-konstanz/lori, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/isc-konstanz/lori
- Repository: https://github.com/isc-konstanz/lori

## Overview

##### Project type and purpose
- “lori” is an open-source Python package for Local Resource Integration.
- It provides a core framework, plugins (connectors, converters, components), data management, simulation, and a web/CLI interface.

##### Main architectural layers & components

1. Presentation Layer
- CLI entrypoint (`lori/__main__.py`)
- Web UI (`lori/application/view/...`)
– Handles user requests, routing, templates, assets

2. Application Layer
- Application interface & controller (`lori/application/interface.py`, `main.py`)
– Coordinates incoming requests between Presentation and Domain

3. Domain Layer (Core & Plugins)
a. Core Framework (`lori/core/...`)
– Configurator, context, registry, entity & resource management
b. Components (`lori/components/...`)
– Business logic modules (e.g., weather, tariff, camera)
c. Converters (`lori/converters/...`)
– Unit conversion sub-plugins
d. Connectors (`lori/connectors/...`)
– I/O to sensors, databases (SQL, Influx), CSV, Modbus, camera, Entsoe, DWD

4. Data Layer
- Data access & management (`lori/data/...`)
– Channels, database access, listeners, replication, retention
- IO utilities (`lori/io/...`)
– CSV/Excel import/export, plotting

5. Simulation Module
- Simulation engine (`lori/simulation/...`)
– Processes durations, results, progression

6. Configuration & Deployment
- Settings files (`conf/settings.default.conf`, logging config)
- Build scripts (`build.sh`, `setup.py`, `pyproject.toml`)
- Packaging (`lib/debian`, systemd service, logrotate)

##### Relationships & data flows
- User (CLI/Web) → Application Interface → Core Context & Registry
- Core loads Configurator → Discovers & registers Plugins (Components, Converters, Connectors)
- Component requests data via Connector → Connector reads/writes from/to Data Layer (e.g., Database, CSV, Sensors)
- Data Layer persists data → Core notifies Listeners/Replication/Retention
- Simulation module can request Components & Connectors via Core → produce Simulation Results
- IO utilities read/write processed data to files or plots

##### Architectural patterns & principles
- Plugin architecture: Core registry dynamically discovers/connects Components, Converters, Connectors
- MVC-like separation in Web UI: interface.py (controller), view/ (templates), assets/ (static)
- Layered architecture: clear separation between Presentation, Application, Domain, Infrastructure
- Dependency inversion: high-level modules (Components) depend on abstractions (Connector interface)

##### Technologies & frameworks
- Python 3 package structure
- Web UI: templating via `lori/application/view` (static assets, pages)
- Data storage: SQL (via `lori/connectors/sql`), InfluxDB connector
- External services: DWD weather API, ENTSO-E tariff provider
- Configuration: TOML parsing (`lori/core/configs/toml.py`), default `.conf` files

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Users
    UserCLI("User (CLI)"):::external
    UserWeb("User (Web)"):::external

    %% Presentation Layer
    subgraph "Presentation Layer"
        MainCLI["CLI Entrypoint"]:::presentation
        WebUI["Web UI"]:::presentation
    end

    %% Application Layer
    subgraph "Application Layer"
        AppInterface["App Interface & Controller"]:::application
        AppMain["Request Router"]:::application
    end

    %% Domain / Plugins Layer
    subgraph "Domain / Plugins"
        subgraph "Core Framework"
            Core["Core Framework"]:::domain
        end
        subgraph "Plugins"
            Components["Components"]:::domain
            Converters["Converters"]:::domain
            Connectors["Connectors"]:::domain
        end
    end

    %% Data Layer
    subgraph "Data Layer"
        DataAccess["Data Access & Management"]:::data
        IOUtils["I/O Utilities"]:::data
    end

    %% Simulation Module
    subgraph "Simulation Module"
        Simulation["Simulation Engine"]:::domain
    end

    %% Configuration & Deployment
    subgraph "Configuration & Deployment"
        Configs["Default Settings & Logging"]:::config
        Build["Build & Packaging"]:::config
        Debian["Debian Packaging & Services"]:::config
    end

    %% External Services
    DWD("DWD Weather API"):::external
    ENTSOE("ENTSO-E Tariff API"):::external

    %% Relationships
    UserCLI -->|"runs"| MainCLI
    UserWeb -->|"requests"| WebUI

    MainCLI -->|"invokes"| AppInterface
    WebUI -->|"routes via"| AppMain

    AppInterface -->|"calls"| Core
    AppMain -->|"calls"| Core

    Core -->|"register()"| Components
    Core -->|"register()"| Converters
    Core -->|"register()"| Connectors

    Components -->|"get_data()"| Connectors
    Connectors -->|"read/write"| DataAccess
    DataAccess -->|"persist"| Core

    Core -->|"notify listeners"| DataAccess

    Simulation -->|"uses components"| Components
    Simulation -->|"uses connectors"| Connectors
    Simulation -->|"produce results"| DataAccess

    IOUtils -->|"read/write"| DataAccess

    Configs -->|"load config"| Core
    Build -->|"package"| Core
    Debian -->|"deploy service"| Core

    Connectors -->|"fetch weather"| DWD
    Connectors -->|"fetch tariff"| ENTSOE

    %% Click Events
    click MainCLI "https://github.com/isc-konstanz/lori/blob/main/lori/__main__.py"
    click WebUI "https://github.com/isc-konstanz/lori/tree/main/lori/application/view/"
    click AppInterface "https://github.com/isc-konstanz/lori/blob/main/lori/application/interface.py"
    click AppMain "https://github.com/isc-konstanz/lori/blob/main/lori/application/main.py"
    click Core "https://github.com/isc-konstanz/lori/tree/main/lori/core/"
    click Components "https://github.com/isc-konstanz/lori/tree/main/lori/components/"
    click Converters "https://github.com/isc-konstanz/lori/tree/main/lori/converters/"
    click Connectors "https://github.com/isc-konstanz/lori/tree/main/lori/connectors/"
    click DataAccess "https://github.com/isc-konstanz/lori/tree/main/lori/data/"
    click IOUtils "https://github.com/isc-konstanz/lori/tree/main/lori/io/"
    click Simulation "https://github.com/isc-konstanz/lori/tree/main/lori/simulation/"
    click Configs "https://github.com/isc-konstanz/lori/blob/main/conf/settings.default.conf"
    click Build "https://github.com/isc-konstanz/lori/blob/main/build.sh"
    click Build "https://github.com/isc-konstanz/lori/blob/main/setup.py"
    click Build "https://github.com/isc-konstanz/lori/blob/main/pyproject.toml"
    click Debian "https://github.com/isc-konstanz/lori/tree/main/lib/debian/"
    click Debian "https://github.com/isc-konstanz/lori/tree/main/lib/logrotate.d/lori"
    click Debian "https://github.com/isc-konstanz/lori/blob/main/lib/systemd/lori.service"

    %% Styles
    classDef presentation fill:#c6efaa,stroke:#333,stroke-width:1px
    classDef application fill:#a0c4ff,stroke:#333,stroke-width:1px
    classDef domain fill:#ffc6a0,stroke:#333,stroke-width:1px
    classDef data fill:#fff3b0,stroke:#333,stroke-width:1px
    classDef external fill:#d0b0ff,stroke:#333,stroke-width:1px
    classDef config fill:#d3d3d3,stroke:#333,stroke-width:1px
```
