Skip to content

Commit

Permalink
README.md: updated several links and potentially confusing info (as o…
Browse files Browse the repository at this point in the history
…f 2023).
  • Loading branch information
PMeira committed Mar 28, 2023
1 parent c53baed commit 112008f
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# OpenDSSDirect.py
[![Travis Build Status](https://travis-ci.com/dss-extensions/OpenDSSDirect.py.svg?branch=master)](https://travis-ci.com/dss-extensions/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.github.io/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 to [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.
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).

**This package is available for Windows, Mac and Linux.**
*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.github.io/OpenDSSDirect.py).
The documentation for this package can be found [here](http://dss-extensions.org/OpenDSSDirect.py).

### Installation

Expand All @@ -24,7 +25,7 @@ Open a command line interface and type the following.
pip install 'OpenDSSDirect.py[extras]'
```

See [installation](https://dss-extensions.github.io/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.
See [installation](https://dss-extensions.org/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.

### Troubleshooting

Expand All @@ -36,10 +37,7 @@ If you are having issues using this Python interface, feel free to open an Issue

### 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/dss-extensions/dss_python) for the interface used in this package.
Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions, as well as all the users for their valuable feedback.

See @PMeira's repo [here](https://github.com/dss-extensions/electricdss-src) for changes to OpenDSS for maintaining cross platform compatibility.
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 modified and extended OpenDSS codebase using in DSS Extensions.

0 comments on commit 112008f

Please sign in to comment.