# OpenDSSDirect.py
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/dss-extensions/OpenDSSDirect.py?branch=master&svg=true)](https://ci.appveyor.com/project/PMeira/opendssdirect-py)
[![codecov](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py/branch/master/graph/badge.svg)](https://codecov.io/gh/dss-extensions/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://dss-extensions.org/OpenDSSDirect.py)
OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface [our customized implementation](https://github.com/dss-extensions/dss_capi) of [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx) using [DSS-Python](https://github.com/dss-extensions/dss_python/).
OpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/dss-extensions/OpenDSSDirect.jl) for a similar package in Julia, and for more context about this project and its components (including alternatives in MATLAB, C++ and C#/.NET), please check [https://dss-extensions.org/](https://dss-extensions.org/) and our hub repository at [dss-extensions/dss-extensions](https://github.com/dss-extensions/dss-extensions) for more documentation, discussions and the [FAQ](https://github.com/dss-extensions/dss-extensions#faq).
*As a reminder, although very compatible, this project is not supported by EPRI.*
**This package is available for Windows, Mac and Linux, including ARM and x86 variants.**
### Documentation
The documentation for this package can be found [here](http://dss-extensions.org/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://dss-extensions.org/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/dss-extensions/OpenDSSDirect.py/issues/new).
### Thanks
Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions, as well as all the users for their valuable feedback.
See also our repositories for [DSS-Python](https://github.com/dss-extensions/dss_python) for the underlying Python package used in this package, and
[DSS C-API](https://github.com/dss-extensions/dss_capi) for the modified and extended OpenDSS codebase used in DSS-Extensions.
Raw data
{
"_id": null,
"home_page": "https://github.com/dss-extensions/OpenDSSDirect.py",
"name": "OpenDSSDirect.py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenDSS,cffi",
"author": "Dheepak Krishnamurthy",
"author_email": "me@kdheepak.com",
"download_url": "https://files.pythonhosted.org/packages/0d/2d/59bf8af893dc023607b572aa63547f96bc46e3781f9aabfd557baf0d51cf/OpenDSSDirect.py-0.8.4.tar.gz",
"platform": null,
"description": "# OpenDSSDirect.py\n[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/dss-extensions/OpenDSSDirect.py?branch=master&svg=true)](https://ci.appveyor.com/project/PMeira/opendssdirect-py)\n[![codecov](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py/branch/master/graph/badge.svg)](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py)\n[![PyPI](https://img.shields.io/pypi/v/OpenDSSDirect.py.svg)](https://pypi.python.org/pypi/OpenDSSDirect.py/)\n[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://dss-extensions.org/OpenDSSDirect.py)\n\nOpenDSSDirect.py is a cross-platform Python package implements a \"direct\" library interface [our customized implementation](https://github.com/dss-extensions/dss_capi) of [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx) using [DSS-Python](https://github.com/dss-extensions/dss_python/).\nOpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/dss-extensions/OpenDSSDirect.jl) for a similar package in Julia, and for more context about this project and its components (including alternatives in MATLAB, C++ and C#/.NET), please check [https://dss-extensions.org/](https://dss-extensions.org/) and our hub repository at [dss-extensions/dss-extensions](https://github.com/dss-extensions/dss-extensions) for more documentation, discussions and the [FAQ](https://github.com/dss-extensions/dss-extensions#faq).\n\n*As a reminder, although very compatible, this project is not supported by EPRI.*\n\n**This package is available for Windows, Mac and Linux, including ARM and x86 variants.**\n\n### Documentation\n\nThe documentation for this package can be found [here](http://dss-extensions.org/OpenDSSDirect.py).\n\n### Installation\n\n**Recommended**: Install Python using Miniconda or Anaconda\n\nOpen a command line interface and type the following.\n\n```bash\npip install 'OpenDSSDirect.py[extras]'\n```\n\nSee [installation](https://dss-extensions.org/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.\n\n### Troubleshooting\n\nIt is recommended to use `conda` to install pandas, which is currently a dependency of this package.\nThis package interfaces with OpenDSS using the \"direct\" library interface, so a good understanding of OpenDSS will help troubleshooting.\nThere are plenty of useful resources located [here](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Doc/).\n\nIf you are having issues using this Python interface, feel free to open an Issue on GitHub [here](https://github.com/dss-extensions/OpenDSSDirect.py/issues/new).\n\n### Thanks\n\nThanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions, as well as all the users for their valuable feedback.\n\nSee also our repositories for [DSS-Python](https://github.com/dss-extensions/dss_python) for the underlying Python package used in this package, and \n[DSS C-API](https://github.com/dss-extensions/dss_capi) for the modified and extended OpenDSS codebase used in DSS-Extensions.\n",
"bugtrack_url": null,
"license": "BSD-compatible",
"summary": "Python direct-mode interface to an alternative implementation of OpenDSS",
"version": "0.8.4",
"project_urls": {
"Download": "https://github.com/dss-extensions/OpenDSSDirect.py",
"Homepage": "https://github.com/dss-extensions/OpenDSSDirect.py"
},
"split_keywords": [
"opendss",
"cffi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19e110c9545fbb6fe0524c7bf0e3d52c09c2bd535f5904dd733b78fa69769ae2",
"md5": "27f0fea6a2d0f64dd9535d5af0b61465",
"sha256": "ee97e26a8f09a5d0b04f9dee944289c97187c7ff2c480ce60ebf9cdcddbeed3a"
},
"downloads": -1,
"filename": "OpenDSSDirect.py-0.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27f0fea6a2d0f64dd9535d5af0b61465",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 71539,
"upload_time": "2023-06-28T02:39:08",
"upload_time_iso_8601": "2023-06-28T02:39:08.022658Z",
"url": "https://files.pythonhosted.org/packages/19/e1/10c9545fbb6fe0524c7bf0e3d52c09c2bd535f5904dd733b78fa69769ae2/OpenDSSDirect.py-0.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d2d59bf8af893dc023607b572aa63547f96bc46e3781f9aabfd557baf0d51cf",
"md5": "faff45cfd447d7fd2ceb544b582542e7",
"sha256": "8be1140ccdfc1291458fa56ae022ed2ca021e3745e0b7bd689b3e004730ebc2b"
},
"downloads": -1,
"filename": "OpenDSSDirect.py-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "faff45cfd447d7fd2ceb544b582542e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 88268,
"upload_time": "2023-06-28T02:39:09",
"upload_time_iso_8601": "2023-06-28T02:39:09.934261Z",
"url": "https://files.pythonhosted.org/packages/0d/2d/59bf8af893dc023607b572aa63547f96bc46e3781f9aabfd557baf0d51cf/OpenDSSDirect.py-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-28 02:39:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dss-extensions",
"github_project": "OpenDSSDirect.py",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"lcname": "opendssdirect.py"
}