Glossary
This is a glossary of all possible values contained in data and result dictionaries as well as other general information.
Data
To load and edit ERACS data in the Python Interface, refer to
Data.TEracsData.
Data Dictionaries
To access loaded data, use the properties provided by the data object. The list of
properties is given in Collection.TEracsDataCollection, a parent class
of Data.TEracsData. Some properties will return a single dictionary,
for instance the loadflow parameters, whilst other properties will return a list
containing many dictionaries, for instance the busbars data for each busbar.
Header Record Data
Below is a summary of some of the data in the header records dictionary.
Key |
Description |
|---|---|
“netname” |
Network name |
“statename” |
Data state name |
“sysbase” |
System base, MVA |
“sysfreq” |
System frequency, Hz |
“libfile” |
Library file name |
“libpath” |
Library file path |
“version” |
Version number, formatted as ‘ERACS Vx.y.z’ where ‘x’ = major version number, ‘y’ = minor version number, and ‘z’ = patch version number. Refer to the documentation index page at ERACS Python Interface 1.1.5 (08/03/22) to find out which ERACS version is recommended for the Python Interface version you’re using (to ensure compatibility). |
“txbasevoltage” |
Transformer base voltage indicator, 0 = winding nominal/rated voltage, 1 = tapped voltage |
“autosave” |
Whether autosave feature is enabled |
Loadflow Parameters Data
Below is a summary of some of the data in the loadflow parameters dictionary.
Key |
Description |
|---|---|
“pmult” |
P multiplier |
“qmult” |
Q multiplier |
“convolt” |
Convergence tolerance |
“oflag” |
Overload flag |
“lovolts” |
Lower busbar voltage threshold |
“hivolts” |
Higher busbar voltage threshold |
“itcount” |
Iteration count |
“tapsel” |
Tap changer selector, 0 = off, 1 = on, 2 = use positions from parent state |
“linerat” |
Transmission line rating selector, 1 = winter, 2 = spring/autumn, 3 = summer |
“usepvvolt” |
Whether to use target voltage of PV machines |
“inittappos” |
Initial tap position of on-load tap changers, 0 = middle tap, 1 = nominal tap |
“gridfaultlevelsel” |
Fault level selector for all grid infeeds, 0 = maximum, 1 = minimum, 2 = other |
Appearance Settings Data
Below is a summary of some of the data in the appearance settings dictionary.
Key |
Description |
|---|---|
“hilightisolated” |
Whether isolated areas should be highlighted |
“dashedcables” |
Whether cables should be dashed to distinguish themselves from transmission lines |
“showpowerarrows” |
Whether to display power arrays for directional relays |
“showprotdirinds” |
Whether the letter D should be placed inside symbols for directional relays |
“defbusthickness” |
Default busbar thickness |
“defbuslength” |
Default busbar length |
“gridxspace” |
X spacing on the snap-to grid |
“gridyspace” |
Y spacing on the snap-to grid |
“gridvisible” |
Whether the grid is visible or not |
“gridcolour” |
The colour of the grid |
“gridstyle” |
The style of the grid, 0 = dot, 1 = solid line, 2 = cross |
“hilighttxwdg1” |
Whether to highlight winding 1 for transformers |
Result Settings Data
Below is a summary of some of the data in the result settings dictionary.
Key |
Description |
|---|---|
“numdps” |
Number of decimal places |
“incsymbol” |
Include symbols |
“incunits” |
Include units |
“fontname” |
Font name |
“fontsize” |
Font size |
“bold” |
Whether to use bold font |
“italic” |
Whether to use italic font |
“arcflashunits” |
Arch flash distance units, 0 = metric, 1 = imperial |
Text Records Data
Below is a summary of some of the data you can expect in each dictionary within the list of data.
Key |
Description |
|---|---|
“caption” |
Caption for the text |
“fontname” |
Font name |
“fontsize” |
Font size |
“fontcolour” |
Font colour |
“bold” |
Whether to use bold font |
“italic” |
Whether to use italic font |
“underline” |
Whether to underline the text |
“strikeout” |
Whether to strikeout the text |
“transparent” |
Whether the text is transparent |
“rotation” |
Counter clockwise rotation of the text |
“xcoord” |
The x coordinate of the top-left corner |
“ycoord” |
The y coordinate of the top-left corner |
Switch Groups Data
Below is a summary of some of the data you can expect for switch groups.
Key |
Description |
|---|---|
“id” |
ID for the switch group |
“description” |
Description for the switch group |
“numsw” |
Number of switches controlled by the group |
“sw” |
A list of each switch, as a dictionary containing ID and typecode, e.g. sw = [{“id”: “CB_1”, “typecode”: “CB”}] |
Common Element Data
Below is a summary of some of the shared data for all elements, including busbars, transmission lines, transformers, shunts, and so on…
Key |
Description |
|---|---|
“id” |
Identifier |
“description” |
Description for the element |
“typecode” |
Element typecode |
“seqnum” * |
Unique sequence number (unique per element type) |
“keyname” |
Library key (for elements with associated library elements) |
“resx” |
X coordinate for element results |
“resy” |
Y coordinate for element results |
“res2x” |
X coordinate for second end results (branch elements only) |
“res2y” |
Y coordinate for second end results (branch elements only) |
“busbar1” |
First connected busbar |
“busbar2” |
Second connected busbar (branch elements only) |
“ptypecode” |
Parent typecode (for embedded child elements only) |
“pid” |
Parent ID (for embedded child elements only) |
“user_defined_field_values” |
User defined field values |
“symbol_info” |
Symbol information, such as id of the symbol, orientation, and position |
“section_info” |
Information for sections |
* marked items are added by the Python Interface and not loaded from the data source.
Busbar Data
Below is a summary of some of the data in each busbar element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol should be visible |
“withstandsymbolvisible” |
Whether the withstand symbol should be visible |
“freq” |
Busbar frequency |
“kv” |
Rated voltage (kV) |
“tphmva” |
Three-phase fault rating (MVA) |
“sphmva” |
Single-phase fault rating (MVA) |
“mvdkeyname” |
Measured voltage distortion library keyname |
“equiptype” |
Equipment type (IEEE Std 1584-2002 legacy arc flash data), 0 = open air, 1 = cable, 2 = switchgear, 3 = motor control centre, 4 = panel boards, 5 = other |
“workdist” |
Working distance (IEEE Std 1584-2002 legacy arc flash data) |
“condgap” |
Gap between conductors (IEEE Std 1584-2002 legacy arc flash data) |
“limappsel” |
Which limited approach boundary value is used (legacy data), 0 = exposed movable conductor, 1 = exposed fixed circuit part |
“xcoord” |
X coordinate of the top-left corner of the busbar |
“ycoord” |
Y coordinate of the top-left corner of the busbar |
“width” |
Width of the busbar |
“height” |
Height of the busbar |
“idxcoord” |
X coordinate of the busbar ID |
“idycoord” |
Y coordinate of the busbar ID |
“idvisible” |
Whether the busbar ID is visible |
“mvdsymbolvisible” |
Whether the measured voltage distortion symbol is visible |
Arc Flash Enclosure Data
Below is a summary of some of the data in each arc flash enclosure element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol should be visible |
“withstandsymbolvisible” |
Whether the withstand symbol should be visible |
“assoc_elm_typecode” |
Associated element typecode |
“assoc_elm_id” |
Associated element ID |
“equiptype” |
Equipment type (IEEE Std 1584-2018), 0 = open air, 1 = cable junction box, 2 = switchgear, 3 = LV motor control centre, 4 = LV panel boards, 5 = other, 6 = HV/MV motor control centre |
“condconfig” |
Conductor/electrode configuration (IEEE Std 1584-2018), 0 = VCB, 1 = VCCB, 2 = HCB, 3 = VOA, 4 = HOA |
“workdist” |
Working distance (IEEE Std 1584-2018) |
“condgap” |
Gap between conductors (IEEE Std 1584-2018) |
“width” |
Enclosure width (IEEE Std 1584-2018) |
“height” |
Enclosure height (IEEE Std 1584-2018) |
“depth” |
Enclosure depth (IEEE Std 1584-2018) |
“limappsel” |
Which limited approach boundary value is used, 0 = exposed movable conductor, 1 = exposed fixed circuit part |
“incstudies” |
Whether this enclosure should be automatically selected for an Arc Flash Study |
Bus Section Data
Below is a summary of some of the data in each bus section element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol should be visible |
“withstandsymbolvisible” |
Whether the withstand symbol should be visible |
“swstate” |
Switch state, 0 = open, 1 = closed |
“kv” |
Rated voltage |
“tphmva” |
Three phase fault rating (MVA) |
“sphmva” |
Single phase fault rating (MVA) |
“symrat” |
Symmetrical fault rating (kA) |
“symmvarat” |
Symmetrical fault rating (MVA) |
“asymrat” |
Asymmetrical fault rating (kA) |
“asymmvarat” |
Asymmetrical fault rating (MVA) |
“time100” |
Operating time at 100% rating (ms) |
“swgroup” |
The switch group this element belongs to |
Circuit Breaker Data
Below is a summary of some of the data in each circuit breaker element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol should be visible |
“withstandsymbolvisible” |
Whether the withstand symbol should be visible |
“swstate” |
Switch state, 0 = open, 1 = closed |
“kv” |
Rated voltage |
“tphmva” |
Three phase fault rating (MVA) |
“sphmva” |
Single phase fault rating (MVA) |
“symrat” |
Symmetrical fault rating (kA) |
“symmvarat” |
Symmetrical fault rating (MVA) |
“asymrat” |
Asymmetrical fault rating (kA) |
“asymmvarat” |
Asymmetrical fault rating (MVA) |
“time100” |
Operating time at 100% rating (ms) |
“swgroup” |
The switch group this element belongs to |
Circuit Breaker With Trip Unit Data
Below is a summary of some of the data in each circuit breaker element with optional trip units. This is not only the structure for air circuit breakers, but also SF6, MCCB, OCB, VCB, and RMUCB. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol should be visible |
“withstandsymbolvisible” |
Whether the withstand symbol should be visible |
“swstate” |
Switch state, 0 = open, 1 = closed |
“swgroup” |
The switch group this element belongs to |
“shunttripfitted” |
Indicates whether a shunt trip is attached |
“sensorrating” |
The Circuit Breaker’s current sensor rating |
“ctratio” |
The current transformer’s primary to secondary ratio |
“verboseocsetting” |
Time and current settings for the over current protection function |
“verboseefsetting” |
Time and current settings for the earth fault protection function |
Grid Infeed Data
Below is a summary of some of the data in each grid infeed element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“min_fault_level” |
Minimum fault level data |
“max_fault_level” |
Maximum fault level data |
“other_fault_level” |
Other fault level data |
“ipkeyname” |
Harmonic Impedance Profile library key name |
“impedanceprofilesymbolvisible” |
Whether the Harmonic Impedance Profile symbol is visible |
Transmission Line Data
Below is a summary of some of the data in each transmission line element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“numccts” |
Number in parallel |
“length” |
Length of transmission lines |
Cable Data
Below is a summary of some of the data in each cable element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“numccts” |
Number in parallel |
“length” |
Length of cable |
“ratsel” |
Rating selector, 1 = air, 2 = underground, 3 = duct |
Series Element Data
Below is a summary of some of the data in each series element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“numccts” |
Number in parallel |
Transformer Data
Below is a summary of some of the data in each transformer dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“isnameplate” |
Whether transformer uses nameplate format |
“numwindings” |
Number of windings |
“drawtank” |
Whether to draw a transformer tank |
“orientation” |
Orientation of the transformer symbol on the diagram |
“use_long_term_op_cond” |
Whether to use long-term operating conditions |
“long_term_op_pf” |
Power factor in LV winding before short-circuit |
“long_term_op_v” |
Operating voltage of LV winding before short-circuit (kV) |
“long_term_op_c” |
Operating current of LV winding before short-circuit (kA) |
“winding” |
List of winding data per winding |
Winding Data
Below is a summary of some of the data in each winding dictionary. Some of the data has instead been listed in common data. Windings are in a separate data list from transformer data.
Key |
Description |
|---|---|
“tapPos” |
Off load tap changer nominal tap (%) |
“embedded_cable” |
Embedded cable data if present |
“neutral_earth” |
Neutral earth data if present |
“tap_changer” |
Tap changer data if present |
Embedded Cable Data
Below is a summary of some of the data in each embbeded cable dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“numccts” |
Number in parallel |
“length” |
Length of cable |
“ratsel” |
Rating selector, 1 = air, 2 = underground, 3 = duct |
Neutral Earth Data
Below is a summary of some of the data in each neutral earth dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“re” |
Resistance (Ohms) |
“xe” |
Reactance (Ohms) |
Tap Changer Data
Below is a summary of some of the data in each tap changer dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“ctrlbus” |
ID of the busbar controlled by the tap changer |
“hitargetv” |
Upper target voltage (pu) |
“lotargetv” |
Lower target voltage (pu) |
“compind” |
Compounding selector, 0 = none, 1 = per unit winding rating, 2 = per unit study base, 3 = ohms |
“compr” |
Resistive compounding factor |
“compx” |
Reactive compounding factor |
Synchronous Machine Data
Below is a summary of some of the data in each synchronous machine dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“numccts” |
Number in parallel |
“model” |
Machine model, 1 = voltage behind an impedance, 2 = Park’s equation |
“machtype” |
Machine type, 1 = motor, 2 = generator |
“gtype” |
Generator type, 1 = slack, 2 = PV, 3 = PQ, 4 = VA |
“r1” |
Value dependent on “gtype” (see table below) |
“r2” |
Value dependent on “gtype” (see table below) |
“iec909pf” |
IEC 909 power factor |
“ctrlremotebus” |
Whether machine controls voltage at remote busbar |
“remotebus” |
ID of the remote busbar |
“avrsymbolvisible” |
Whether AVR symbol is visible |
“governorsymbolvisible” |
Whether governor symbol is visible |
‘r1’ data is below.
Generator type |
Description |
|---|---|
Slack |
Voltage magnitude (pu) |
PV |
Group assigned power (MW) |
PQ |
Group assigned power (MW) |
VA |
Voltage magnitude (pu) |
‘r2’ data is below.
Generator type |
Description |
|---|---|
Slack |
|
PV |
Voltage magnitude (pu) |
PQ |
Group assigned power (MVAr) |
VA |
Voltage angle (degrees) |
Embedded Transformer Data
Below is a summary of some of the data in each embbeded transformer dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“isnameplate” |
Whether the transformer employs the nameplate format |
“numccts” |
Number in parallel |
“neutral_earth” |
Embedded neutral earth data, if present |
Induction Machine Data
Below is a summary of some of the data in each induction machine dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“numccts” |
Number in parallel |
“machtype” |
Machine type, 1 = motor, 2 = generator |
“p” |
Group assigned power (MW) |
“mechkeyname” |
Mechanical load library key name |
“mechsymbolvisible” |
Whether mechanical load symbol is visible |
Shunt Data
Below is a summary of some of the data in each shunt element dictionary. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“numccts” |
Number in parallel |
“shunttype” |
Shunt type, 1 = MW/MVAr, 2 = MW/Power Factor, 3 = MVA/Power Factor, 4 = MVA/MW, 5 = kW/KVAr, 6 = kW/Power Factor, 7 = kVA/Power Factor, 8 = kVA/kW, 9 = G/B (pu on base), 10 = G/B (% on base), 11 = G/B (pu on rating), 12 = G/B (% on rating), 13 = G/B (S), 14 = R/X (pu on base), 15 = R/X (% on base), 16 = R/X (pu on rating), 17 = R/X (% on rating), 18 = R/X (ohms), 19 = I (A), 20 = I (kA) |
“r1” |
Value dependent on “shunttype” (see table below) |
“r2” |
Value dependent on “shunttype” (see table below) |
“ipkeyname” |
Harmonic Impedance Profile library key name |
“impedanceprofilesymbolvisible” |
Whether Harominc Impedance Profile symbol is visible |
“neutralearthsymbolvisible” |
Whether neutral earth symbol is visible |
‘r1’ data is below.
Shunt type |
Description |
|---|---|
1, 2 |
MW multiplier |
3, 4 |
MVA multiplier |
5, 6 |
kW multiplier |
7, 8 |
kVA multiplier |
9..13 |
G/B multiplier |
14..18 |
R/X multiplier |
19 |
I (A) multiplier |
20 |
I (kA) multiplier |
‘r2’ data is below.
Shunt type |
Description |
|---|---|
1 |
MVAr multiplier |
4 |
MW multiplier |
5 |
kVAR multiplier |
8 |
kW multiplier |
2, 3, 6, 7, 9..20 |
Not used, should be blank |
Protection Devices Data
Protection device data can vary a lot depending on the type of protection device. Below are just a few data items you might expect to find. Some of the data has instead been listed in common data.
Key |
Description |
|---|---|
“bookmarksymbolvisible” |
Whether the bookmark symbol is visible |
“withstandsymbolvisible” |
Whether the withstand symbol is visible |
“status” |
Status, 0 = off, 1 = on |
“idvisible” |
Whether ID is visible |
“recovery” |
Warning threshold |
“rating” |
Rating (A) |
Loadflow
Everything you need to know relating to Loadflow data and results.
Loadflow Results
Refer to LoadflowRecords Module.
Multi-Loadflow
This section contains a summary of important values regarding multi-loadflow. To learn more about multi-loadflow, please refer to the MultiLoadflow Module documentation.
Parameter Input Element Types
The following element types can be used to change element data or loadflow parameter data per study. The element ID and item ID used is dependent on what data you wish to change. The item ID’s match the data listed in the Data section above.
Key |
Description |
|---|---|
“LoadflowParam” |
Change a loadflow parameter value here |
“BusSection” |
Change data in a bus section here |
“Busbar” |
Change data in a busbar here |
“Arc_Flash_Enclosure” |
Change data in an arc flash enclosure here |
“Line” |
Change data in a transmission line here |
“Cable” |
Change data in a cable here |
“Series” |
Change data in a series element here |
“TapChanger” |
Change data in a tap changer here |
“Transformer” |
Change data in a transformer here |
“Switch” |
Change data in a switch here |
“Prot_Device” |
Change data in a protection device here |
“Shunt” |
Change data in a shunt here |
“IndMachine” |
Change data in an induction machine here |
“SyncMachine” |
Change data in a synchronous machine here |
“Neutral_Earth” |
Change data in a neutral earth here |
“Embedded_Cable” |
Change data in an embedded cable here |
“Embedded_Transformer” |
Change data in an embedded transformer here |
“Grid” |
Change data in a grid infeed here |
Result Selection Element Types
The following element types can be used to retrieve summary results or element results per study. For all types not listed below, refer to the table above in the previous section, which includes the same typecodes needed here. So for example, “Busbar” can be used to retrieve busbar results.
Key |
Description |
|---|---|
“Summary” |
Get a summary result, no element ID is required for this type |
Fault
Find out the data for each Fault data record at FaultRecords Module
Study Parameters
The order of study parameters is important and must be specified in the order given below
Key |
Description |
|---|---|
“Typecode” |
Typecode of the element to use. |
“Seqnum” |
Sequence number of the element. Load the data into an TEracsData object to find out. |
“ReactOption” |
Reactance Option [1 = Positive Sequence, 2 = Transient, 3 = Sub-Transient] |
“FaultType” |
Fault Type [1 = Phase to Earth, 2 = Phase to Phase, 3 = Two Phase to Earth, 4 = Three Phase, 5 = Single Phase Open Circuit, 6 = Two Phase Open Circuit] |
“FaultPos” |
Position of the fault along a cable or transmission line from the first busbar, as a percentage [0-100] |
“Rph” |
Fault’s Phase Resistance |
“Xph” |
Fault’s Phase Reactance |
“Rgrnd” |
Fault’s Ground Resistance |
“Xgrnd” |
Fault’s Ground Reactance |
“IncMotor” |
Include Motor Contribution [0 = No, 1 = Yes] |
Fault Results
Summary Results
Key |
Description |
|---|---|
“f1” |
Positive Sequence Fault Current (kA) |
“f2” |
Positive Sequence Fault Current Angle (degrees) |
“f3” |
Negative Sequence Fault Current (kA) |
“f4” |
Negative Sequence Fault Current Angle (degrees) |
“f5” |
Zero Sequence Fault Current (kA) |
“f6” |
Zero Sequence Fault Current Angle (degrees) |
“f7” |
Phase L1 Fault Current (kA) |
“f8” |
Phase L1 Fault Current Angle (degrees) |
“f9” |
Phase L2 Fault Current (kA) |
“f10” |
Phase L2 Fault Current Angle (degrees) |
“f11” |
Phase L3 Fault Current (kA) |
“f12” |
Phase L3 Fault Current Angle (degrees) |
“f13” |
Residual Fault Current (kA) |
“f14” |
Residual Fault Current Angle (degrees) |
“f15” |
Fault MVA |
“f16” |
X/R Ratio |
Busbar Results
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Vip” |
Positive Sequence Voltage (kV) |
“ThetaVip” |
Positive Sequence Voltage Angle (degrees) |
“Vin” |
Negative Sequence Voltage (kV) |
“ThetaVin” |
Negative Sequence Voltage Angle (degrees) |
“Viz” |
Zero Sequence Voltage (kV) |
“ThetaViz” |
Zero Sequence Voltage Angle (degrees) |
“Vi1” |
Phase L1 Voltage (kV) |
“ThetaVi1” |
Phase L1 Voltage Angle (degrees) |
“Vi2” |
Phase L2 Voltage (kV) |
“Vi2Theta” |
Phase L2 Voltage Angle (degrees) |
“Vi3” |
Phase L3 Voltage (kV) |
“ThetaVi3” |
Phase L3 Voltage Angle (degrees) |
“Vires” |
Residual Voltage (kV) |
“ThetaVires” |
Residual Voltage Angle (degrees) |
“FaultMVA” |
Fault MVA |
Transmission Line/Cable/Series Element/Bus Section Results
The same values exist for “End2.”
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“End1.Ip” |
Positive Sequence Fault Current (kA) |
“End1.ThetaIp” |
Positive Sequence Fault Current Angle (degrees) |
“End1.In” |
Negative Sequence Fault Current (kA) |
“End1.ThetaIn” |
Negative Sequence Fault Current Angle (degrees) |
“End1.Iz” |
Zero Sequence Fault Current (kA) |
“End1.ThetaIz” |
Zero Sequence Fault Current Angle (degrees) |
“End1.Il1” |
Phase L1 Fault Current (kA) |
“End1.ThetaIl1” |
Phase L1 Fault Current Angle (degrees) |
“End1.I12” |
Phase L2 Fault Current (kA) |
“End1.ThetaIl2” |
Phase L2 Fault Current Angle (degrees) |
“End1.Il3” |
Phase L3 Fault Current (kA) |
“End1.ThetaIl3” |
Phase L3 Fault Current Angle (degrees) |
“End1.Ires” |
Residual Fault Current (kA) |
“End1.ThetaIres” |
Residual Fault Current Angle (degrees) |
“End1.PowerDir” |
Direction of positive sequence power flow [-1 = Out of device, 0 = No Flow, 1 = Into device] |
“End1.ConInd” |
Connection Indicator [-1 = Element disconnected by calculation, 0 = Element disconnected, 1 = Element connected] |
Transformer Results
The same values exist for “Winding2.”, “Winding3.”, and “Winding4.”
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Winding1.Ip” |
Positive Sequence Fault Current (kA) |
“Winding1.ThetaIp” |
Positive Sequence Fault Current Angle (degrees) |
“Winding1.In” |
Negative Sequence Fault Current (kA) |
“Winding1.ThetaIn” |
Negative Sequence Fault Current Angle (degrees) |
“Winding1.Iz” |
Zero Sequence Fault Current (kA) |
“Winding1.ThetaIz” |
Zero Sequence Fault Current Angle (degrees) |
“Winding1.Il1” |
Phase L1 Fault Current (kA) |
“Winding1.ThetaIl1” |
Phase L1 Fault Current Angle (degrees) |
“Winding1.I12” |
Phase L2 Fault Current (kA) |
“Winding1.ThetaIl2” |
Phase L2 Fault Current Angle (degrees) |
“Winding1.Il3” |
Phase L3 Fault Current (kA) |
“Winding1.ThetaIl3” |
Phase L3 Fault Current Angle (degrees) |
“Winding1.Ires” |
Residual Fault Current (kA) |
“Winding1.ThetaIres” |
Residual Fault Current Angle (degrees) |
“Winding1.PowerDir” |
Direction of positive sequence power flow [-1 = Out of device, 0 = No Flow, 1 = Into device] |
“Winding1.ConInd” |
Connection Indicator [-1 = Element disconnected by calculation, 0 = Element disconnected, 1 = Element connected] |
“IntFaultContrib” |
If fault applied to Transformer, it’ll be pointer to similar results to Winding Results |
Neutral Earth Results
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Vne” |
Neutral Voltage (kV) |
“ThetaVne” |
Neutral Voltage Angle (degrees) |
“Ine” |
Neutral Current (kA) |
“ThetaIne” |
Neutral Current Angle (degrees) |
Synchronous Machine/Induction Machine/Shunt/Wind Turbine Generator Results
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Ip” |
Positive Sequence Fault Current (kA) |
“ThetaIp” |
Positive Sequence Fault Current Angle (degrees) |
“In” |
Negative Sequence Fault Current (kA) |
“ThetaIn” |
Negative Sequence Fault Current Angle (degrees) |
“Iz” |
Zero Sequence Fault Current (kA) |
“ThetaIz” |
Zero Sequence Fault Current Angle (degrees) |
“Il1” |
Phase L1 Fault Current (kA) |
“ThetaIl1” |
Phase L1 Fault Current Angle (degrees) |
“Il2” |
Phase L2 Fault Current (kA) |
“ThetaIl2” |
Phase L2 Fault Current Angle (degrees) |
“Il3” |
Phase L3 Fault Current (kA) |
“ThetaIl3” |
Phase L3 Fault Current Angle (degrees) |
“Ires” |
Residual Fault Current (kA) |
“ThetaIres” |
Residual Fault Current Angle (degrees) |
“PowerDir” |
Direction of positive sequence power flow [-1 = Out of device, 0 = No Flow, 1 = Into device] |
“ConInd” |
Connection Indicator [-1 = Element disconnected by calculation, 0 = Element disconnected, 1 = Element connected] |
Injection
Everything you need to know relating to Injection.
Injection Dictionary
The dictionary for adding a new harmonic current injection source to the current Harmonic Injection study. The keys are expected and an error will be raised if any are missing.
Key |
Description |
|---|---|
“typecode” |
The typecode of the harmonic current injection source element (an integer value) |
“id” |
If the keyname (below) is specified in the dictionary, this is the identifier for the element we’re wanting as an injection source. If keyname is not specified (and therefore it’s assumed we’re manually providing injection data in the dictionary), this is the harmonic current injection identifier (a string) |
“keyname” |
The keyname for the harmonic current library data that should be associated with the harmonic current injection source element. If this is provided, the other elements below apart from scalefact are optional |
“seqnum” |
The sequence number of the harmonic current injection source data (an integer value) |
“description” |
A description of the harmonic current injection source data. This can be set to an empty string for no description |
“units” |
The units used for the harmonic values. This should be 0 for relative magnitude in per unit or 1 for absolute magnitude in amperes |
“scalefact” |
The calculation program will multiply each magnitude value by this per unit scaling factor |
“harmvalues” |
A Python list of harmonic values in a dictionary, the dictionary is defined below |
HarmValues Dictionary
The dictionary layout to be used for an item in the harmvalues list passed in for a new injection source.
Key |
Description |
|---|---|
“n” |
The harmonic number |
“mag” |
The magnitude of the harmonic. Units are as specified in Injection Dictionary “units” above |
“angle” |
Angle of the harmonic (degrees) |
Injection Data
Find out the data for each Injection data record at InjectionRecords Module
Injection Results
IValues
Key |
Description |
|---|---|
“i” |
Current magnitude (A) |
“angle” |
Current angle (degrees) |
“anglerad” |
Current angle (radians) |
“ika” |
Current magnitude (kA) |
“iper” |
Current magnitude (% of Fundamental) |
“ipu” |
Current magnitude (pu) |
VValues
Key |
Description |
|---|---|
“v” |
Voltage magnitude (kV) |
“angle” |
Voltage angle (degrees) |
“anglerad” |
Voltage angle (radians) |
“vv” |
Voltage magnitude (V) |
“vper” |
Voltage magnitude (% of Fundamental) |
“vpu” |
Voltage magnitude (pu) |
Waveform Results
Key |
Description |
|---|---|
“ifft” |
The inverse fast fourier transform results, directly plottable using the Matplotlib Python library. The ifft is a list of magnitudes which should be plotted against the [0, 0.0001, 0.0002, 0.0003] # Time range
[-1.22483261e-03, 4.90912096e-01, 9.84337111e-01, 1.47817684e+00] # Ifft
# Example usage
matplotlib.plot(self.__Injection.TimeRange, result["waveforms"]["ifft"])
|
“harmonics” |
The individual harmonic waveforms, as a dictionary with harmonic values as the keys, directly plottable using the Matplotlib Python library. Each harmonic number is included, and each harmonic number has a list of magnitudes which should be plotted against the [0, 0.0001, 0.0002, 0.0003] # Time range
{1.0: array([-0.01044907, -0.00976586, -0.00747626, -0.00395688])} # Harmonics
# Example usage
matplotlib.plot(self.__Injection.TimeRange, result["waveforms"]["harmonics"][1.0])
|
Injection Results
Key |
Description |
|---|---|
“id” |
The identifier for the element (a string) |
“typecode” |
The typecode for the element (an integer value) |
“seqnum” |
The sequence number for the element (an integer value) |
“busbarid” |
The identifier of the busbar which the target element is attached to (a string) |
“d” |
Harmonic distortion (%) |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The injection source waveform results dictionary |
Busbar Results
Key |
Description |
|---|---|
“id” |
The identifier for the busbar (a string) |
“seqnum” |
The sequence number for the busbar (an integer value) |
“d” |
Harmonic distortion (%) |
“tff” |
Telephone form factor |
“busang” |
Busbar angle (degrees) |
“busangrad” |
Busbar angle (radians) |
“vfund” |
Fundamental voltage magnitude (kV) |
“vvfund” |
Fundamental voltage magnitude (V) |
“vfundangle” |
Fundamental voltage angle (degrees) |
“vfundanglerad” |
Fundamental voltage angle (radians) |
“vvalues” |
List of vvalues for each harmonic number |
“waveforms” |
The busbar waveform results dictionary |
Branch End Results
Key |
Description |
|---|---|
“d” |
Harmonic distortion (%) |
“tff” |
Telephone form factor |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The end waveform results dictionary for a particular end of a branch |
Transmission Line/Cable/Series Element Results
Key |
Description |
|---|---|
“id” |
The identifier for the branch element (a string) |
“seqnum” |
The sequence number for the branch element (an integer value) |
“end1” |
|
“end2” |
Winding Results
Key |
Description |
|---|---|
“d” |
Harmonic distortion (%) |
“tff” |
Telephone form factor |
“kf” |
K-factor |
“hlf” |
Harmonic Loss Factor |
“fk” |
Factor K |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The winding waveform results dictionary |
Transformer Results
Key |
Description |
|---|---|
“id” |
The identifier for the transformer (a string) |
“seqnum” |
The sequence number for the transformer (an integer value) |
“winding1” |
|
“winding2” |
|
“winding3” |
Winding 3 results or None |
“winding4” |
Winding 4 results or None |
Induction Machine/Synchronous Machine/Shunt Results
Key |
Description |
|---|---|
“id” |
The identifier for the leaf node (a string) |
“seqnum” |
The sequence number for the leaf node (an integer value) |
“busbarid” |
The identifier of the busbar which the leaf node is connected to (a string) |
“d” |
Harmonic distortion (%) |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The machine waveform results dictionary |
Typecodes
Number |
Element |
|---|---|
1 |
Busbar |
2 |
Transmission Line |
3 |
Cable |
4 |
Transformer |
5 |
Tap Changer |
6 |
Switch |
7 |
Induction Machine |
8 |
Synchronous Machine |
9 |
Shunt |
10 |
Bus Section |
11 |
Protection Device |
12 |
AVR |
13 |
Governor |
14 |
Series Element |
15 |
Wind Turbine Generator |
16 |
Auto Transformer |
17 |
Neutral Earth |
18 |
Mechanical Load |
19 |
Time Variant Function |
20 |
Controller |
22 |
Grid Infeed |
102 |
Harmonic Current Injection Source |
Dialog Prompts
Reasons
Integer Value |
Description |
|---|---|
0 |
No particular reason |
1 |
General warning |
2 |
Voltage convergence |
>2 |
An error of some sort |
Buttons
The integer value represents a bitflag. So for example, the integer value could be 3, meaning there’s ‘Yes’ and ‘No’ buttons (because 1[Yes] + 2[No] = 3[Yes/No]) read up about bitflags for more information.
Integer Value |
Description |
|---|---|
0 |
No buttons |
1 |
‘Yes’ button |
2 |
‘No’ button |
4 |
‘OK’ button |
8 |
‘Cancel’ button |
16 |
‘Help’ button |
32 |
‘Abort’ button |
64 |
‘Retry’ button |
128 |
‘Ignore’ button |
256 |
‘All’ button |