This represents a work-in-progress effort to expose all OpenDSS data classes to the end user without requiring frequent string manipulation, which the added bonus of type hints and maybe better performance. All data is available using native Python types and wrapper objects.
A new batch API is also integrated, allowing easy manipulation of multiple objects of the same type in a consistent manner.
Changes are expected to adjust naming of the properties. New features are also planned.
A few examples are available in our tests:
More notes and guided usage will be added here when we feel the package is ready. Currently, this document works as a vague reference. A detailed version with per-class docs will be generated in the future when the files are reorganized.
This module exposes base objects for the pythonic Obj and Batch interfaces from DSS C-API. These interfaces are unique to DSS-Extensions, they are not present in the official OpenDSS.
This is still under development and the final implementation might differ in some aspects. For example, we plan to adjust the spelling of many properties; nconds will become NConds, kv will become kV, and so on.
Currently, we’re already removed wdg and the indirect properties in favour of the array versions. This will also be tweaked after more usage. NConds, for example, may also be removed if we can develop a mechanism to ensure the dimensions match.
Classes
|
AutoAdd Device Type (DSS enumeration) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Circuit Model (DSS enumeration) |
|
|
|
Control Mode (DSS enumeration) |
|
Core Type (DSS enumeration) |
|
|
|
|
|
Dimension Units (DSS enumeration) |
|
|
|
|
|
Earth Model (DSS enumeration) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Line Type (DSS enumeration) |
|
|
|
|
|
|
|
|
|
Load Shape Class (DSS enumeration) |
|
Load Solution Model (DSS enumeration) |
|
|
|
|
|
Monitored Phase (DSS enumeration) |
|
|
|
|
|
Phase Sequence (DSS enumeration) |
|
|
|
|
|
Random Type (DSS enumeration) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Scan Type (DSS enumeration) |
|
|
|
|
|
Sequence Type (DSS enumeration) |
|
Solution Algorithm (DSS enumeration) |
|
Solution Mode (DSS enumeration) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AutoAdd Device Type (DSS enumeration)
Control Mode (DSS enumeration)
Core Type (DSS enumeration)
Dimension Units (DSS enumeration)
Earth Model (DSS enumeration)
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
AutoTransBatch
AutoTrans
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
CNDataBatch
CNData
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
CapControlBatch
CapControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
CapacitorBatch
Capacitor
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
DynamicExpBatch
DynamicExp
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
ESPVLControlBatch
ESPVLControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
EnergyMeterBatch
EnergyMeter
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
ExpControlBatch
ExpControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
FaultBatch
Fault
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
FuseBatch
Fuse
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
GICLineBatch
GICLine
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
GICTransformerBatch
GICTransformer
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
GICsourceBatch
GICsource
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
GenDispatcherBatch
GenDispatcher
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
GeneratorBatch
Generator
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
GrowthShapeBatch
GrowthShape
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
IndMach012Batch
IndMach012
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
InvControlBatch
InvControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
IsourceBatch
Isource
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
LineBatch
Line
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
LineCodeBatch
LineCode
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
LineGeometryBatch
LineGeometry
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
LineSpacingBatch
LineSpacing
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
LoadBatch
Load
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
LoadShapeBatch
LoadShape
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
MonitorBatch
Monitor
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
PVSystemBatch
PVSystem
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
PriceShapeBatch
PriceShape
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
ReactorBatch
Reactor
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
RecloserBatch
Recloser
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
RegControlBatch
RegControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
RelayBatch
Relay
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
SensorBatch
Sensor
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
SpectrumBatch
Spectrum
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
StorageBatch
Storage
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
StorageControllerBatch
StorageController
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
SwtControlBatch
SwtControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
TCC_CurveBatch
TCC_Curve
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
TSDataBatch
TSData
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
TShapeBatch
TShape
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
TransformerBatch
Transformer
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
UPFCBatch
UPFC
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
UPFCControlBatch
UPFCControl
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
VCCSBatch
VCCS
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
VSConverterBatch
VSConverter
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
VsourceBatch
Vsource
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
WireDataBatch
WireData
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
XYcurveBatch
XYcurve
Creates a new batch handler of new objects, with the specified names, or “count” elements with a randomized prefix.
XfmrCodeBatch
XfmrCode
Inverter Control Mode (DSS enumeration)
Line Type (DSS enumeration)
Load Shape Class (DSS enumeration)
Load Solution Model (DSS enumeration)
Monitored Phase (DSS enumeration)
Phase Sequence (DSS enumeration)
Random Type (DSS enumeration)
Sequence Type (DSS enumeration)
Solution Algorithm (DSS enumeration)
Solution Mode (DSS enumeration)