Overview

The py-dss-interface is a Python package that provides a Python interface to the OFFICIAL version of OpenDSS (Open-source Distribution System Simulator) software. OpenDSS is a free, open-source software for simulating and analyzing power distribution systems.

docs
tests
package

• Free software: MIT license
• Documentation: https://py-dss-interface.readthedocs.io/en/latest/

The current py-dss-interface works only with Windows. The reason is that EPRI provides only Windows versions of OpenDSS. The package will work for Linux when EPRI releases the Linux version of OpenDSS.

The py-dss-interface package allows users to interact with OpenDSS using Python code, which can be particularly useful for automating tasks, performing simulations, and analyzing results. The package provides a range of functionality, including:

• Creating and modifying OpenDSS circuit models
• Running simulations and analyzing results
• Accessing and manipulating data within the circuit model
• Plotting results

The package is available on the Python Package Index (PyPI) and can be installed using pip, the Python package installer. OpenDSS does not have to be installed on the user's system to use the package, as the py-dss-interface provides an OpenDSS version.

Overall, the py-dss-interface is a powerful tool for anyone working with power distribution systems who wants to use Python for simulation and analysis.

Disclaimer

This Python Package is purely responsibility of Paulo Radatz and not his employer. Use this package at your own risk.

Installation

pip install py-dss-interface

Examples

You can find several examples of Python scripts at this link: https://github.com/PauloRadatz/py-dss-interface-examples

How to Cite

If you use py-dss-interface in your academic work, please reference it as follows:

APA Style:

Radatz, P. (2024). py-dss-interface: A Python package that interfaces with the OFFICIAL version of OpenDSS (Version X.X.X) [Computer software]. GitHub. https://github.com/PauloRadatz/py_dss_interface

BibTeX Entry:

@software{radatz2024bdgd2opendss,
  author = {Paulo Radatz},
  title = {py-dss-interface: A Python package that interfaces with the OFFICIAL version of OpenDSS},
  year = {2024},
  version = {X.X.X},
  url = {https://github.com/PauloRadatz/py_dss_interface}
}

Please replace X.X.X with the version of the package you are using.

Thanks

I want to thank Ênio Viana and Rodolfo Pilar Londero for all their contribution to the new version of the tool.