ORNL/GridKit

Expand documentation for phasor dynamics model structure

Aperta

#387 aperta il 30 apr 2026

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (1 assegnatario)C++ (10 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (23 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Summary

Expand documentation in the PhasorDynamics README file and comments in source code in Component, GridElement, and Bus* classes.

Rationale

Doxygen style comments would help create documentation automatically and some description of the model code architecture in the README file would be helpful for component-model developers. Ideally, we want power systems experts to have clear understanding how to add a new component model without diving deep in GridKit code.

Description

  • In GridKit/Model/PhasorDynamics/README.md file add an overview of model classes architecture and some general instructions for component model developers.
  • Add new and expand existing comments following Doxygen markup for following classes"
    • GridElement
    • BusBase
    • BusBaseImpl
    • Component

Additional information

No response

Guida contributor

Direzione di ricerca
Esamina il README esistente e i commenti del codice sorgente nelle classi specificate. Studia la gerarchia delle classi e la sintassi Doxygen per aggiungere una documentazione completa.
Tech stack
cpp
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C++DoxygenGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65