py-dss-toolkit 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (258) hide show
  1. py_dss_toolkit-0.1.0/.appveyor.yml +35 -0
  2. py_dss_toolkit-0.1.0/.bumpversion.cfg +16 -0
  3. py_dss_toolkit-0.1.0/.cookiecutterrc +71 -0
  4. py_dss_toolkit-0.1.0/.coveragerc +16 -0
  5. py_dss_toolkit-0.1.0/.editorconfig +20 -0
  6. py_dss_toolkit-0.1.0/.gitignore +84 -0
  7. py_dss_toolkit-0.1.0/.pre-commit-config.yaml +20 -0
  8. py_dss_toolkit-0.1.0/.readthedocs.yml +10 -0
  9. py_dss_toolkit-0.1.0/.travis.yml +51 -0
  10. py_dss_toolkit-0.1.0/AUTHORS.rst +7 -0
  11. py_dss_toolkit-0.1.0/CHANGELOG.rst +8 -0
  12. py_dss_toolkit-0.1.0/CONTRIBUTING.rst +91 -0
  13. py_dss_toolkit-0.1.0/LICENSE +9 -0
  14. py_dss_toolkit-0.1.0/MANIFEST.in +18 -0
  15. py_dss_toolkit-0.1.0/PKG-INFO +30 -0
  16. py_dss_toolkit-0.1.0/README.md +168 -0
  17. py_dss_toolkit-0.1.0/ci/bootstrap.py +89 -0
  18. py_dss_toolkit-0.1.0/ci/requirements.txt +4 -0
  19. py_dss_toolkit-0.1.0/ci/templates/.appveyor.yml +49 -0
  20. py_dss_toolkit-0.1.0/ci/templates/.travis.yml +47 -0
  21. py_dss_toolkit-0.1.0/docs/authors.rst +1 -0
  22. py_dss_toolkit-0.1.0/docs/changelog.rst +1 -0
  23. py_dss_toolkit-0.1.0/docs/conf.py +47 -0
  24. py_dss_toolkit-0.1.0/docs/contributing.rst +1 -0
  25. py_dss_toolkit-0.1.0/docs/index.rst +21 -0
  26. py_dss_toolkit-0.1.0/docs/installation.rst +7 -0
  27. py_dss_toolkit-0.1.0/docs/readme.rst +1 -0
  28. py_dss_toolkit-0.1.0/docs/reference/index.rst +7 -0
  29. py_dss_toolkit-0.1.0/docs/reference/py_dss_tools.rst +9 -0
  30. py_dss_toolkit-0.1.0/docs/requirements.txt +2 -0
  31. py_dss_toolkit-0.1.0/docs/spelling_wordlist.txt +11 -0
  32. py_dss_toolkit-0.1.0/docs/usage.rst +7 -0
  33. py_dss_toolkit-0.1.0/examples/dss_tools/circuit_interactive_view.ipynb +141167 -0
  34. py_dss_toolkit-0.1.0/examples/dss_tools/circuit_interactive_view.py +59 -0
  35. py_dss_toolkit-0.1.0/examples/dss_tools/models.ipynb +1755 -0
  36. py_dss_toolkit-0.1.0/examples/dss_tools/models.py +68 -0
  37. py_dss_toolkit-0.1.0/examples/dss_tools/qsts_results.ipynb +1299 -0
  38. py_dss_toolkit-0.1.0/examples/dss_tools/qsts_results.py +44 -0
  39. py_dss_toolkit-0.1.0/examples/dss_tools/snapshot_results.ipynb +458 -0
  40. py_dss_toolkit-0.1.0/examples/dss_tools/snapshot_results.py +53 -0
  41. py_dss_toolkit-0.1.0/examples/dss_tools/voltage_profile_dss_view.ipynb +237 -0
  42. py_dss_toolkit-0.1.0/examples/dss_tools/voltage_profile_interactive_view.ipynb +99068 -0
  43. py_dss_toolkit-0.1.0/examples/dss_tools/voltage_profile_static_view.ipynb +368 -0
  44. py_dss_toolkit-0.1.0/examples/dss_tools/voltage_profile_static_view.py +41 -0
  45. py_dss_toolkit-0.1.0/examples/feeders/123Bus/BusCoords.dat +130 -0
  46. py_dss_toolkit-0.1.0/examples/feeders/123Bus/CircuitPlottingScripts.dss +25 -0
  47. py_dss_toolkit-0.1.0/examples/feeders/123Bus/IEEE123Loads.DSS +100 -0
  48. py_dss_toolkit-0.1.0/examples/feeders/123Bus/IEEE123Master.dss +221 -0
  49. py_dss_toolkit-0.1.0/examples/feeders/123Bus/IEEE123Regulators.DSS +18 -0
  50. py_dss_toolkit-0.1.0/examples/feeders/123Bus/IEEELineCodes.DSS +213 -0
  51. py_dss_toolkit-0.1.0/examples/feeders/123Bus/P174_Run_SolarRamp.DSS +38 -0
  52. py_dss_toolkit-0.1.0/examples/feeders/123Bus/P174_Run_VoltageProfile.DSS +29 -0
  53. py_dss_toolkit-0.1.0/examples/feeders/123Bus/PV5sdata1.csv +4321 -0
  54. py_dss_toolkit-0.1.0/examples/feeders/123Bus/PaperLoadShape.txt +8760 -0
  55. py_dss_toolkit-0.1.0/examples/feeders/123Bus/RevRegTest.dss +51 -0
  56. py_dss_toolkit-0.1.0/examples/feeders/123Bus/Run_IEEE123Bus.DSS +113 -0
  57. py_dss_toolkit-0.1.0/examples/feeders/123Bus/Run_YearlySim.dss +53 -0
  58. py_dss_toolkit-0.1.0/examples/feeders/123Bus/SetDailyLoadShape.DSS +91 -0
  59. py_dss_toolkit-0.1.0/examples/feeders/123Bus/SolarRamp-Mack.DSS +63 -0
  60. py_dss_toolkit-0.1.0/examples/feeders/123Bus/SolarRamp.DSS +53 -0
  61. py_dss_toolkit-0.1.0/examples/feeders/123Bus/SolarRamp.csv +300 -0
  62. py_dss_toolkit-0.1.0/examples/feeders/123Bus/StorageRamp.CSV +300 -0
  63. py_dss_toolkit-0.1.0/examples/feeders/123Bus/WindRamp.DSS +39 -0
  64. py_dss_toolkit-0.1.0/examples/feeders/123Bus/WindRampRevRegTest.DSS +59 -0
  65. py_dss_toolkit-0.1.0/examples/feeders/13bus/IEEE13Node_BusXY.csv +18 -0
  66. py_dss_toolkit-0.1.0/examples/feeders/13bus/IEEE13Nodeckt.dss +176 -0
  67. py_dss_toolkit-0.1.0/examples/feeders/13bus/IEEELineCodes.DSS +213 -0
  68. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/000_master.dss +27 -0
  69. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/000_master_py.dss +27 -0
  70. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/001_circuito.dss +1 -0
  71. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/002_condutores.dss +984 -0
  72. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/003_curvaCargaBT.dss +156 -0
  73. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/003_curvaCargaMT.dss +18 -0
  74. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/004_chavesMT.dss +144 -0
  75. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/005_segmentoMT.dss +3615 -0
  76. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/006_reguladorMT.dss +6 -0
  77. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/007_transformadores.dss +3432 -0
  78. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/008_segmentoBT.dss +2824 -0
  79. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/009_segmentoRamalBT.dss +2208 -0
  80. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/010_energyMeters.dss +1 -0
  81. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/011_tensaoBase.dss +2 -0
  82. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/012_cargasBT_1_1.dss +4918 -0
  83. py_dss_toolkit-0.1.0/examples/feeders/1_ALPE_1/012_cargasMT_1_1.dss +14 -0
  84. py_dss_toolkit-0.1.0/examples/feeders/4Bus-DY-Bal_modified.DSS +68 -0
  85. py_dss_toolkit-0.1.0/examples/studies/comparing_2_models.py +29 -0
  86. py_dss_toolkit-0.1.0/examples/studies/fault_study.py +23 -0
  87. py_dss_toolkit-0.1.0/examples/studies/model_verification.py +36 -0
  88. py_dss_toolkit-0.1.0/examples/studies/snapshot.py +36 -0
  89. py_dss_toolkit-0.1.0/examples/studies/timeseries.py +38 -0
  90. py_dss_toolkit-0.1.0/pyproject.toml +44 -0
  91. py_dss_toolkit-0.1.0/setup.cfg +33 -0
  92. py_dss_toolkit-0.1.0/src/py_dss_toolkit/__init__.py +12 -0
  93. py_dss_toolkit-0.1.0/src/py_dss_toolkit/algorithms/LoadAllocation/__init__.py +5 -0
  94. py_dss_toolkit-0.1.0/src/py_dss_toolkit/algorithms/LoadAllocation/load_allocation.py +38 -0
  95. py_dss_toolkit-0.1.0/src/py_dss_toolkit/algorithms/__init__.py +5 -0
  96. py_dss_toolkit-0.1.0/src/py_dss_toolkit/api/Creation.py +124 -0
  97. py_dss_toolkit-0.1.0/src/py_dss_toolkit/common/Enumerations.py +34 -0
  98. py_dss_toolkit-0.1.0/src/py_dss_toolkit/common/__init__.py +1 -0
  99. py_dss_toolkit-0.1.0/src/py_dss_toolkit/diagrams/ClassDiagram.puml +314 -0
  100. py_dss_toolkit-0.1.0/src/py_dss_toolkit/dss_tools/ConfigurationTools.py +20 -0
  101. py_dss_toolkit-0.1.0/src/py_dss_toolkit/dss_tools/DSSViewTools.py +16 -0
  102. py_dss_toolkit-0.1.0/src/py_dss_toolkit/dss_tools/SimulationTools.py +27 -0
  103. py_dss_toolkit-0.1.0/src/py_dss_toolkit/dss_tools/UtilitiesTools.py +23 -0
  104. py_dss_toolkit-0.1.0/src/py_dss_toolkit/dss_tools/__init__.py +7 -0
  105. py_dss_toolkit-0.1.0/src/py_dss_toolkit/dss_tools/dss_tools.py +78 -0
  106. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/BusesDataDF.py +36 -0
  107. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/ElementData.py +108 -0
  108. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/ElementDataDFs.py +75 -0
  109. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/ModelBase.py +24 -0
  110. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/ModelUtils.py +26 -0
  111. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/SegmentsDF.py +59 -0
  112. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/SummaryModelData.py +97 -0
  113. py_dss_toolkit-0.1.0/src/py_dss_toolkit/model/__init__.py +2 -0
  114. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/CapacitorControlVoltage.py +104 -0
  115. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/Isolated.py +81 -0
  116. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/LoadsTransformerVoltage.py +218 -0
  117. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/ModelVerificationResults.py +73 -0
  118. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/PDBusOder.py +98 -0
  119. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/PhasesConnections.py +443 -0
  120. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/PhasesConnections_PDelements.py +286 -0
  121. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/RegulatorControlVoltage.py +124 -0
  122. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/RegulatorkVA.py +76 -0
  123. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/SameBus.py +39 -0
  124. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/Summary.py +110 -0
  125. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/TransformerData.py +40 -0
  126. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ModelVerification/__init__.py +6 -0
  127. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/Results.py +19 -0
  128. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ShortCircuit/FaultResults.py +16 -0
  129. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ShortCircuit/ShortCircuitCurrents.py +15 -0
  130. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ShortCircuit/ShortCircuitImpedances.py +51 -0
  131. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/ShortCircuit/__init__.py +6 -0
  132. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/CircuitSnapShotPowerFlowResults.py +37 -0
  133. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/Currents.py +86 -0
  134. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/Powers.py +87 -0
  135. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/SnapShotPowerFlowResults.py +21 -0
  136. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/VoltagesElement.py +110 -0
  137. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/VoltagesNodal.py +52 -0
  138. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/SnapShot/__init__.py +6 -0
  139. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/TimeSeries/Energymeters.py +44 -0
  140. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/TimeSeries/Monitor.py +37 -0
  141. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/TimeSeries/TimeSeriesPowerFlowResults.py +27 -0
  142. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/TimeSeries/__init__.py +6 -0
  143. py_dss_toolkit-0.1.0/src/py_dss_toolkit/results/__init__.py +1 -0
  144. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/SnapShotPowerFlow/StudySnapShotPowerFlow.py +67 -0
  145. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/SnapShotPowerFlow/StudySnapShotPowerFlowSettings.py +44 -0
  146. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/SnapShotPowerFlow/__init__.py +0 -0
  147. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/StudyBase.py +86 -0
  148. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/StudyFault.py +55 -0
  149. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/StudyFaultSettings.py +31 -0
  150. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/StudyModelVerification.py +21 -0
  151. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/StudyModelVerificationSettings.py +18 -0
  152. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/StudySettings.py +45 -0
  153. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/TimeSeriesPowerFlow/StudyTimeSeriesPowerFlow.py +97 -0
  154. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/TimeSeriesPowerFlow/StudyTimeSeriesPowerFlowSettings.py +72 -0
  155. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/TimeSeriesPowerFlow/__init__.py +0 -0
  156. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/__init__.py +5 -0
  157. py_dss_toolkit-0.1.0/src/py_dss_toolkit/studies/settings_utils.py +64 -0
  158. py_dss_toolkit-0.1.0/src/py_dss_toolkit/utils/Utils.py +36 -0
  159. py_dss_toolkit-0.1.0/src/py_dss_toolkit/utils/__init__.py +7 -0
  160. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/__init__.py +6 -0
  161. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/SnapShot/DSSViewSnapShotPowerFlowResults.py +14 -0
  162. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/SnapShot/DSSVoltageProfile.py +21 -0
  163. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/SnapShot/__init__.py +6 -0
  164. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/TimeSeries/DSSMonitor.py +55 -0
  165. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/TimeSeries/DSSViewTimeSeriesPowerFlowResults.py +16 -0
  166. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/TimeSeries/__init__.py +6 -0
  167. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/ViewResults.py +16 -0
  168. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/dss_view/__init__.py +6 -0
  169. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/InteractiveCustomPlotStyle.py +49 -0
  170. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/ActivePowerSettings.py +13 -0
  171. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/BaseSettingsNumerical.py +17 -0
  172. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/Circuit.py +398 -0
  173. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/CircuitBusMarker.py +16 -0
  174. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/PhasesSettings.py +19 -0
  175. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/UserDefinedCategoricalSettings.py +24 -0
  176. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/UserDefinedNumericalSettings.py +26 -0
  177. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/ViewCircuitResults.py +19 -0
  178. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/VoltageSettings.py +14 -0
  179. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/Circuit/__init__.py +6 -0
  180. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/InteractiveViewSnapShotPowerFlowResults.py +18 -0
  181. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/InteractiveVoltageProfile.py +143 -0
  182. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/InteractiveVoltageProfileBusMarker.py +19 -0
  183. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/SnapShot/__init__.py +6 -0
  184. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/TimeSeries/InteractiveMonitor.py +143 -0
  185. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/TimeSeries/InteractiveViewTimeSeriesPowerFlowResults.py +17 -0
  186. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/TimeSeries/__init__.py +6 -0
  187. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/ViewResults.py +23 -0
  188. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/interactive_view/__init__.py +6 -0
  189. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/ShortCircuit/ShortCircuitImpedances.py +71 -0
  190. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/ShortCircuit/ViewFaultStudy.py +17 -0
  191. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/ShortCircuit/__init__.py +6 -0
  192. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/SnapShot/StaticViewSnapShotPowerFlowResults.py +15 -0
  193. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/SnapShot/StaticVoltageProfile.py +125 -0
  194. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/SnapShot/StaticVoltageProfileBusMarker.py +17 -0
  195. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/SnapShot/__init__.py +6 -0
  196. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/StaticCustomPlotStyle.py +98 -0
  197. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/TimeSeries/StaticMonitor.py +134 -0
  198. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/TimeSeries/StaticViewTimeSeriesPowerFlowResults.py +17 -0
  199. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/TimeSeries/__init__.py +6 -0
  200. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/ViewResults.py +23 -0
  201. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/static_view/__init__.py +5 -0
  202. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/view_base/MonitorBase.py +72 -0
  203. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/view_base/VoltageProfileBase.py +45 -0
  204. py_dss_toolkit-0.1.0/src/py_dss_toolkit/view/view_base/__init__.py +6 -0
  205. py_dss_toolkit-0.1.0/src/py_dss_toolkit.egg-info/PKG-INFO +30 -0
  206. py_dss_toolkit-0.1.0/src/py_dss_toolkit.egg-info/SOURCES.txt +257 -0
  207. py_dss_toolkit-0.1.0/src/py_dss_toolkit.egg-info/dependency_links.txt +1 -0
  208. py_dss_toolkit-0.1.0/src/py_dss_toolkit.egg-info/requires.txt +4 -0
  209. py_dss_toolkit-0.1.0/src/py_dss_toolkit.egg-info/top_level.txt +1 -0
  210. py_dss_toolkit-0.1.0/src/py_dss_tools.egg-info/PKG-INFO +30 -0
  211. py_dss_toolkit-0.1.0/src/py_dss_tools.egg-info/SOURCES.txt +254 -0
  212. py_dss_toolkit-0.1.0/src/py_dss_tools.egg-info/dependency_links.txt +1 -0
  213. py_dss_toolkit-0.1.0/src/py_dss_tools.egg-info/requires.txt +4 -0
  214. py_dss_toolkit-0.1.0/src/py_dss_tools.egg-info/top_level.txt +1 -0
  215. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/cases/13bus/IEEE13Node_BusXY.csv +18 -0
  216. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/cases/13bus/IEEE13Nodeckt.dss +176 -0
  217. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/cases/13bus/IEEELineCodes.DSS +213 -0
  218. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/cases/4Bus-YY-Bal/4Bus-YY-Bal.DSS +48 -0
  219. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/conftest.py +30 -0
  220. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/buses_df_13bus.parquet +0 -0
  221. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/element_data_df_13bus.parquet +0 -0
  222. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/lines_df_13bus.parquet +0 -0
  223. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_ang_currents_elements_13bus.parquet +0 -0
  224. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_ang_voltages_elements_13bus.parquet +0 -0
  225. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_energymeters_13bus.parquet +0 -0
  226. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_mag_currents_elements_13bus.parquet +0 -0
  227. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_mag_voltages_elements_13bus.parquet +0 -0
  228. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_monitor_0_13bus.parquet +0 -0
  229. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_monitor_1_13bus.parquet +0 -0
  230. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_p_power_elements_13bus.parquet +0 -0
  231. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_q_power_elements_13bus.parquet +0 -0
  232. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_summary_df_13bus.parquet +0 -0
  233. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_vang_ln_nodes_13bus.parquet +0 -0
  234. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/results_vmag_ln_nodes_13bus.parquet +0 -0
  235. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/segments_df_13bus.parquet +0 -0
  236. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/snapshot_settings_13bus.csv +5 -0
  237. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/summary_df_13bus.parquet +0 -0
  238. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/expected_outputs/timeseries_settings_13bus.csv +6 -0
  239. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_add_element.py +16 -0
  240. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_add_line_in_vsource.py +77 -0
  241. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_buses_df.py +25 -0
  242. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_get_element_properties_df.py +44 -0
  243. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_is_element_in_model.py +18 -0
  244. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_lines_df.py +25 -0
  245. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_segments_df.py +30 -0
  246. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_model_summary_df.py +25 -0
  247. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_currents_elements.py +41 -0
  248. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_energymeters.py +22 -0
  249. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_monitor_mode_0.py +26 -0
  250. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_monitor_mode_1.py +26 -0
  251. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_powers_elements.py +41 -0
  252. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_summary.py +33 -0
  253. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_voltage_ln_nodes.py +41 -0
  254. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_results_voltages_elements.py +41 -0
  255. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_snapshot_settings.py +29 -0
  256. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/test_timeseries_settings.py +85 -0
  257. py_dss_toolkit-0.1.0/tests/py_dss_toolkit/untils.py +5 -0
  258. py_dss_toolkit-0.1.0/tox.ini +94 -0
@@ -0,0 +1,35 @@
1
+ version: '{branch}-{build}'
2
+ build: off
3
+ environment:
4
+ matrix:
5
+ - TOXENV: py310,codecov
6
+ TOXPYTHON: C:\Python310-x64\python.exe
7
+ PYTHON_HOME: C:\Python310-x64
8
+ PYTHON_VERSION: '3.10'
9
+ PYTHON_ARCH: '64'
10
+ - TOXENV: py311,codecov
11
+ TOXPYTHON: C:\Python311-x64\python.exe
12
+ PYTHON_HOME: C:\Python311-x64
13
+ PYTHON_VERSION: '3.11'
14
+ PYTHON_ARCH: '64'
15
+ - TOXENV: py312,codecov
16
+ TOXPYTHON: C:\Python312-x64\python.exe
17
+ PYTHON_HOME: C:\Python312-x64
18
+ PYTHON_VERSION: '3.12'
19
+ PYTHON_ARCH: '64'
20
+ init:
21
+ - ps: echo $env:TOXENV
22
+ - ps: ls C:\Python*
23
+ install:
24
+ - '%PYTHON_HOME%\python -mpip install --progress-bar=off tox -rci/requirements.txt'
25
+ - '%PYTHON_HOME%\Scripts\virtualenv --version'
26
+ - '%PYTHON_HOME%\Scripts\pip --version'
27
+ - '%PYTHON_HOME%\Scripts\tox --version'
28
+ test_script:
29
+ - cmd /E:ON /V:ON /C .\ci\appveyor-with-compiler.cmd %PYTHON_HOME%\Scripts\tox
30
+ on_failure:
31
+ - ps: dir "env:"
32
+ - ps: get-content .tox\*\log\*
33
+ ### To enable remote debugging uncomment this (also, see: http://www.appveyor.com/docs/how-to/rdp-to-build-worker):
34
+ # on_finish:
35
+ # - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
@@ -0,0 +1,16 @@
1
+ [bumpversion]
2
+ current_version = 0.0.0
3
+ commit = True
4
+ tag = True
5
+
6
+ [bumpversion:file:setup.py]
7
+ search = version='{current_version}'
8
+ replace = version='{new_version}'
9
+
10
+ [bumpversion:file:docs/conf.py]
11
+ search = version = release = '{current_version}'
12
+ replace = version = release = '{new_version}'
13
+
14
+ [bumpversion:file:src/py_dss_toolkit/__init__.py]
15
+ search = __version__ = '{current_version}'
16
+ replace = __version__ = '{new_version}'
@@ -0,0 +1,71 @@
1
+ # This file exists so you can easily regenerate your project.
2
+ #
3
+ # `cookiepatcher` is a convenient shim around `cookiecutter`
4
+ # for regenerating projects (it will generate a .cookiecutterrc
5
+ # automatically for any template). To use it:
6
+ #
7
+ # pip install cookiepatcher
8
+ # cookiepatcher gh:ionelmc/cookiecutter-pylibrary py-dss-tools
9
+ #
10
+ # See:
11
+ # https://pypi.org/project/cookiepatcher
12
+ #
13
+ # Alternatively, you can run:
14
+ #
15
+ # cookiecutter --overwrite-if-exists --config-file=py-dss-tools/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary
16
+
17
+ default_context:
18
+
19
+ _extensions: ['jinja2_time.TimeExtension']
20
+ _template: 'gh:ionelmc/cookiecutter-pylibrary'
21
+ allow_tests_inside_package: 'no'
22
+ appveyor: 'yes'
23
+ c_extension_function: 'longest'
24
+ c_extension_module: '_py_dss_tools'
25
+ c_extension_optional: 'no'
26
+ c_extension_support: 'no'
27
+ c_extension_test_pypi: 'no'
28
+ c_extension_test_pypi_username: 'py_dss_tools'
29
+ codacy: 'no'
30
+ codacy_projectid: '[Get ID from https://app.codacy.com/gh/py_dss_tools/py-dss-tools/settings]'
31
+ codeclimate: 'no'
32
+ codecov: 'yes'
33
+ command_line_interface: 'no'
34
+ command_line_interface_bin_name: 'py-dss-tools'
35
+ coveralls: 'yes'
36
+ coveralls_token: '[Required for Appveyor, take it from https://coveralls.io/github/py_dss_tools/py-dss-tools]'
37
+ distribution_name: 'py-dss-tools'
38
+ email: 'paulo.radatz@gmail.com, eniocc@gmail.com, rodolfopl@gmail.com'
39
+ full_name: 'Paulo Radatz, Ênio Viana, Rodolgo Londero'
40
+ legacy_python: 'no'
41
+ license: 'MIT license'
42
+ linter: 'flake8'
43
+ package_name: 'py_dss_tools'
44
+ pre_commit: 'yes'
45
+ project_name: 'py-dss-tools'
46
+ project_short_description: 'py-dss-tools is a python package that focus on ...'
47
+ pypi_badge: 'yes'
48
+ pypi_disable_upload: 'no'
49
+ release_date: 'today'
50
+ repo_hosting: 'github.com'
51
+ repo_hosting_domain: 'https://github.com/PauloRadatz/py_dss_tools'
52
+ repo_name: 'py-dss-tools'
53
+ repo_username: 'py_dss_tools'
54
+ requiresio: 'yes'
55
+ scrutinizer: 'no'
56
+ setup_py_uses_setuptools_scm: 'no'
57
+ setup_py_uses_test_runner: 'no'
58
+ sphinx_docs: 'yes'
59
+ sphinx_docs_hosting: 'https://py-dss-tools.readthedocs.io/'
60
+ sphinx_doctest: 'no'
61
+ sphinx_theme: 'sphinx-py3doc-enhanced-theme'
62
+ test_matrix_configurator: 'no'
63
+ test_matrix_separate_coverage: 'no'
64
+ test_runner: 'pytest'
65
+ travis: 'yes'
66
+ travis_osx: 'no'
67
+ version: '0.0.0'
68
+ version_manager: 'bump2version'
69
+ website: 'https://github.com/PauloRadatz'
70
+ year_from: '2021'
71
+ year_to: '2021'
@@ -0,0 +1,16 @@
1
+ [paths]
2
+ source =
3
+ src
4
+ */site-packages
5
+
6
+ [run]
7
+ branch = true
8
+ source =
9
+ py_dss_toolkit
10
+ tests
11
+ parallel = true
12
+
13
+ [report]
14
+ show_missing = true
15
+ precision = 2
16
+ omit = *migrations*
@@ -0,0 +1,20 @@
1
+ # see https://editorconfig.org/
2
+ root = true
3
+
4
+ [*]
5
+ # Use Unix-style newlines for most files (except Windows files, see below).
6
+ end_of_line = lf
7
+ trim_trailing_whitespace = true
8
+ indent_style = space
9
+ insert_final_newline = true
10
+ indent_size = 4
11
+ charset = utf-8
12
+
13
+ [*.{bat,cmd,ps1}]
14
+ end_of_line = crlf
15
+
16
+ [*.{yml,yaml}]
17
+ indent_size = 2
18
+
19
+ [*.tsv]
20
+ indent_style = tab
@@ -0,0 +1,84 @@
1
+ *.py[cod]
2
+ __pycache__
3
+
4
+ # C extensions
5
+ *.so
6
+
7
+ # Packages
8
+ *.egg
9
+ *.egg-info
10
+ dist
11
+ build
12
+ eggs
13
+ .eggs
14
+ parts
15
+ bin
16
+ var
17
+ sdist
18
+ wheelhouse
19
+ develop-eggs
20
+ .installed.cfg
21
+ lib
22
+ lib64
23
+ venv*/
24
+ pyvenv*/
25
+ pip-wheel-metadata/
26
+
27
+ # Installer logs
28
+ pip-log.txt
29
+
30
+ # Unit test / coverage reports
31
+ .coverage
32
+ .tox
33
+ .coverage.*
34
+ .pytest_cache/
35
+ nosetests.xml
36
+ coverage.xml
37
+ htmlcov
38
+
39
+ # Translations
40
+ *.mo
41
+
42
+ # Buildout
43
+ .mr.developer.cfg
44
+
45
+ # IDE project files
46
+ .project
47
+ .pydevproject
48
+ .idea
49
+ .vscode
50
+ *.iml
51
+ *.komodoproject
52
+
53
+ # Complexity
54
+ output/*.html
55
+ output/*/index.html
56
+
57
+ # Sphinx
58
+ docs/_build
59
+
60
+ .DS_Store
61
+ *~
62
+ .*.sw[po]
63
+ .build
64
+ .ve
65
+ .env
66
+ .cache
67
+ .pytest
68
+ .benchmarks
69
+ .bootstrap
70
+ .appveyor.token
71
+ *.bak
72
+
73
+ # Mypy Cache
74
+ .mypy_cache/
75
+ /src/py_dss_toolkit/tutorials/simple/.ipynb_checkpoints/
76
+
77
+ *.puml
78
+
79
+ src/teste.txt
80
+ src/main_aux.py
81
+ src/main_eniocc.py
82
+ /classes.dot
83
+ /packages.dot
84
+ /src/main_testes_pdes.py
@@ -0,0 +1,20 @@
1
+ # To install the git pre-commit hook run:
2
+ # pre-commit install
3
+ # To update the pre-commit hooks run:
4
+ # pre-commit install-hooks
5
+ exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg)(/|$)'
6
+ repos:
7
+ - repo: https://github.com/pre-commit/pre-commit-hooks
8
+ rev: master
9
+ hooks:
10
+ - id: trailing-whitespace
11
+ - id: end-of-file-fixer
12
+ - id: debug-statements
13
+ - repo: https://github.com/timothycrosley/isort
14
+ rev: master
15
+ hooks:
16
+ - id: isort
17
+ - repo: https://gitlab.com/pycqa/flake8
18
+ rev: master
19
+ hooks:
20
+ - id: flake8
@@ -0,0 +1,10 @@
1
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
2
+ version: 2
3
+ sphinx:
4
+ configuration: docs/conf.py
5
+ formats: all
6
+ python:
7
+ install:
8
+ - requirements: docs/requirements.txt
9
+ - method: pip
10
+ path: .
@@ -0,0 +1,51 @@
1
+ language: python
2
+ dist: xenial
3
+ virt: lxd
4
+ cache: false
5
+ env:
6
+ global:
7
+ - LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so
8
+ - SEGFAULT_SIGNALS=all
9
+ - LANG=en_US.UTF-8
10
+ matrix:
11
+ include:
12
+ - python: '3.6'
13
+ env:
14
+ - TOXENV=check
15
+ - python: '3.6'
16
+ env:
17
+ - TOXENV=docs
18
+ - env:
19
+ - TOXENV=py36,codecov,coveralls
20
+ python: '3.6'
21
+ - env:
22
+ - TOXENV=py37,codecov,coveralls
23
+ python: '3.7'
24
+ - env:
25
+ - TOXENV=py38,codecov,coveralls
26
+ python: '3.8'
27
+ - env:
28
+ - TOXENV=py39,codecov,coveralls
29
+ python: '3.9'
30
+ - env:
31
+ - TOXENV=pypy3,codecov,coveralls
32
+ - TOXPYTHON=pypy3
33
+ python: 'pypy3'
34
+ before_install:
35
+ - python --version
36
+ - uname -a
37
+ - lsb_release -a || true
38
+ install:
39
+ - python -mpip install --progress-bar=off tox -rci/requirements.txt
40
+ - virtualenv --version
41
+ - pip --version
42
+ - tox --version
43
+ script:
44
+ - tox -v
45
+ after_failure:
46
+ - cat .tox/log/*
47
+ - cat .tox/*/log/*
48
+ notifications:
49
+ email:
50
+ on_success: never
51
+ on_failure: always
@@ -0,0 +1,7 @@
1
+
2
+ Authors
3
+ =======
4
+
5
+ * Paulo Radatz - https://github.com/PauloRadatz
6
+ * Ênio Viana - https://github.com/eniovianna
7
+ * Rodolfo Londero - https://github.com/rodolfoplondero
@@ -0,0 +1,8 @@
1
+
2
+ Changelog
3
+ =========
4
+
5
+ 0.0.0 (2021-05-18)
6
+ ------------------
7
+
8
+ * First release on PyPI.
@@ -0,0 +1,91 @@
1
+ ============
2
+ Contributing
3
+ ============
4
+
5
+ Contributions are welcome, and they are greatly appreciated! Every
6
+ little bit helps, and credit will always be given.
7
+
8
+ Bug reports
9
+ ===========
10
+
11
+ When `reporting a bug <https://https://github.com/PauloRadatz/py_dss_toolkit/py_dss_toolkit/py-dss-toolkit/issues>`_ please include:
12
+
13
+ * Your operating system name and version.
14
+ * Any details about your local setup that might be helpful in troubleshooting.
15
+ * Detailed steps to reproduce the bug.
16
+
17
+ Documentation improvements
18
+ ==========================
19
+
20
+ py-dss-toolkit could always use more documentation, whether as part of the
21
+ official py-dss-toolkit docs, in docstrings, or even on the web in blog posts,
22
+ articles, and such.
23
+
24
+ Feature requests and feedback
25
+ =============================
26
+
27
+ The best way to send feedback is to file an issue at https://https://github.com/PauloRadatz/py_dss_toolkit/py_dss_toolkit/py-dss-toolkit/issues.
28
+
29
+ If you are proposing a feature:
30
+
31
+ * Explain in detail how it would work.
32
+ * Keep the scope as narrow as possible, to make it easier to implement.
33
+ * Remember that this is a volunteer-driven project, and that code contributions are welcome :)
34
+
35
+ Development
36
+ ===========
37
+
38
+ To set up `py-dss-toolkit` for local development:
39
+
40
+ 1. Fork `py-dss-toolkit <https://https://github.com/PauloRadatz/py_dss_toolkit/py_dss_toolkit/py-dss-toolkit>`_
41
+ (look for the "Fork" button).
42
+ 2. Clone your fork locally::
43
+
44
+ git clone git@https://github.com/PauloRadatz/py_dss_toolkit:YOURGITHUBNAME/py-dss-toolkit.git
45
+
46
+ 3. Create a branch for local development::
47
+
48
+ git checkout -b name-of-your-bugfix-or-feature
49
+
50
+ Now you can make your changes locally.
51
+
52
+ 4. When you're done making changes run all the checks and docs builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ one command::
53
+
54
+ tox
55
+
56
+ 5. Commit your changes and push your branch to GitHub::
57
+
58
+ git add .
59
+ git commit -m "Your detailed description of your changes."
60
+ git push origin name-of-your-bugfix-or-feature
61
+
62
+ 6. Submit a pull request through the GitHub website.
63
+
64
+ Pull Request Guidelines
65
+ -----------------------
66
+
67
+ If you need some code review or feedback while you're developing the code just make the pull request.
68
+
69
+ For merging, you should:
70
+
71
+ 1. Include passing tests (run ``tox``) [1]_.
72
+ 2. Update documentation when there's new API, functionality etc.
73
+ 3. Add a note to ``CHANGELOG.rst`` about the changes.
74
+ 4. Add yourself to ``AUTHORS.rst``.
75
+
76
+ .. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
77
+ `run the tests <https://travis-ci.com/github/py_dss_toolkit/py-dss-toolkit/pull_requests>`_
78
+ for each change you add in the pull request.
79
+
80
+ It will be slower though ...
81
+
82
+ Tips
83
+ ----
84
+
85
+ To run a subset of tests::
86
+
87
+ tox -e envname -- pytest -k test_myfeature
88
+
89
+ To run all the test environments in *parallel*::
90
+
91
+ tox -p auto
@@ -0,0 +1,9 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025, Paulo Radatz
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
+
7
+ The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
8
+
9
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,18 @@
1
+ graft docs
2
+ graft src
3
+ graft ci
4
+ graft tests
5
+ include .bumpversion.cfg
6
+ include .coveragerc
7
+ include .cookiecutterrc
8
+ include .editorconfig
9
+
10
+ include AUTHORS.rst
11
+ include CHANGELOG.rst
12
+ include CONTRIBUTING.rst
13
+ include LICENSE
14
+ include README.rst
15
+
16
+ include tox.ini .travis.yml .appveyor.yml .readthedocs.yml .pre-commit-config.yaml
17
+
18
+ global-exclude *.py[cod] __pycache__/* *.so *.dylib
@@ -0,0 +1,30 @@
1
+ Metadata-Version: 2.4
2
+ Name: py-dss-toolkit
3
+ Version: 0.1.0
4
+ Summary: Advanced Python Tools for OpenDSS Powered by EPRI.
5
+ Author-email: Paulo Radatz <paulo.radatz@gmail.com>
6
+ License: MIT
7
+ Project-URL: Changelog, https://github.com/PauloRadatz/py_dss_toolkit/blob/master/CHANGELOG.rst
8
+ Project-URL: Issue Tracker, https://github.com/PauloRadatz/py_dss_toolkit/issues
9
+ Project-URL: Source, https://github.com/PauloRadatz/py_dss_toolkit
10
+ Keywords: OpenDSS,Python,Power Systems,Distribution Systems,Energy
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Operating System :: Microsoft :: Windows
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
22
+ Requires-Python: >=3.9
23
+ Description-Content-Type: text/x-rst
24
+ License-File: LICENSE
25
+ License-File: AUTHORS.rst
26
+ Requires-Dist: py-dss-interface>=2.1.0
27
+ Requires-Dist: pandas>=1.5.0
28
+ Requires-Dist: matplotlib>=3.6.0
29
+ Requires-Dist: plotly>=5.10.0
30
+ Dynamic: license-file
@@ -0,0 +1,168 @@
1
+ # ⚑ py-dss-toolkit: Advanced Python Tools for OpenDSS Powered by EPRI
2
+
3
+ [![PyPI Version](https://img.shields.io/pypi/v/py-dss-toolkit.svg)](https://pypi.org/project/py-dss-toolkit/)
4
+ [![License](https://img.shields.io/github/license/PauloRadatz/py_dss_toolkit)](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/LICENSE)
5
+ [![Build Status](https://img.shields.io/github/actions/workflow/status/PauloRadatz/py_dss_toolkit/python-app.yml)](https://github.com/PauloRadatz/py_dss_toolkit/actions)
6
+
7
+ **`py-dss-toolkit`** is a Python package that builds on the capabilities of the [`py-dss-interface`](https://github.com/PauloRadatz/py_dss_interface) package to provide advanced functionalities for creating Python-OpenDSS solutions more efficiently. By combining the robust connection to OpenDSS provided by `py-dss-interface` with the feature-rich tools of `py-dss-toolkit`, users can streamline their workflows and gain powerful new capabilities for analyzing and manipulating OpenDSS models, simulations, and results.
8
+
9
+ πŸ”— For more information about `py-dss-interface`, visit the [GitHub repository](https://github.com/PauloRadatz/py_dss_interface).
10
+
11
+ 🚨 Note: This project was previously known as `py-dss-tools` and the repository was named `py_dss_tools`. It has been renamed to avoid naming conflicts on PyPI.
12
+
13
+
14
+ ## πŸ“¦ Installation
15
+
16
+ You can install `py-dss-toolkit` in two ways:
17
+
18
+ ### πŸ‘€ User Installation
19
+
20
+ If you simply want to use the package:
21
+
22
+ ```bash
23
+ pip install py-dss-toolkit
24
+ ```
25
+
26
+ ### πŸ‘¨β€πŸ’» Developer Installation
27
+
28
+ If you want to contribute or explore the source code:
29
+
30
+ ```bash
31
+ git clone https://github.com/PauloRadatz/py_dss_toolkit.git
32
+ cd py_dss_toolkit
33
+ pip install -e .
34
+ ```
35
+
36
+ ## ✨ Features
37
+
38
+ - Retrieve, analyze, and visualize OpenDSS model data using with ease.
39
+ - Flexible simulation result access via `dss_tools` or structured workflows via `CreateStudy`.
40
+ - Visualize circuit topology, voltage profiles, and time-series using DSSView, Plotly, or Matplotlib.
41
+ - Extract Simulation results directly into pandas DataFrames.
42
+ - Built on top of `py-dss-interface`.
43
+
44
+ ## πŸš€ What Can You Do With py-dss-toolkit?
45
+
46
+ ### πŸ” 1. Model Exploration and Manipulation
47
+
48
+ - Access detailed model information via organized pandas DataFrames.
49
+ - Modify models efficiently with built-in Pythonic tools.
50
+
51
+ πŸ“˜ [Example Notebook](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/examples/dss_tools/models.ipynb)
52
+
53
+ ### πŸ“Š 2. Exploring Simulation Results Capabilities
54
+
55
+ - Retrieve SnapShot power flow results (voltages, currents, powers) via organized pandas DataFrames.
56
+ - Extract QSTS simulation data including meters and monitors.
57
+
58
+ πŸ“˜ [Snapshot Results](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/examples/dss_tools/snapshot_results.ipynb)
59
+ πŸ“˜ [QSTS Results](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/examples/dss_tools/qsts_results.ipynb)
60
+
61
+ ### πŸ“ˆ 3. Visualize Simulation Results
62
+
63
+ `py-dss-toolkit` supports multiple methods to visualize:
64
+ - Circuit topology
65
+ - Voltage profiles
66
+ - Time-series results
67
+
68
+ All three can be visualized using:
69
+ - πŸ–₯️ **DSSView.exe** β€” the native visualization tool for OpenDSS.
70
+ - πŸ” **Plotly (interactive)** β€” browser-based interactive plots.
71
+ - 🧾 **Matplotlib (static)** β€” publication-ready static charts.
72
+
73
+ πŸ“˜ [Circuit Interactive View](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/examples/dss_tools/circuit_interactive_view.ipynb)
74
+ πŸ“˜ [Voltage Profile DSS View](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/examples/dss_tools/voltage_profile_dss_view.ipynb)
75
+ πŸ“˜ [Voltage Profile Interactive View](https://github.com/PauloRadatz/py_dss_toolkit/blob/master/examples/dss_tools/voltage_profile_interactive_view.ipynb)
76
+ πŸ“˜ [Voltage Profile Static View](https://github.com/PauloRadatz/py_dss_tools/blob/master/examples/dss_tools/voltage_profile_static_view.ipynb)
77
+
78
+ ## πŸ› οΈ How to Use py-dss-toolkit?
79
+
80
+ ### πŸ”§ 1. Directly with the `dss_tools` Object
81
+
82
+ This approach is ideal when you want full flexibility to use `py-dss-toolkit` alongside your own custom logic or an existing `py-dss-interface` workflow. It allows you to:
83
+
84
+ - Inject the active DSS object into `py-dss-toolkit` using `update_dss()`
85
+ - Use any feature provided by `py-dss-toolkit` independently of the study type
86
+ - Combine different simulation types, preprocessing, and postprocessing in a custom flow
87
+
88
+ βœ… **Pros:**
89
+ - Full control and flexibility
90
+ - Ideal for experienced users who want to mix tools freely
91
+ - Easily integrates into existing scripts
92
+
93
+ ⚠️ **Cons:**
94
+ - No study-type validation (e.g., SnapShot vs QSTS restrictions)
95
+ - Higher chance of calling functions that don’t match the simulation context
96
+ - Slightly steeper learning curve for py-dss-interface beginners
97
+
98
+ ```python
99
+ import py_dss_interface
100
+ from py_dss_toolkit import dss_tools
101
+
102
+ dss = py_dss_interface.DSS()
103
+ dss.text("compile path/to/model.dss")
104
+ dss_tools.update_dss(dss)
105
+
106
+ dss.text("solve")
107
+
108
+ dss_tools.interactive_view.voltage_profile()
109
+ ```
110
+
111
+ ### πŸ§ͺ 2. Using the `CreateStudy` Class
112
+
113
+ This approach is best when you want a clear, structured workflow that restricts available features based on the type of study you are performing (e.g., SnapShot, QSTS). It abstracts the setup and ensures that only relevant tools are available, helping avoid mistakes or invalid calls.
114
+
115
+ βœ… **Pros:**
116
+ - Easier for beginners to follow and use safely
117
+ - Prevents access to results or views that don’t apply to the selected study type
118
+ - Provides a cleaner, study-oriented interface
119
+
120
+ ⚠️ **Cons:**
121
+ - Less flexible than using `dss_tools` directly
122
+ - You are limited to workflows supported by the framework
123
+ - More abstraction might make it harder to customize or mix multiple simulations
124
+
125
+ ```python
126
+ from py_dss_toolkit import CreateStudy
127
+
128
+ study = CreateStudy.snapshot("Snapshot Study", dss_file="path/to/model.dss")
129
+ study.run()
130
+
131
+ study.interactive_view.circuit_plot()
132
+ ```
133
+
134
+ ## 🀝 Community and Support
135
+
136
+ Contributions and feedback are welcome! Open an issue or start a discussion on the [GitHub Issues Page](https://github.com/PauloRadatz/py_dss_tools/issues).
137
+
138
+ This project is under active development, and there are many additional features that could be included in the future. If you have ideas or specific needs, feel free to open a feature request, contribute directly, or reach out to me!
139
+
140
+ ## πŸ“š How to Cite
141
+
142
+ If you use `py-dss-toolkit` in your academic work, please reference it as follows:
143
+
144
+ **APA Style:**
145
+
146
+ Radatz, P. (2025). *py-dss-toolkit: Advanced Python Tools for OpenDSS powered by EPRI* (Version X.X.X) [Computer software]. GitHub. https://github.com/PauloRadatz/py_dss_tools
147
+
148
+ **BibTeX Entry:**
149
+
150
+ ```bibtex
151
+ @software{radatz2025pydsstools,
152
+ author = {Paulo Radatz},
153
+ title = {py-dss-toolkit: Advanced Python Tools for OpenDSS powered by EPRI},
154
+ year = {2025},
155
+ version = {X.X.X},
156
+ url = {https://github.com/PauloRadatz/py_dss_tools}
157
+ }
158
+ ```
159
+
160
+ πŸ“Œ Please replace `X.X.X` with the version of the package you are using.
161
+
162
+
163
+ ## πŸ™ Acknowledgements
164
+ Developed and maintained by [Paulo Radatz](https://www.linkedin.com/in/pauloradatz/), with support from the global OpenDSS community.
165
+
166
+ Special thanks to the OpenDSS community and all contributors and users who have provided feedback and inspiration. The development of `py-dss-toolkit` builds on the foundation laid by [`py-dss-interface`](https://github.com/PauloRadatz/py_dss_interface).
167
+
168
+ ---