/OpenDSSDirect.py

OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface to OpenDSS.

Primary LanguagePythonOtherNOASSERTION

OpenDSSDirect.py

Travis Build Status Appveyor Build Status codecov PyPI Documentation

OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface to OpenDSS using dss_python. OpenDSS is an open-source distribution system simulator. See OpenDSSDirect.jl for a similar package in Julia.

This package is available for Windows, Mac and Linux.

Documentation

The documentation for this package can be found here.

Installation

Recommended: Install Python using Miniconda or Anaconda

Open a command line interface and type the following.

pip install 'OpenDSSDirect.py[extras]'

See installation instructions for more information.

Troubleshooting

It is recommended to use conda to install pandas, which is currently a dependency of this package. This package interfaces with OpenDSS using the "direct" library interface, so a good understanding of OpenDSS will help troubleshooting. There are plenty of useful resources located here.

If you are having issues using this Python interface, feel free to open an Issue on GitHub here.

Thanks

Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions.

See @Muxelmann's repo here on how to build OpenDSS for Linux.

See @PMeira's repo here for the interface used in this package.

See @PMeira's repo here for changes to OpenDSS for maintaining cross platform compatibility.