Skip to content

Commit 7dd87c9

Browse files
committed
Update version and README.md, remove README.pdf
1 parent 5df4288 commit 7dd87c9

File tree

4 files changed

+15
-19
lines changed

4 files changed

+15
-19
lines changed

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
--------------------------------------------------
2-
dss_python: Unofficial bindings for EPRI's OpenDSS
3-
--------------------------------------------------
1+
# dss_python: Unofficial bindings for EPRI's OpenDSS
42

53
Python bindings and misc tools for using OpenDSS (EPRI Distribution System Simulator). Based on CFFI and `dss_capi`, aiming for full COM compatibility on Windows and Linux.
64

75
If you are looking for the C API library, see [`dss_capi`](http://github.com/PMeira/dss_capi/).
86

9-
Version 0.9.7, based on [OpenDSS revision 2152](https://sourceforge.net/p/electricdss/code/2152/tree/).
7+
Version 0.9.8, based on OpenDSS revision 2246.
108
This is a work-in-progress but it's deemed stable enough to be made public.
119
*Note that, while the interface with OpenDSS is stable (classic version), the OpenDSS-PM (actor-based parallel machine version) interface was integrated recently and is experimental.*
1210

@@ -15,8 +13,9 @@ Most of the COM documentation can be used as-is, but instead of returning tuples
1513

1614
This module depends on CFFI, NumPy and, optionally, SciPy.Sparse for reading the sparse system admittance matrix.
1715

18-
Recent changes
19-
==============
16+
## Recent changes
17+
18+
- 2018-08-10 / version 0.9.8: Reorganize modules (v7 and v8), adds 8 missing methods and new backend methods for OpenDSSDirect.py v0.3+. Integrates many fixes from DSS_CAPI and the upstream OpenDSS.
2019
- 2018-04-30 / version 0.9.7: Fix some of the setters that used array data.
2120
- 2018-04-05 / version 0.9.6: Adds missing `ActiveCircuit.CktElements[index]` (or `...CktElements(index)`) and `ActiveCircuit.Buses[index]` (or `...Buses(index)`).
2221
- 2018-03-07 / version 0.9.4: Allows using `len` on several classes, fixes DSSProperty, and includes COM helpstrings as docstrings. Contains changes up to OpenDSS revision 2152.
@@ -25,8 +24,7 @@ Recent changes
2524
- 2018-02-08 / version 0.9.1: First public release (OpenDSS revision 2123)
2625

2726

28-
Missing features and limitations
29-
================================
27+
## Missing features and limitations
3028

3129
Most limitations are inherited from `dss_capi`, i.e.:
3230

@@ -35,19 +33,18 @@ Most limitations are inherited from `dss_capi`, i.e.:
3533
- `DSSEvents` from `DLL/ImplEvents.pas`: seems too dependent on COM.
3634
- `DSSProgress` from `DLL/ImplDSSProgress.pas`: would need a reimplementation depending on the target UI (GUI, text, headless, etc.)
3735

38-
- Although tests were successful on openSuse 42.3 (both CPython 3.6 and PyPy3.5 v5.10.1), Linux binaries are not yet available. For the time being, you need to build them yourself.
36+
- Although tests were successful on openSuse 42.3 (both CPython 3.6 and PyPy3.5 v5.10.1).
3937

40-
Extra features
41-
==============
38+
## Extra features
39+
4240
Besides most of the COM methods, some of the unique DDLL methods are also exposed in adapted forms, namely the methods from `DYMatrix.pas`, especially `GetCompressedYMatrix` (check the source files for more information).
4341

4442
Since no GUI components are used in the FreePascal DLL, we are experimenting with different ways of handling OpenDSS errors. Currently, the `DSS.Text.Command` call checks for OpenDSS errors (through the `DSS.Error` interface) and converts those to Python exceptions. Ideally every error should be converted to Python exceptions, but that could negatively impact performance. You can manually trigger an error check by calling the function `CheckForError()` from the main module.
4543

4644

47-
Installing
48-
==========
45+
## Installing
4946

50-
On Windows (64-bit Python 2.7 and 3.6), you can install directly from pip:
47+
On Windows (Python 2.7, 3.6 and 3.7), you can install directly from pip:
5148

5249
```
5350
pip install dss_python
@@ -56,8 +53,7 @@ pip install dss_python
5653
If successful, you can then import the `dss` module from your Python interpreter.
5754

5855

59-
Building
60-
========
56+
## Building
6157

6258
Get this repository:
6359

@@ -70,7 +66,7 @@ Assuming you successfully built or downloaded the `dss_capi` (check [its reposit
7066
```
7167
dss_capi/
7268
dss_python/
73-
electricdss/
69+
electricdss-src/
7470
```
7571

7672
Open a command prompt in the `dss_python` subfolder and run the build process:

README.pdf

-130 KB
Binary file not shown.

dss/v7/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
from ..enums import *
88
from .. import enums
99

10-
__version__ = '0.9.7'
10+
__version__ = '0.9.8'

dss/v8/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
from ..enums import *
88
from .. import enums
99

10-
__version__ = '0.9.7'
10+
__version__ = '0.9.8'

0 commit comments

Comments
 (0)