ORNL/GridKit

Expand documentation for phasor dynamics model structure

Open

#387 opened on Apr 30, 2026

View on GitHub
 (0 comments) (0 reactions) (1 assignee)C++ (10 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (23 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.