Expand documentation for phasor dynamics model structure
Open
@PhilipFackler is already working on this.
Since Apr 30, 2026.
documentation
enhancement
good first issue
- Dominant language
- C++
- Stars
- 27
- Forks
- 11
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 23
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.mdfile 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"
GridElementBusBaseBusBaseImplComponent
Additional information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.