Merge pull request #110 from dss-extensions/dss_python-0.12.0

DSS Python 0.12.1

Author: PMeira

.appveyor.yml

@@ -5,6 +5,9 @@ build: false
 
 environment:
   matrix:
+    - PYTHON_VERSION: 3.10
+      TARGET_ARCH: "x64"
+      MINICONDA: C:\Miniconda3-x64
     - PYTHON_VERSION: 3.9
       TARGET_ARCH: "x64"
       MINICONDA: C:\Miniconda3-x64
@@ -17,9 +20,9 @@ environment:
     - PYTHON_VERSION: 3.6
       TARGET_ARCH: "x64"
       MINICONDA: C:\Miniconda3-x64
-    - PYTHON_VERSION: 3.5
-      TARGET_ARCH: "x64"
-      MINICONDA: C:\Miniconda3-x64
+    - PYTHON_VERSION: 3.10
+      TARGET_ARCH: "x86"
+      MINICONDA: C:\Miniconda3
     - PYTHON_VERSION: 3.9
       TARGET_ARCH: "x86"
       MINICONDA: C:\Miniconda3
@@ -32,9 +35,6 @@ environment:
     - PYTHON_VERSION: 3.6
       TARGET_ARCH: "x86"
       MINICONDA: C:\Miniconda3
-    - PYTHON_VERSION: 3.5
-      TARGET_ARCH: "x86"
-      MINICONDA: C:\Miniconda3
 
 install:
   - "set PATH=%MINICONDA%;%MINICONDA%\\Scripts;%PATH%"

opendssdirect/ActiveClass.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import lib, codec, CheckForError, get_string, get_string_array
 
 
@@ -51,6 +49,20 @@ def ActiveClassParent():
     return get_string(CheckForError(lib.ActiveClass_Get_ActiveClassParent()))
 
 
+def ToJSON(options=0):
+    """
+    Returns the data (as a list) of all elements from the active class as a JSON-encoded string.
+
+    The `options` parameter contains bit-flags to toggle specific features.
+    See `Obj_ToJSON` (C-API) for more.
+
+    Additionally, the `ExcludeDisabled` flag can be used to excluded disabled elements from the output.
+
+    (API Extension)
+    """
+    return get_string(CheckForError(lib.ActiveClass_ToJSON(options)))
+
+
 _columns = ["ActiveClassName", "Name", "NumElements", "ActiveClassParent"]
 __all__ = [
     "ActiveClassName",
@@ -61,4 +73,5 @@ def ActiveClassParent():
     "Next",
     "NumElements",
     "ActiveClassParent",
+    "ToJSON",
 ]

opendssdirect/Basic.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import lib, codec, CheckForError, get_string, get_string_array
 
 
@@ -124,10 +122,12 @@ def LegacyModels(*args):
     or contact the authors from DSS Extensions: https://github.com/dss-extensions/
 
     After toggling LegacyModels, run a "clear" command and the models will be loaded accordingly.
-    Defaults to False. 
+    Defaults to False.
 
     This can also be enabled by setting the environment variable DSS_CAPI_LEGACY_MODELS to 1.
 
+    NOTE: this option will be removed in a future release.
+
     (API Extension)
     """
     # Getter
@@ -136,7 +136,31 @@ def LegacyModels(*args):
 
     # Setter
     Value, = args
-    return CheckForError(lib.DSS_Set_LegacyModels(Value))
+    CheckForError(lib.DSS_Set_LegacyModels(Value))
+
+
+def AllowChangeDir(*args):
+    """
+    If disabled, the engine will not change the active working directory during execution. E.g. a "compile"
+    command will not "chdir" to the file path.
+
+    If you have issues with long paths, enabling this might help in some scenarios.
+
+    Defaults to True (allow changes, backwards compatible) in the 0.10.x versions of DSS C-API.
+    This might change to False in future versions.
+
+    This can also be set through the environment variable DSS_CAPI_ALLOW_CHANGE_DIR. Set it to 0 to
+    disallow changing the active working directory.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.DSS_Get_AllowChangeDir()) != 0
+
+    # Setter
+    Value, = args
+    CheckForError(lib.DSS_Set_AllowChangeDir(Value))
 
 
 _columns = [
@@ -167,4 +191,5 @@ def LegacyModels(*args):
     "NewCircuit",
     "AllowEditor",
     "LegacyModels",
+    "AllowChangeDir",
 ]

opendssdirect/Bus.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import (
     lib,
     CheckForError,
@@ -231,6 +229,8 @@ def AllPDEatBus():
     "PuVoltage",
     "X",
     "Y",
+    "AllPCEatBus",
+    "AllPDEatBus",
 ]
 __all__ = [
     "AllPCEatBus",

opendssdirect/CNData.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import lib, codec, CheckForError, get_string, get_string_array
 
 

opendssdirect/CapControls.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import lib, codec, CheckForError, get_string, get_string_array
 
 

opendssdirect/Capacitors.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import (
     lib,
     codec,

opendssdirect/Circuit.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import (
     lib,
     codec,
@@ -205,7 +203,7 @@ def SystemY():
 
 
 def TotalPower():
-    """(read-only) Total power, kw delivered to the circuit"""
+    """(read-only) Total power, kW delivered to the circuit"""
     return get_float64_array(lib.Circuit_Get_TotalPower)
 
 

opendssdirect/CktElement.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 import warnings
 from ._utils import (
     lib,
@@ -306,6 +304,23 @@ def IsIsolated():
     return CheckForError(lib.CktElement_Get_IsIsolated()) != 0
 
 
+def setVariableByIndex(Idx, Value):
+    Code = ffi.new("int32_t*")
+    CheckForError(lib.CktElement_Set_Variablei(Idx, Code, Value))
+    return Code[0]
+
+
+def setVariableByName(Idx, Value):
+    Code = ffi.new("int32_t*")
+    CheckForError(lib.CktElement_Set_Variable(Idx, Code, Value))
+    return Code[0]
+
+
+def NodeRef():
+    """Array of integers, a copy of the internal NodeRef of the CktElement."""
+    return get_int32_array(lib.CktElement_Get_NodeRef)
+
+
 _columns = [
     "BusNames",
     "CplxSeqCurrents",
@@ -394,4 +409,7 @@ def IsIsolated():
     "VoltagesMagAng",
     "YPrim",
     "IsIsolated",
+    "setVariableByIndex",
+    "setVariableByName",
+    "NodeRef",
 ]

opendssdirect/CmathLib.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import
 from ._utils import lib, get_float64_array