Skip to content

Commit

Permalink
Docs: add more general info, recommendations, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
PMeira committed Feb 9, 2024
1 parent 3da0ab1 commit 0caeeb6
Show file tree
Hide file tree
Showing 3 changed files with 584 additions and 133 deletions.
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ OpenDSSDirect.py is part of DSS-Extensions, a larger effort to port the original

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).

<center>

```mermaid
flowchart TD
C["AltDSS engine/DSS C-API\n(libdss_capi)"] --> P["Python"]
P --- DSSPY["DSS-Python\n(dss package)"]
P --- ODDPY["OpenDSSDirect.py\n(opendssdirect package)"]
P --- ALTDSSPY["AltDSS-Python\n(altdss package)"]
```

</center>

Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API, including most of its limitations. For an alternative API which exposes all OpenDSS objects, batch operations, and a more intuitive API, check [AltDSS-Python](https://dss-extensions.org/altdss-python/). If required, users can mix all three packages in the same project to access some of their unique features.

<!-- TODO: update the links to the final links after the main site is updated -->
Expand Down Expand Up @@ -78,6 +90,7 @@ Package on PyPI <https://pypi.python.org/pypi/OpenDSSDirect.py/>
Test/example circuits <https://github.com/dss-extensions/electricdss-tst>
DSS-Extensions/FAQ <https://github.com/dss-extensions/dss-extensions#faq>
DSS-Python <https://dss-extensions.org/dss_python>
AltDSS-Python <https://dss-extensions.org/altdss-python/>
DSS-Extensions Discussions <https://github.com/orgs/dss-extensions/discussions>
OpenDSS forum <https://sourceforge.net/p/electricdss/discussion/>
OpenDSS documentation <https://opendss.epri.com/opendss_documentation.html>
Expand Down
Loading

0 comments on commit 0caeeb6

Please sign in to comment.