AllNodeDistancesByPhase(Phase: int) → dss._types.Float64Array#: Returns an array of doubles representing the distances to parent EnergyMeter. Sequence of array corresponds to other node ByPhase properties.

property AllNodeNames: List[str]#

Array of strings containing full name of each node in system in same order as returned by AllBusVolts, etc.

Original COM help: https://opendss.epri.com/AllNodeNames.html

AllNodeNamesByPhase(Phase: int) → List[str]#: Return array of strings of the node names for the By Phase criteria. Sequence corresponds to other ByPhase properties.

AllNodeVmagByPhase(Phase: int) → dss._types.Float64Array#: Returns Array of doubles represent voltage magnitudes for nodes on the specified phase.

AllNodeVmagPUByPhase(Phase: int) → dss._types.Float64Array#: Returns array of per unit voltage magnitudes for each node by phase

Buses: dss.IBus.IBus#: None

CNData: dss.ICNData.ICNData#: None

CapControls: dss.ICapControls.ICapControls#: None

Capacitors: dss.ICapacitors.ICapacitors#: None

Capacity(Start: float, Increment: float) → float#

Compute the maximum load the active circuit can serve in the PRESENT YEAR.

This method uses the EnergyMeter objects with the registers set with the SET UEREGS= (...) command for the AutoAdd functions.

Returns the metered kW (load + losses - generation) and per unit load multiplier for the loading level at which something in the system reports an overload or undervoltage. If no violations, then it returns the metered kW for peak load for the year (1.0 multiplier).

Aborts and returns 0 if no EnergyMeters.

Original COM help: https://opendss.epri.com/Capacity1.html

CktElements: dss.ICktElement.ICktElement#: None

CtrlQueue: dss.ICtrlQueue.ICtrlQueue#: None

DSSim_Coms: dss.IDSSimComs.IDSSimComs#: None

Disable(Name: AnyStr)#

Disable a circuit element by name (removes from circuit but leave in database).

Original COM help: https://opendss.epri.com/Disable.html

ElementLosses(Value: dss._types.Int32Array) → dss._types.Float64ArrayOrComplexArray#

Array of total losses (complex) in a selection of elements. Use the element indices (starting at 1) as parameter.

(API Extension)

Enable(Name: AnyStr)#

Enable a circuit element by name

Original COM help: https://opendss.epri.com/Enable.html

EndOfTimeStepUpdate()#

Call EndOfTimeStepCleanup in SolutionAlgs (Do cleanup, sample monitors, and increment time).

Original COM help: https://opendss.epri.com/EndOfTimeStepUpdate.html

FirstElement() → int#

Set the first element of active class to be the Active element in the active circuit.

Returns 0 if none.

Original COM help: https://opendss.epri.com/FirstElement.html

FirstPCElement() → int#

Set the first Power Conversion (PC) element to be the active element.

Returns 0 if none.

Original COM help: https://opendss.epri.com/FirstPCElement.html

FirstPDElement() → int#

Set the first Power Delivery (PD) element to be the active element.

Returns 0 if none.

Original COM help: https://opendss.epri.com/FirstPDElement.html

FromJSON(data: Union[AnyStr, dict], options: dss.enums.DSSJSONFlags = 0)#

Replaces the circuit, if any, with the one provided from a JSON-encoded string. If a Python dict is provided, json.dumps(data) is applied first.

The expected layout is defined from the JSON schema proposed at dss-extensions/AltDSS-Schema

The options parameter contains bit-flags to toggle specific features. See the enum DSSJSONFlags.

(API Extension)

Fuses: dss.IFuses.IFuses#: None

GICSources: dss.IGICSources.IGICSources#: None

Generators: dss.IGenerators.IGenerators#: None

ISources: dss.IISources.IISources#: None

Isources: dss.IISources.IISources#: None

LineCodes: dss.ILineCodes.ILineCodes#: None

LineGeometries: dss.ILineGeometries.ILineGeometries#: None

property LineLosses: dss._types.Float64ArrayOrSimpleComplex#

Complex total line losses in the circuit

Original COM help: https://opendss.epri.com/LineLosses.html

LineSpacings: dss.ILineSpacings.ILineSpacings#: None

Lines: dss.ILines.ILines#: None

LoadShapes: dss.ILoadShapes.ILoadShapes#: None

Loads: dss.ILoads.ILoads#: None

property Losses: dss._types.Float64ArrayOrSimpleComplex#

Total losses in active circuit, complex number (two-element array of double).

Original COM help: https://opendss.epri.com/Losses.html

Meters: dss.IMeters.IMeters#: None

Monitors: dss.IMonitors.IMonitors#: None

property Name: str#: Name of the active circuit.

NextElement() → int#

Set the next element of the active class to be the active element in the active circuit. Returns 0 if no more elements..

Original COM help: https://opendss.epri.com/NextElement.html

NextPCElement() → int#

Get the next Power Conversion (PC) element to be the active element.

Original COM help: https://opendss.epri.com/NextPCElement.html

NextPDElement() → int#

Get the next Power Delivery (PD) element to be the active element.

Original COM help: https://opendss.epri.com/NextPDElement.html

property NumBuses: int#

Total number of Buses in the circuit.

Original COM help: https://opendss.epri.com/NumBuses.html

property NumCktElements: int#

Number of CktElements in the circuit.

Original COM help: https://opendss.epri.com/NumCktElements.html

property NumNodes: int#

Total number of nodes in the circuit.

Original COM help: https://opendss.epri.com/NumNodes1.html

PDElements: dss.IPDElements.IPDElements#: None

PVSystems: dss.IPVSystems.IPVSystems#: None

Parallel: dss.IParallel.IParallel#: None

property ParentPDElement: int#

Sets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.

Original COM help: https://opendss.epri.com/ParentPDElement.html

Reactors: dss.IReactors.IReactors#: None

Reclosers: dss.IReclosers.IReclosers#: None

ReduceCkt: dss.IReduceCkt.IReduceCkt#: None

RegControls: dss.IRegControls.IRegControls#: None

Relays: dss.IRelays.IRelays#: None

Sample()#

Force all Meters and Monitors to take a sample.

Original COM help: https://opendss.epri.com/Sample.html

Save(dirOrFilePath: AnyStr, options: dss.enums.DSSSaveFlags) → str#

Equivalent of the “save circuit” DSS command, but allows customization through the saveFlags argument, which is a set of bit flags. See the “DSSSaveFlags” enumeration for available flags:

CalcVoltageBases: Include the command CalcVoltageBases.
SetVoltageBases: Include commands to set the voltage bases individually.
IncludeOptions: Include most of the options (from the Set/Get DSS commands).
IncludeDisabled: Include disabled circuit elements (and LoadShapes).
ExcludeDefault: Exclude default DSS items if they are not modified by the user.
SingleFile: Use a single file instead of a folder for output.
KeepOrder: Save the circuit elements in the order they were loaded in the active circuit. Guarantees better reproducibility, especially when the system is ill-conditioned. Requires “SingleFile” flag.
ExcludeMeterZones: Do not export meter zones (as “feeders”) separately. Has no effect when using a single file.
IsOpen: Export commands to open terminals of elements.
ToString: to the result string. Requires “SingleFile” flag.

If SingleFile is enabled, the first argument (dirOrFilePath) is the file path, otherwise it is the folder path. For string output, the argument is not used.

(API Extension)

SaveSample()#

Force all meters and monitors to save their current buffers.

Original COM help: https://opendss.epri.com/SaveSample.html

Sensors: dss.ISensors.ISensors#: None

SetActiveBus(BusName: AnyStr) → int#

Sets Active bus by name.

Ignores node list. Returns bus index (zero based) compatible with AllBusNames and Buses collection.

Original COM help: https://opendss.epri.com/SetActiveBus.html

SetActiveBusi(BusIndex: int) → int#

Set ActiveBus by an integer value.

0-based index compatible with SetActiveBus return value and AllBusNames indexing. Returns 0 if OK.

Original COM help: https://opendss.epri.com/SetActiveBusi.html

SetActiveClass(ClassName: AnyStr) → int#

Set the active class by name.

Use FirstElement, NextElement to iterate through the class. Returns -1 if fails.

Original COM help: https://opendss.epri.com/SetActiveClass.html

SetActiveElement(FullName: AnyStr) → int#

Set the Active Circuit Element using the full object name (e.g. “generator.g1”).

Returns -1 if not found. Else index to be used in CktElements collection or AllElementNames.

Original COM help: https://opendss.epri.com/SetActiveElement.html

Settings: dss.ISettings.ISettings#: None

Solution: dss.ISolution.ISolution#: None

Storages: dss.IStorages.IStorages#: None

property SubstationLosses: dss._types.Float64ArrayOrSimpleComplex#

Complex losses in all transformers designated to substations.

Original COM help: https://opendss.epri.com/SubstationLosses.html

SwtControls: dss.ISwtControls.ISwtControls#: None

property SystemY: dss._types.Float64ArrayOrComplexArray#

(read-only) System Y matrix (after a solution has been performed). This is deprecated as it returns a dense matrix. Only use it for small systems. For large-scale systems, prefer YMatrix.GetCompressedYMatrix.

Original COM help: https://opendss.epri.com/SystemY.html