ORNL/GridKit

Expand documentation for phasor dynamics model structure

オープン

#387 opened on 2026/04/30

 (0 件のコメント) (0 件のリアクション) (1 人の担当者)C++ (10 件のフォーク)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (23 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド