dragonfly_energy.opendss.transformerprop module

Transformer properties in OpenDSS.

class dragonfly_energy.opendss.transformerprop.TransformerProperties(identifier, kva, resistance=0.1, reactance=0.1, phase_count=3, high_voltage=13.2, low_voltage=0.48, is_center_tap=False, connection='Wye-Wye')[source]

Bases: object

Represents the properties of a Transformer in OpenDSS.

Parameters:

  • identifier – Text string for a unique wire property ID. Must contain only characters that are acceptable in OpenDSS. This will be used to identify the object across the exported geoJSON and OpenDSS files.

  • kva – Base kVA rating of the transformer in kiloVolt-Amps.

  • resistance – A number for the electrical resistance of the transformer in ohms. (Default: 0.1).

  • reactance – A number for the electrical reactance of the transformer in per-unit values (p.u. transf). (Default: 0.1).

  • phase_count – An integer for the number of phases in the transformer. Typically, this is either 1 or 3. (Default: 3).

  • high_voltage – A number for the high voltage of the transformer in kiloVolts. (Default: 13.2).

  • low_voltage – A number for the low voltage of the transformer in kiloVolts. (Default: 0.48).

  • is_center_tap – Boolean for whether the transformer is center-tapped (True) or not (False). (Default: False).

  • connection – Text for the type of internal connection in the transformer, either “Wye-Wye”, “Wye-Delta”, “Delta-Wye” or “Delta-Delta”. (Default: “Wye-Wye”).

Properties:

  • identifier

  • display_name

  • kva

  • resistance

  • reactance

  • phase_count

  • high_voltage

  • low_voltage

  • is_center_tap

  • connection

ToString()[source]

Overwrite .NET ToString method.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a TransformerProperties object from a dictionary.

Parameters:

data – A dictionary representation of a TransformerProperties object in the format below.

{
'type': 'TransformerProperties',
'identifier': 'Transformer--50KVA PM',  # unique identifier
'kva': 50,  # kVA rating of the transformer
'resistance': 0.1,  # transformer resistance in ohms
'reactance': 0.1,  # transformer reactance in ohms
'phase_count': 3,  # number of transformer phases
'high_voltage': 13.2,  # transformer high voltage in kV
'low_voltage': 0.48,  # transformer low voltage in kV
'is_center_tap': False,  # boolean for if the transformer is center-tapped
'connection': 'Wye-Wye'  # text for the type of connection
}
classmethod from_electrical_database_dict(data)[source]

Create from a dictionary as it appears in electrical_database.json.

Parameters:

data – A dictionary representation of an TransformerProperties object in the format below.

{
'Name': 'MAT_1I_230_69',  # unique identifier
'Installed Power(kVA)': 50,  # kVA rating of the transformer
'Low-voltage-side short-circuit resistance (ohms)': 0.1,  # resistance (ohms)
'Reactance (p.u. transf)': 0.1,  # transformer reactance in ohms
'Nphases': 3,  # number of transformer phases
'Primary Voltage (kV)': 13.2,  # transformer high voltage in kV
'Secondary Voltage (kV)': 0.48,  # transformer low voltage in kV
'Centertap': False,  # boolean for if the transformer is center-tapped
'connection': 'Wye-Wye'  # text for the type of connection
}
lock()
to_dict()[source]

Get TransformerProperties dictionary.

to_electrical_database_dict()[source]

Get Wire as it should appear in the URBANopt electrical_database.json.

unlock()
VALID_CONNECTIONS = ('Wye-Wye', 'Wye-Delta', 'Delta-Wye', 'Delta-Delta')
property connection

Get or set text for the type of internal connection in the transformer.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property high_voltage

Get or set a number for the high voltage of the transformer in kiloVolts.

property identifier

Get or set a text string for the unique object identifier.

property is_center_tap

Get or set a boolean for whether the transformer is center-tapped.

property kva

Get or set a number for the base kVA rating of the transformer in kVA.

property low_voltage

Get or set a number for the low voltage of the transformer in kiloVolts.

property phase_count

Get or set an integer for the number of phases of the transformer.

property reactance

Get or set a number for the reactance of the transformer in p.u. transf.

property resistance

Get or set a number for the resistance of the transformer in ohms.