-
Notifications
You must be signed in to change notification settings - Fork 5
feat: Add documantation for OpenDSS node type #105
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
base: node-opendss
Are you sure you want to change the base?
Conversation
Signed-off-by: Jitpanu Maneeratpongsuk <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work :)
I will mark this PR as a draft until the PR in the VILLASnode repo is merged.
Please update the VILLASnode Git submodule in this PR and un-draft it, once the other PR is merged :)
# OpenDSS | ||
|
||
OpenDSS is an electric power distribution system simulator (DSS) designed to support distributed energy resource (DER) grid integration and grid modernization. | ||
This node type run OpenDSS within VILLASnode and enabled VILLASnode to send and receive data to OpenDSS. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This node type run OpenDSS within VILLASnode and enabled VILLASnode to send and receive data to OpenDSS. | |
This node-type runs OpenDSS within VILLASnode and enables VILLASnode to exchange data with OpenDSS. |
|
||
# OpenDSS | ||
|
||
OpenDSS is an electric power distribution system simulator (DSS) designed to support distributed energy resource (DER) grid integration and grid modernization. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a link to the OpenDSS website please?
## Prerequisites | ||
This node type requires OpenDSS shared library. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Prerequisites | |
This node type requires OpenDSS shared library. | |
## Prerequisites | |
This node-type requires OpenDSS shared library. |
- **Generator:** Voltage(kV), Active Power(kW), Apparent Power(kVA), Power Factor(Pf) | ||
- **ISource:** Current(Amps), Phase angle(AngleDeg), Frequency(f) | ||
|
||
For the output, VILLASnode will read the data from monitor element for each time step. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the output, VILLASnode will read the data from monitor element for each time step. | |
For the output, VILLASnode will read the data from a monitor element for each time step. |
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **ISource:** Current(Amps), Phase angle(AngleDeg), Frequency(f) | ||
|
||
For the output, VILLASnode will read the data from monitor element for each time step. | ||
The data input and output data needed to be transported by [`path`](../config/paths.md) and additional node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is gramatically wrong. I fail to understand it.
type = "opendss" | ||
|
||
#Path to OpenDSS file | ||
file_path = "OpenDSS_file/sample.DSS" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we incorporate the OpenDSS example model into the VILLASnode repo and add a link here?
|
||
## Prerequisites | ||
This node type requires OpenDSS shared library. | ||
The documentation for compiling the library can be found on [OpenDSS documentation website](https://opendss.epri.com/OpenDSSC.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation for compiling the library can be found on [OpenDSS documentation website](https://opendss.epri.com/OpenDSSC.html). | |
The documentation for compiling the library can be found in the [OpenDSS documentation](https://opendss.epri.com/OpenDSSC.html). |
No description provided.