How isc-konstanz/lori works
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