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

Documentation updates based on psy4 #1091

Merged
merged 23 commits into from
May 15, 2024
Merged

Documentation updates based on psy4 #1091

merged 23 commits into from
May 15, 2024

Conversation

kdayday
Copy link
Contributor

@kdayday kdayday commented Apr 22, 2024

Updates to include:

  • Updated docstrings for PSY structs
  • New glossary

@rodrigomha
Copy link
Contributor

Do you know which docstrings are missing? You mentioned some branch cases. Feel free to comment in this PR whatever you are seeing that is missing.

@rodrigomha
Copy link
Contributor

Update statetypes on enumerated_types docs, explain what are statetypes in glossary, and add reference in docstrings of each state_types (differential) to the enumerated_types, and (states) to the glossary.


* *DC*: Direct current

* *Dynamic*: Refers to data and simulations for power system transient simulations using differential
Copy link
Member

Choose a reason for hiding this comment

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

@rodrigomha are you sure about this? Calling Small Signal dynamic is a stretch

@jd-lara jd-lara marked this pull request as ready for review May 15, 2024 16:49
@jd-lara jd-lara merged commit 2dca188 into NREL-Sienna:psy4 May 15, 2024
1 of 8 checks passed
@kdayday kdayday deleted the docs branch June 6, 2024 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants