Update modeling documentation structure#128
Merged
Merged
Conversation
This was referenced Jun 5, 2025
Closed
abirchfield
changed the title
pelesh
reviewed
Jun 5, 2025
Collaborator
pelesh
left a comment
pelesh
left a comment
There was a problem hiding this comment.
Great work!
The one outstanding issue is how we want to define
I also made a few nitpicking comments.
Co-authored-by: pelesh <peless@ornl.gov>
Collaborator
Author
|
OK, made those changes |
pelesh
approved these changes
Jun 6, 2025
WiktoriaZielinskaORNL
pushed a commit
that referenced
this pull request
Jul 23, 2025
* Initial update to GENROU docs * Initial update to GENSAL docs * Initial update to load docs * Initial BusFault docs * Initial branch docs update * Correct load math markers --------- Co-authored-by: abirchfield <abirchfield@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Updates modeling documentation to new structure, copying the GenClassical template developed May 29, 2025.
Proposed changes
Updated the following readme files with the new structure.
Branch
BusFault (new doc)
Load
GENROU
GENSAL
Did not update Bus, Exciter, Governor as these are best addressed in a separate effort.
Checklist
N/A
-Wall -Wpedantic -Wconversion -Wextra.Further comments
None.