Skip to content

Commit 6700712

Browse files
committed
[skip ci] docs: Add docstrings for ZIP and YMatrix
1 parent 55f3597 commit 6700712

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

dss/IYMatrix.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77
from typing import Tuple, List
88

99
class IYMatrix(Base):
10+
'''
11+
YMatrix provides access to some lower-level solution aspects.
12+
13+
Part of this class is ported from the original OpenDSSDirect.DLL back in 2017, but
14+
part is new. Since this is not exposed in the official COM API, it is marked as an extension.
15+
16+
(**API Extension**)
17+
'''
18+
1019
__slots__ = []
1120

1221
def GetCompressedYMatrix(self, factor: bool = True) -> Tuple[ComplexArray, Int32Array, Int32Array]:

dss/IZIP.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
from typing import AnyStr, Optional, List
55

66
class IZIP(Base):
7+
'''
8+
ZIP allows controlling the ZIP-compressed file functions from AltDSS/DSS C-API.
9+
10+
It allows opening a ZIP file, and loading circuits directly from it, without requiring extracting the contents to files before reading.
11+
12+
The implementation provides a specialization which allows more efficient access if the ZIP file is open and reused for many circuits.
13+
Doing so reduces the overhead of the initial opening and indexing of the file contents.
14+
15+
(**API Extension**)
16+
'''
17+
718
__slots__ = []
819

920
_columns = []

0 commit comments

Comments
 (0)