Skip to content

Commit e926d49

Browse files
committed
Update license and README.md for version 0.10.3
1 parent 52227af commit e926d49

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2018, Paulo Meira
3+
Copyright (c) 2018-2019, Paulo Meira
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# DSS MATLAB: an unofficial MATLAB package for EPRI's OpenDSS
22

3-
**Currently in pre-release status!**
4-
5-
This is work-in-progress version of a set of MATLAB classes that expose the DSS C-API library with the same structure as the COM object. At the moment, this is the equivalent of DSS Python and DSS Sharp for MATLAB usage.
3+
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 as extensions as DSS Python. This is the equivalent of DSS Python and DSS Sharp for MATLAB usage.
64

75
Related projects:
86
- [`OpenDSS`](https://sourceforge.net/projects/electricdss/): The main OpenDSS project, maintained by EPRI.
@@ -11,6 +9,8 @@ Related projects:
119
- [`OpenDSSDirect.py`](http://github.com/dss-extensions/OpenDSSDirect.py): More pythonic bindings and useful tools.
1210
- [`DSS Sharp`](http://github.com/dss-extensions/dss_sharp/): .NET assembly to use the native DLL, mimics the COM object as used in .NET.
1311

12+
The first non-preview version, 0.10.3, is expected to cover most of the COM functions and classes. 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.
13+
1414
## Usage
1515

1616
1. Download a package from the [releases page](https://github.com/dss-extensions/dss_matlab/releases).
@@ -45,6 +45,20 @@ function [Start,Obj,Text] = DSSStartup
4545

4646
If you want some code to play with, you can use the MATLAB examples from the official OpenDSS distribution, from a local installation (e.g. `C:\OpenDSS\Examples\Matlab`) or from the [official SVN repository](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Distrib/Examples/Matlab/).
4747

48+
[Sandia's GridPV toolbox](https://pvpmc.sandia.gov/applications/gridpv-toolbox/) has been confirmed to work with very minor changes. Note that the toolbox seems to be out-of-date for some features, so don't expect everything to work even with COM (e.g. Google Maps integration seem broken).
49+
50+
**As a general advice (valid for COM and DSS_MATLAB), avoid using the `get` function without parameters on OpenDSS classes. Some properties like `First` and `Next` used for iteration of elements change the current active element and can lead to misleading data!**
51+
52+
## Known differences and more
53+
54+
We maintain a list of important differences between the official COM implementation and DSS C-API at:
55+
56+
https://github.com/dss-extensions/dss_capi/blob/master/docs/known_differences.md
57+
58+
Most of these apply indirectly to DSS_MATLAB.
59+
60+
The [list of important changes](https://github.com/dss-extensions/dss_capi/blob/master/docs/changelog.md#version-0103) through development is also useful.
61+
4862
## Credits / Acknowlegement
4963

5064
This project is derived from EPRI's OpenDSS and the same style of license (BSD style) is used. As OpenDSS, the project also depends on KLUSolve and SuiteSparse, licensed under the LGPL.

0 commit comments

Comments
 (0)