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 cross-platform Python package implements a “direct” library interface to [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx) using [dss_python](https://github.com/PMeira/dss_python/). 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, @Muxelmann and @PMeira for their contributions.

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

See @PMeira’s repo [here](https://github.com/PMeira/dss_python) for the interface used in this package.

See @PMeira’s repo [here](https://github.com/PMeira/electricdss-src) for changes to OpenDSS for maintaining cross platform compatibility.

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.3.6.tar.gz (71.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: OpenDSSDirect.py-0.3.6.tar.gz
  • Upload date:
  • Size: 71.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.4

File hashes

Hashes for OpenDSSDirect.py-0.3.6.tar.gz
Algorithm Hash digest
SHA256 bb0a082af54cd7265ad9cf1efcbb0e9d401f66119ce842b46787638826e102e5
MD5 7e5c88f2d01435ac19f89e8fa1086f93
BLAKE2b-256 b5ca64cc45cfc8d4d2bced13f2fa1b00833e947216c38e1cf42a443271f25bdd

See more details on using hashes here.

Supported by

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