Above-graph components (element-based)¶
These components provide control and monitoring function. They are not directly part of the grid topology. Their collocation in the system is determined by element, transformer winding, etc.
Regcontrol¶
-
class
krangpower._components.
Regcontrol
(name='', **parameters)¶ Regcontrol object
Property name type Default value vreg float 120.0 band float 3.0 ptratio float 60.0 ctprim float 300.0 r float 0.0 x float 0.0 bus float delay float 15.0 reversible string no revvreg float 120.0 revband float 3.0 revr float 0.0 revx float 0.0 tapdelay float 2.0 debugtrace string no maxtapchange int 16 inversetime string no tapwinding int 1 vlimit float 0.0 ptphase int 1 revthreshold float 100.0 revdelay float 60.0 revneutral string no eventlog string yes remoteptratio float 60.0 tapnum float 0 basefreq float 50.0 -
aka
(name)¶ Aliases the object.
-
eltype
¶
-
fcs
(**hookup)¶ Generates the opendss “new…” command for the object. Needs to be passed an appropriate set of keyword arguments to fill whatever topologic parameters are needed. It’s meant primarily for internal use by krangpower itself.
-
fullname
¶ Name, in the form eltype.elname
-
classmethod
isabove
()¶ Returns True if the class is an above-graph component, like a monitor or regulator, False otherwise.
-
classmethod
isai
()¶ Returns true if the class is ai-enabled, False otherwise.
-
classmethod
isnamed
()¶ Returns True if the class is a named entity, like a LineCode, False otherwise.
-
jsonize
(all_params=False, flatten_mtx=True)¶ Returns a dict that describes the element’s parameters. It’s compatible with the json I/O functions.
-
paramhelp
()¶ Prints a cheatsheet for the object’s parameters.
-
sf_deepcopy
()¶ Returns a deep copy of the object. This method is to be used in place of the standard copy.deepcopy, that will raise an exception.
-
toe
¶
-
Monitor¶
-
class
krangpower._components.
Monitor
(name='', **parameters)¶ Monitor object. Several methods of odsswr.Circuit.py allow for exportation of the recordings of the monitors.
Property name type Default value mode int 0 action string residual string no vipolar string yes ppolar string yes basefreq float 50.0 -
aka
(name)¶ Aliases the object.
-
eltype
¶
-
fcs
(**hookup)¶ Generates the opendss “new…” command for the object. Needs to be passed an appropriate set of keyword arguments to fill whatever topologic parameters are needed. It’s meant primarily for internal use by krangpower itself.
-
fullname
¶ Name, in the form eltype.elname
-
classmethod
isabove
()¶ Returns True if the class is an above-graph component, like a monitor or regulator, False otherwise.
-
classmethod
isai
()¶ Returns true if the class is ai-enabled, False otherwise.
-
classmethod
isnamed
()¶ Returns True if the class is a named entity, like a LineCode, False otherwise.
-
jsonize
(all_params=False, flatten_mtx=True)¶ Returns a dict that describes the element’s parameters. It’s compatible with the json I/O functions.
-
paramhelp
()¶ Prints a cheatsheet for the object’s parameters.
-
sf_deepcopy
()¶ Returns a deep copy of the object. This method is to be used in place of the standard copy.deepcopy, that will raise an exception.
-
toe
¶
-
StorageController¶
-
class
krangpower._components.
StorageController
(name='', **parameters)¶ StorageController object
Property name type Default value Element string Terminal int 1 kWTarget float 8000.0 %kWBand float 2.0 PFTarget float 0.96 PFBand float 0.04 ElementList stringarray s1 Weights floatarray 1 ModeDischarge string peakshave ModeCharge string Time TimeDischargeTrigger int -1 TimeChargeTrigger int 2 %RatekW float 20.0 %Ratekvar float 20.0 %RateCharge float 20.0 %Reserve float 25.0 kWhTotal float 50.0 kWTotal float 25.0 kWhActual float 50.0 kWActual float 5.0 kWneed float 0.0 %Participation float Yearly string Daily string Duty string EventLog string No VarDispatch string No InhibitTime float 5.0 Tup float 0.25 TFlat float 2.0 Tdn float 0.25 kWThreshold float 6000.0 basefreq float 50.0 -
aka
(name)¶ Aliases the object.
-
eltype
¶
-
fcs
(**hookup)¶ Generates the opendss “new…” command for the object. Needs to be passed an appropriate set of keyword arguments to fill whatever topologic parameters are needed. It’s meant primarily for internal use by krangpower itself.
-
fullname
¶ Name, in the form eltype.elname
-
classmethod
isabove
()¶ Returns True if the class is an above-graph component, like a monitor or regulator, False otherwise.
-
classmethod
isai
()¶ Returns true if the class is ai-enabled, False otherwise.
-
classmethod
isnamed
()¶ Returns True if the class is a named entity, like a LineCode, False otherwise.
-
jsonize
(all_params=False, flatten_mtx=True)¶ Returns a dict that describes the element’s parameters. It’s compatible with the json I/O functions.
-
paramhelp
()¶ Prints a cheatsheet for the object’s parameters.
-
sf_deepcopy
()¶ Returns a deep copy of the object. This method is to be used in place of the standard copy.deepcopy, that will raise an exception.
-
toe
¶
-