Skip to content

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

Open
wants to merge 1 commit into
base: node-opendss
Choose a base branch
from

Conversation

JitpanuM
Copy link

No description provided.

Signed-off-by: Jitpanu Maneeratpongsuk <[email protected]>
@JitpanuM JitpanuM requested a review from stv0g as a code owner April 11, 2025 14:58
Copy link
Contributor

@stv0g stv0g left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Contributor

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?

Comment on lines +10 to +11
## Prerequisites
This node type requires OpenDSS shared library.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Comment on lines +24 to +25


Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

- **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.
Copy link
Contributor

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"
Copy link
Contributor

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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).

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.

2 participants