Skip to content

Commit

Permalink
Update README, changelog and build for 0.12.1
Browse files Browse the repository at this point in the history
  • Loading branch information
PMeira committed Jul 16, 2022
1 parent 7311fc8 commit d3bb4c5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/builds.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Builds
# TODO: generalize steps

env:
DSS_CAPI_TAG: '0.12.0'
DSS_CAPI_TAG: '0.12.1'
ARTIFACTS_FOLDER: '${{ github.workspace }}/artifacts'

on:
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ See also the other projects from [DSS-Extensions.org](https://dss-extensions.org
- [DSS Sharp](http://github.com/dss-extensions/dss_sharp/): available for .NET/C#, also mimics the COM classes, but Windows-only at the moment. Soon it will be possible to use it via COM too.
- [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.

Version 0.12.0 is based on OpenDSS revision 3460 (few commits after OpenDSS v9.4.1.2). While we plan to add a lot more funcionality into DSS Python, the main goal of creating a COM-compatible API has been reached. If you find an unexpected missing feature, please report it! Currently missing features that will be implemented eventualy are plotting (partial implementation available) and diakoptics (planned for future version).
Version 0.12.1 is based on OpenDSS revision 3460 (few commits after OpenDSS v9.4.1.2). While we plan to add a lot more funcionality into DSS Python, the main goal of creating a COM-compatible API has been reached. If you find an unexpected missing feature, please report it! Currently missing features that will be implemented eventualy are plotting (partial implementation available) and diakoptics (planned for future version).

This module mimics the COM structure (as exposed via `win32com` or `comtypes`), effectively enabling multi-platform compatibility at Python level. Compared to other options, it provides easier migration from code that uses the official OpenDSS through COM.
Most of the COM documentation can be used as-is, but instead of returning tuples or lists, this modules returns/accepts NumPy arrays for numeric data exchange, which is usually preferred by the users.
Expand All @@ -24,6 +24,7 @@ The module depends on CFFI, NumPy and, optionally, SciPy.Sparse for reading the

## Brief release history

- 2022-07-16 / version 0.12.1: Very minor release to address a bug found in v0.12.0, to add the Storages API, and include the property descriptions/help.
- **2022-07-14 / version 0.12.0:** Major release merging parallel features, multiple DSS engine instances, ZIP file support, incremental Y matrix updates, new API functions, partial plotting support, better performance, and so on. General usage examples for the new features will be incrementally added to https://github.com/dss-extensions/dss-extensions
- 2021-03-09 / version 0.10.7-1: Very minor release to fix issues with some of the energy meter reports.
- 2020-12-28 / version 0.10.7: Maintenance release to match DSS C-API 0.10.7, based on on OpenDSS revision 2963. Includes fixes and new features from the official OpenDSS.
Expand Down
6 changes: 6 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# 0.12.1

- Expose `Storages` in Python
- Include the missing property descriptions from 0.12.0
- Use DSS C-API v0.12.1 for some incremental fixes

# 0.12.0

- Removed CmathLib: not useful in Python or most programming languages targetted by DSS Extensions.
Expand Down

0 comments on commit d3bb4c5

Please sign in to comment.