ORNL / ORNL/GridKit

Documentation improvements for PowerFlow

Open
#534 0 comments 0 reactions 2 assignees View on GitHub

@lukelowry is already working on this.

Since Aug 11, 2026.

documentation
Dominant language
C++
Stars
27
Forks
11
Avg merge
3d 8h
Merged PRs (30d)
23

Description

Summary
  • 1. Quotes on math variables unnecessary and distracting Here and elsewhere in this part of the docs
  • 2. "In the power system, complex voltage and current values are unknown, but rather real power injections at the generator buses and voltage magnitude setpoint as well as complex power (S) consumed by the load." This is not a complete sentence.
  • 3. Consolidate using exp instead of Euler's constant
  • 4. $\pi$ is an unfortunate choice for a model name, since it is also a frequently used number for radians. But maybe there is nothing to do about it if this is standard. You could use $\mathcal{\pi}$ maybe.
Rationale

No response

Description

No response

Additional information

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.