Skip to content

Create README file documenting classical generator model#122

Merged
pelesh merged 3 commits into
developfrom
slaven/gen_classical_docs_dev
Jun 3, 2025
Merged

Create README file documenting classical generator model#122
pelesh merged 3 commits into
developfrom
slaven/gen_classical_docs_dev

Conversation

@pelesh
Copy link
Copy Markdown
Collaborator

@pelesh pelesh commented May 30, 2025

Description

Created a README file specifying classical generator model parameters, internal and external variables, governing equations and initialization procedure.

Partially addresses #73

@abdourahmanbarry @reid-g @alexander-novo @nkoukpaizan

Proposed changes

  • Defines parameters and "derived parameters" used in classical generator model equations.
  • Defines internal and external model variables.
  • Fixes mistakes in classical generator model in Gen classical #94.
  • Specifies handling signal flow variables.
  • Proposes adding bus injection currents as generator internal variables. This increases size of the generator model but adds a modeling convenience.

Checklist

N/A

  • All tests pass.
  • Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
  • The new code follows GridKit™ style guidelines.
  • There are unit tests for the new code.
  • The new code is documented.
  • The feature branch is rebased with respect to the target branch.

Further comments

@pelesh pelesh requested a review from abirchfield May 30, 2025 21:05
@pelesh pelesh self-assigned this May 30, 2025
@pelesh pelesh added documentation Improvements or additions to documentation new model labels May 30, 2025
Copy link
Copy Markdown
Collaborator

@abirchfield abirchfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great.

@shakedregev
Copy link
Copy Markdown
Collaborator

shakedregev commented Jun 2, 2025

How does a README file fix a test error in PR #94 ?

pelesh added 2 commits June 2, 2025 17:24
@pelesh pelesh merged commit bb8487e into develop Jun 3, 2025
@alexander-novo
Copy link
Copy Markdown
Collaborator

How does a README file fix a test error in PR #94 ?

It's a documentation fix unrelated to the test error. The earlier documentation for that model was wrong.

@pelesh pelesh deleted the slaven/gen_classical_docs_dev branch June 10, 2025 18:02
WiktoriaZielinskaORNL pushed a commit that referenced this pull request Jul 23, 2025
* Creat README file for classical generator model.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation new model

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants