ORNL/GridKit

Expand documentation for phasor dynamics model structure

Ouverte

#387 ouverte le 30 avr. 2026

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (1 personne assignée)C++ (10 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (23 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez le README existant et les commentaires du code source dans les classes spécifiées. Étudiez la hiérarchie des classes et la syntaxe Doxygen pour ajouter une documentation complète.
Stack technique
cpp
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++DoxygenGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65