Skip to content

Improving Documentation of Microgrid and Components#60

Merged
pelesh merged 5 commits intodevelopfrom
reid/microgrid_docs
Jul 15, 2025
Merged

Improving Documentation of Microgrid and Components#60
pelesh merged 5 commits intodevelopfrom
reid/microgrid_docs

Conversation

@reid-g
Copy link
Collaborator

@reid-g reid-g commented Feb 17, 2025

Improving the documentation and details of the implementation. Adding some READMEs to help with the equations and referencing of them.

@reid-g reid-g added the documentation Improvements or additions to documentation label Feb 17, 2025
@reid-g reid-g self-assigned this Feb 17, 2025
Copy link
Collaborator

@pelesh pelesh left a comment

Choose a reason for hiding this comment

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

This is very helpful! A few small fixes are needed to get latex equations to render correctly.

Consider keeping text within 80-ish characters width where possible.

Comment on lines +70 to +71
Note all internal direct equalities are simplified into the differential equations.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Did you mean to say that all algebraic constraints are eliminated by substituting them into differential equations?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Was trying to be more specific. When I think of algebraic constraints its $0=g(y,z)$ where z is non-trivial to get. This case is trivial since $0=G(y)-z$ so are typically simplified out. So "direct equalities" seemed reasonable terminology.
However, re-reading it sounds weird so maybe something different is needed.

@pelesh
Copy link
Collaborator

pelesh commented Mar 13, 2025

FYI: References can be added in markdown as [^1] and listed later with the same markup. See here for an example.

@pelesh pelesh force-pushed the reid/microgrid_docs branch from e664107 to c45d808 Compare July 9, 2025 20:19
@pelesh pelesh marked this pull request as ready for review July 15, 2025 15:03
Copy link
Collaborator

@pelesh pelesh left a comment

Choose a reason for hiding this comment

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

Well timed improvement to the documentation of power electronics module.

@pelesh pelesh merged commit b244178 into develop Jul 15, 2025
WiktoriaZielinskaORNL pushed a commit that referenced this pull request Jul 17, 2025
@pelesh pelesh deleted the reid/microgrid_docs branch July 24, 2025 20:48
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants