Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving Documentation of Microgrid and Components #60

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from

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.

reid-g and others added 2 commits February 25, 2025 15:30
Co-authored-by: pelesh <peless@ornl.gov>
Co-authored-by: pelesh <peless@ornl.gov>
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