Skip to main content

Python direct-mode interface to OpenDSS

Project description

# OpenDSSDirect.py [![Travis Build Status](https://travis-ci.org/NREL/OpenDSSDirect.py.svg?branch=master)](https://travis-ci.org/NREL/OpenDSSDirect.py) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/NREL/OpenDSSDirect.py?branch=master&svg=true)](https://ci.appveyor.com/project/kdheepak/opendssdirect-py) [![codecov](https://codecov.io/gh/NREL/OpenDSSDirect.py/branch/master/graph/badge.svg)](https://codecov.io/gh/NREL/OpenDSSDirect.py) [![PyPI](https://img.shields.io/pypi/v/OpenDSSDirect.py.svg)](https://pypi.python.org/pypi/OpenDSSDirect.py/) [![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://nrel.github.io/OpenDSSDirect.py)

OpenDSSDirect.py is a Python package implements a “direct” library interface to [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx). OpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/tshort/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](http://nrel.github.io/OpenDSSDirect.py).

### Installation

Recommended: Install Python using Miniconda or Anaconda

Open a command line interface and type the following.

`bash pip install 'OpenDSSDirect.py[extras]' `

See [installation](https://nrel.github.io/OpenDSSDirect.py/notebooks/Installation.html) 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](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Doc/).

If you are having issues using this Python interface, feel free to open an Issue on GitHub [here](https://github.com/NREL/OpenDSSDirect.py/issues/new).

### Thanks

Thanks to @tshort, Davis, @temcdrm, @GordStephen and @Muxelmann for their input and comments.

See @Muxelmann’s repo [here](https://github.com/Muxelmann/OpenDSSDirect.make) on how to build OpenDSS for Linux.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

OpenDSSDirect.py-0.2.13.tar.gz (9.3 MB view details)

Uploaded Source

File details

Details for the file OpenDSSDirect.py-0.2.13.tar.gz.

File metadata

File hashes

Hashes for OpenDSSDirect.py-0.2.13.tar.gz
Algorithm Hash digest
SHA256 111147598c41186c008c374276fb3551b503d2c39a9f8c900055949033aea840
MD5 258e10084a39f351fcddc37a55eef337
BLAKE2b-256 d3457850d4d65f6520afa4b850756c62bd558ba308d00f69fdaa511a52073c92

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page