Skip to content

Commit 112008f

Browse files
committed
README.md: updated several links and potentially confusing info (as of 2023).
1 parent c53baed commit 112008f

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# OpenDSSDirect.py
2-
[![Travis Build Status](https://travis-ci.com/dss-extensions/OpenDSSDirect.py.svg?branch=master)](https://travis-ci.com/dss-extensions/OpenDSSDirect.py)
32
[![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)
43
[![codecov](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py/branch/master/graph/badge.svg)](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py)
54
[![PyPI](https://img.shields.io/pypi/v/OpenDSSDirect.py.svg)](https://pypi.python.org/pypi/OpenDSSDirect.py/)
6-
[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://dss-extensions.github.io/OpenDSSDirect.py)
5+
[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://dss-extensions.org/OpenDSSDirect.py)
76

8-
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/).
9-
OpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/dss-extensions/OpenDSSDirect.jl) for a similar package in Julia.
7+
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/).
8+
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).
109

11-
**This package is available for Windows, Mac and Linux.**
10+
*As a reminder, although very compatible, this project is not supported by EPRI.*
11+
12+
**This package is available for Windows, Mac and Linux, including ARM and x86 variants.**
1213

1314
### Documentation
1415

15-
The documentation for this package can be found [here](http://dss-extensions.github.io/OpenDSSDirect.py).
16+
The documentation for this package can be found [here](http://dss-extensions.org/OpenDSSDirect.py).
1617

1718
### Installation
1819

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

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

2930
### Troubleshooting
3031

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

3738
### Thanks
3839

39-
Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions.
40-
41-
See @Muxelmann's repo [here](https://github.com/Muxelmann/OpenDSSDirect.make) on how to build OpenDSS for Linux.
42-
43-
See @PMeira's repo [here](https://github.com/dss-extensions/dss_python) for the interface used in this package.
40+
Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions, as well as all the users for their valuable feedback.
4441

45-
See @PMeira's repo [here](https://github.com/dss-extensions/electricdss-src) for changes to OpenDSS for maintaining cross platform compatibility.
42+
See also our repositories for [DSS-Python](https://github.com/dss-extensions/dss_python) for the underlying Python package used in this package, and
43+
[DSS C-API](https://github.com/dss-extensions/dss_capi) for modified and extended OpenDSS codebase using in DSS Extensions.

0 commit comments

Comments
 (0)