|
1 | | -[](https://ci.appveyor.com/project/PMeira/dss-sharp-h8r36/branch/master) |
| 1 | +[](https://github.com/dss-extensions/dss_sharp/actions/workflows/dotnet.yml) |
2 | 2 |
|
3 | 3 | # DSS Sharp |
4 | 4 |
|
5 | | -This contain files for the C# bindings for dss_capi, an unofficial build with a custom C-API of EPRI's OpenDSS. With it, you can replace the COM module with very few code changes and reach multi-platform C# code easily! |
| 5 | +DSS Sharp is a C#/.NET wrapper library for DSS C-API, which is an open-source, multiplatform, multiarchitecture, extended alternative (unofficial, not provided by EPRI) OpenDSS engine, highly compatible with the official OpenDSS COM implementation and more. |
| 6 | + |
| 7 | +DSS Sharp tries to mimic the organization of the official OpenDSS COM interfaces, plus several extensions (new properties and methods, and whole new classes). If you find conflicting behavior, feel free to report. |
| 8 | + |
| 9 | +This projects exposes most of the funcionality implemented in DSS C-API, including performance benefits, ZIP file support, initial JSON exports, multi-platform (Linux, Windows, macOS) support, including Intel x86/x64 and ARM architectures. Contrary to the official implementation, DSS Sharp supports multiple OpenDSS instances ([`dss_sharp.DSS.NewContext()`](https://dss-extensions.org/dss_sharp/html/d0e4d400-3bd9-1244-3cac-8f1234cbad9f.htm)), effectively enabling user-controlled multi-threading applications. Most of the official [parallel-machine](https://dss-extensions.org/dss_sharp/html/f3440753-3e74-bdb2-81c6-9052f8742d7e.htm) functions are also available. |
| 10 | + |
| 11 | +For a general introduction visit https://dss-extensions.org and follow the development of the general documentation at https://github.com/dss-extensions/dss-extensions |
6 | 12 |
|
7 | 13 | <p align="center"> |
8 | | - <img alt="Overview of related repositories" src="https://raw.githubusercontent.com/PMeira/dss_sharp/master/docs/images/repomap.svg?sanitize=true" width=600> |
| 14 | + <img alt="Overview of related repositories" src="https://raw.githubusercontent.com/dss-extensions/dss_capi/master/docs/images/repomap.png" width=600> |
9 | 15 | </p> |
10 | 16 |
|
11 | | -Previously, the source code here was hosted in https://github.com/PMeira/dss_capi/ itself. |
| 17 | +If you are looking for the bindings to other languages: |
| 18 | + |
| 19 | +- [DSS C-API library](http://github.com/dss-extensions/dss_capi/): the base library that exposes a modified version of EPRI's OpenDSS through a more traditional C interface, built with the open-source Free Pascal compiler instead of Delphi. As of 2022, this base library includes several extensive changes, while retaining very good compatibility. |
| 20 | +- [DSS Python](http://github.com/dss-extensions/dss_python/) is a multi-platform Python module (Windows, Linux, MacOS) very compatible with the original COM DLL. See also [OpenDSSDirect.py](http://github.com/dss-extensions/OpenDSSDirect.py/) if you don't need COM compatibility, or just would like to check its extra functionalities (you can mix DSS Python and OpenDSSDirect.py). DSS Python includes preliminary plotting capabilites. |
| 21 | +[`opendssdirect.utils`](https://dss-extensions.org/OpenDSSDirect.py/opendssdirect.html#module-opendssdirect.utils) to generate some DataFrames. |
| 22 | +- [OpenDSSDirect.jl](http://github.com/dss-extensions/OpenDSSDirect.jl/): a Julia module, created by Tom Short (@tshort), recently migrated with the help of Dheepak Krishnamurthy (@kdheepak) to DSS C-API instead of the DDLL. |
| 23 | +- [DSS MATLAB](http://github.com/dss-extensions/dss_matlab/): presents multi-platform integration (Windows, Linux, MacOS) with DSS C-API and is also very compatible with the COM classes. |
| 24 | + |
| 25 | +# Documentation |
12 | 26 |
|
13 | | -This code will be refactored and benchmarked, hence it's better to use a separate repository. |
| 27 | +We will grow general documentation at https://github.com/dss-extensions/dss-extensions |
14 | 28 |
|
| 29 | +Currently, users can rely on the official OpenDSS COM documentation (as seen in the official installation and from the [SVN repo](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Version8/Distrib/Doc/)). We provide C#/.NET class library docs at https://dss-extensions.org/dss_sharp/ |
0 commit comments