gridverse-open-low-code-pla.../AGENTS.md

1.3 KiB

GridVerse Open Source MVP Overview

  • A minimal Python-based MVP for GridVerse: an open low-code platform for cross-domain energy optimization.
  • Core concepts: Objects (local problems), Morphisms (data exchanges), Functors (adapters), and a lightweight registry/marketplace for interoperability.

Tech Stack

  • Language: Python 3.11+
  • Packaging: pyproject.toml with setuptools.
  • Tests: pytest.
  • No external heavy dependencies for MVP; designed to be extended with standard libraries and lightweight adapters.

Project Structure (MVP)

  • gridverse_open_low_code_platform_for_cro/
    • init.py
    • core.py (core data models: Object, Morphism, Functor)
    • adapter.py (adapter interface and a starter DER adapter)
    • registry.py (contract registry with simple validation)
    • marketplace.py (minimal marketplace scaffold)
  • adapters/
    • starter_der_adapter.py (example adapter implementation)
  • tests/
    • test_core.py
    • test_registry.py
    • test_adapter.py
  • pyproject.toml
  • README.md
  • test.sh

How to run tests

  • bash test.sh

Repository Rules

  • Work in small, verifiable steps. Add tests for each change and ensure all tests pass before publishing.
  • Keep API surface minimal and well-documented in README/AGENTS.md.
  • Do not push to remote automatically; this plan is for local verification only.