Skip to content

Commit

Permalink
README.md: updated for v0.13.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
PMeira committed Mar 30, 2023
1 parent cc625d7 commit b1f0f41
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,40 @@

---

This is version of a set of MATLAB classes that expose the DSS C-API library with the same structure as the COM object, with the same extensions as DSS Python. This is the equivalent of DSS Python and DSS Sharp for MATLAB usage.
This is version of a set of MATLAB classes that expose the DSS C-API library with the same structure as the COM object, with the same extensions as DSS Python. This is the equivalent of DSS-Python and DSS-Sharp for MATLAB usage.

Please see [https://dss-extensions.org/](https://dss-extensions.org/) for a general introduction and useful links for all projects under DSS Extensions.

A new repository to coordinate documentation and other shared features across all DSS Extensions is now available at [https://github.com/dss-extensions/dss-extensions](https://github.com/dss-extensions/dss-extensions)

Related projects:
- [`OpenDSS`](https://sourceforge.net/projects/electricdss/): The main OpenDSS project, maintained by EPRI.
- [`OpenDSS`](https://sourceforge.net/projects/electricdss/): The main OpenDSS project, maintained by EPRI. We track the changes there and port accordingly, with a few exceptions.
- [`DSS C-API`](http://github.com/dss-extensions/dss_capi): Custom OpenDSS C-API library, which also includes some patches.
- [`DSS Python`](http://github.com/dss-extensions/dss_python): Python bindings that mimics the official COM interface (property-style access to items).
- [dss.hpp](https://dss-extensions.org/dss_capi/): header-only library for C++, hosted within DSS C-API (`include/` directory). Allows using DSS C-API more comfortably from C++, abstract memory management and low-level details such as API conventions of the DSS C-API library.
- [`DSS-Python`](http://github.com/dss-extensions/dss_python): Python bindings that mimics the official COM interface (property-style access to items). Very similar to DSS_MATLAB, but for Python. Some new and experimental features are tested there first (for example, plotting integration).
- [`OpenDSSDirect.py`](http://github.com/dss-extensions/OpenDSSDirect.py): Function-style bindings and useful tools (originally based on the DCSL/OpenDSSDirect.DLL).
- [`OpenDSSDirect.jl`](http://github.com/dss-extensions/OpenDSSDirect.jl): Julia bindings to DSS C-API (originally based on the DCSL/OpenDSSDirect.DLL).
- [`DSS Sharp`](http://github.com/dss-extensions/dss_sharp/): .NET assembly to use the native DLL, mimics the COM object as used in .NET.

Version 0.12.2, released on 2022-08-29, covers most of the COM functions and classes, besides some extensions from DSS C-API. If you find a missing function or unexpected behavior, please open an issue on GitHub to both help us track and hopefully fix it, and also inform other users. This project uses the [DSS C-API library version 0.12.1](https://github.com/dss-extensions/dss_capi/blob/master/docs/changelog.md#version-0121), based on OpenDSS revision 3460 (few commits after OpenDSS v9.4.1.2).
Version 0.13.0, released on 2023-03, covers most of the COM functions and classes, besides some extensions from DSS C-API. If you find a missing function or unexpected behavior, please open an issue on GitHub to both help us track and hopefully fix it, and also inform other users. This project currently uses the [DSS C-API library version 0.13.0](https://github.com/dss-extensions/dss_capi/blob/master/docs/changelog.md#version-0130), based on OpenDSS revision 3595 (few commits after OpenDSS v9.6.1.1).


## Highlights from 0.13.0

Port updates from DSS-Python 0.13, integrating our base library, DSS C-API 0.13. Specific to DSS_MATLAB:

- Add missing file
- `DSS.AdvancedTypes` mode: when enabled, the package can return complex numbers and matrices!
- `DSS.CompatFlags`: some toggles for compatibility with the official OpenDSS on some specific points.
- `DSS.AllowDOScmd`: toggle running system commands from DSS scripts
- Fix many docstring typos
- Fix some arrays of strings: some functions were broken during the DSSContext migration.
- Use enums for some properties: easier to read, more maintainable.
- Introduce a few new functions added in the official COM API.
- Updated our simple example script.

[See also the DSS C-API 0.13.0 notes.](https://github.com/dss-extensions/dss_capi/releases/tag/0.13.0)

## Highlights from 0.12.2

- Migrate to the DSSContext (`ctx_*`) API. This fixes some results when using multiple actors (PM).
Expand Down Expand Up @@ -97,7 +114,7 @@ https://github.com/dss-extensions/dss_capi/blob/master/docs/known_differences.md

Most of these apply indirectly to DSS_MATLAB.

The [list of important changes](https://github.com/dss-extensions/dss_capi/blob/master/docs/changelog.md#version-0120) through development is also useful.
The [list of important changes](https://github.com/dss-extensions/dss_capi/blob/master/docs/changelog.md#version-0130) through development is also useful.

## Credits / Acknowlegement

Expand Down

0 comments on commit b1f0f41

Please sign in to comment.