opendssdirect.py

OpenDSSDirect.py: a cross-platform Python package that implements a native/direct library interface to the alternative OpenDSS engine from DSS-Extensions.org

https://github.com/dss-extensions/opendssdirect.py

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.4%) to scientific vocabulary

Keywords

dss interface opendss python
Last synced: 6 months ago · JSON representation ·

Repository

OpenDSSDirect.py: a cross-platform Python package that implements a native/direct library interface to the alternative OpenDSS engine from DSS-Extensions.org

Basic Info
Statistics
  • Stars: 97
  • Watchers: 13
  • Forks: 25
  • Open Issues: 19
  • Releases: 19
Topics
dss interface opendss python
Created over 8 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

OpenDSSDirect.py

GitHub Build Status codecov PyPI PyPI Download stats Documentation

OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface to our customized/alternative implementation of OpenDSS using DSS-Python. OpenDSS is an open-source distribution system simulator distributed by EPRI. See OpenDSSDirect.jl for a similar package in Julia, and for more context about this project and its components (including alternatives in MATLAB, C++, C#/.NET, Go, and Rust), please check https://dss-extensions.org/ and our hub repository at dss-extensions/dss-extensions for more documentation, discussions and the FAQ.

An alternative Python package is being developed in AltDSS-Python. It can be used together with OpenDSSDirect.py.

Overview of related projects

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.

Installation

Recommended: Install Python using Miniconda or Anaconda

Open a command line interface and type the following.

bash pip install 'OpenDSSDirect.py[extras]'

See the installation instructions for more information.

Updating from pre-v0.9 versions? See the upgrade guide for recommendations.

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.

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, as well as all the users for their valuable feedback.

See also our repositories for DSS-Python for the underlying Python package used in this package, and AltDSS/DSS C-API for the modified and extended OpenDSS codebase used in DSS-Extensions.

Owner

  • Name: DSS Extensions
  • Login: dss-extensions
  • Kind: organization

Language interfaces and extensions for EPRI's OpenDSS

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Krishnamurthy"
    given-names: "Dheepak"
    orcid: https://orcid.org/0000-0003-4008-3739
  - family-names: "Meira"
    given-names: "Paulo"
    orcid: https://orcid.org/0000-0001-6170-7438
title: "OpenDSSDirect.py: a cross-platform Python package that implements a native/direct library interface to the alternative OpenDSS engine from DSS-Extensions.org"
url: "https://dss-extensions.org/OpenDSSDirect.py/"
version: 0.9.0
date-released: 2024-02-12

GitHub Events

Total
  • Issues event: 10
  • Watch event: 9
  • Issue comment event: 27
  • Fork event: 2
Last Year
  • Issues event: 10
  • Watch event: 9
  • Issue comment event: 27
  • Fork event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 351
  • Total Committers: 4
  • Avg Commits per committer: 87.75
  • Development Distribution Score (DDS): 0.14
Top Committers
Name Email Commits
Dheepak Krishnamurthy k****9@g****m 302
Paulo Meira 1****a@u****m 45
Dheepak Krishnamurthy me@k****m 3
Maximilian J. Zangs m****s@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 90
  • Total pull requests: 22
  • Average time to close issues: 8 months
  • Average time to close pull requests: 6 months
  • Total issue authors: 44
  • Total pull request authors: 5
  • Average comments per issue: 3.97
  • Average comments per pull request: 2.23
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 0
  • Average time to close issues: 26 days
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 0
  • Average comments per issue: 3.25
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • kdheepak (18)
  • nlaws-camus (6)
  • jeverdave (5)
  • felipemarkson (5)
  • tarekelgindy (4)
  • jd-lara (3)
  • NicolasGensollen (3)
  • daniel-thom (3)
  • HafizRiaz (2)
  • GSkrt (2)
  • vermouth1992 (2)
  • keithmoffat (2)
  • AadilLatif (2)
  • PMeira (2)
  • armandokeller (2)
Pull Request Authors
  • PMeira (12)
  • kdheepak (9)
  • yasirroni (1)
  • mnblonsky (1)
  • daniel-thom (1)
Top Labels
Issue Labels
documentation (10) bug (6) enhancement (5) question (5) engine (4) good first issue (2) wontfix (1) packaging (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 4,472 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 4
  • Total versions: 47
  • Total maintainers: 2
pypi.org: opendssdirect.py

Python direct-mode interface to the alternative implementation of OpenDSS from DSS-Extensions.org

  • Homepage: https://github.com/dss-extensions/OpenDSSDirect.py
  • Documentation: https://dss-extensions.org/OpenDSSDirect.py
  • License: Copyright 2017 Alliance for Sustainable Energy, LLC NOTICE: This software was developed at least in part by Alliance for Sustainable Energy, LLC (“Alliance”) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy and the U.S. Government retains for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in the software to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, the above government rights notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, the above government rights notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The entire corresponding source code of any redistribution, with or without modification, by a research entity, including but not limited to any contracting manager/operator of a United States National Laboratory, any institution of higher learning, and any non-profit organization, must be made publicly available under this license for as long as the redistribution is made available by the research entity. 4. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenDSSDirect.py”. Except to comply with the foregoing, the term “OpenDSSDirect.py”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance. 5. The name of the copyright holder, contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission.
  • Latest release: 0.9.4
    published almost 2 years ago
  • Versions: 47
  • Dependent Packages: 3
  • Dependent Repositories: 4
  • Downloads: 4,472 Last month
Rankings
Dependent packages count: 2.4%
Downloads: 4.5%
Average: 6.2%
Dependent repos count: 7.5%
Stargazers count: 8.1%
Forks count: 8.4%
Maintainers (2)
Last synced: 6 months ago

Dependencies

setup.py pypi
  • dss_python ==0.12.1