bus.csv

This file is used to define buses. Add one row for each bus in the system. Each row in the CSV file will cause a bus dictionary object to be added to ['elements']['bus'] in the Egret model.

Each row with a non-zero MW Load and/or non-zero MVAR Load will also cause a load to be added to ['elements']['load'] in Egret, and each row with a non-zero MW Shunt G and/or non-zero MVAR Shunt B will cause a shunt to be added to ['elements']['shunt'] in Egret.

bus.csv Columns

Column Name

Description

Egret

Bus ID

A unique string identifier for the bus. This string is used to refer to this bus in other CSV files.

Not used by Egret except during parsing of CSV files.

Bus Name

A human-friendly unique string for this bus.

Used as the bus name in Egret. Data for this bus is stored in a bus dictionary stored at ['elements']['bus'][<Bus Name>].

This is also the name of the load, if a load is added for the bus (a load is added if MW Load or MVAR Load is non-zero). The load dictionary is stored at ['elements']['load'][<Bus Name>].

This is also the name of the shunt, if a shunt is added for the bus (a bus is added if MW Shunt G or MVAR Shunt G is non-zero). The shunt dictionary is stored at ['elements']['shunt'][<Bus Name>].

BaseKV

The bus base voltage. Must be non-zero positive.

Stored in the Egret bus dictionary as base_kv.

Bus Type

The type of bus. Can be one of the following:

  • PQ

  • PV

  • Ref

Stored in Egret bus dictionary as matpower_bustype. The Ref bus type is stored in Egret in all lower case (ref).

MW Load

Magnitude of the load on the bus.

Stored in the Egret bus dictionary as p_load. A non-zero value causes a load to be added; see Bus Loads.

MVAR Load

Magnitude of the reactive load on the bus.

Stored in the Egret bus dictionary as q_load. A non-zero value causes a load to be added; see Bus Loads.

V Mag

Voltage magnitude setpoint

Stored in the Egret bus dictionary as vm.

V Angle

Voltage angle setpoint in degrees

Stored in the Egret bus dictionary as va. If the Bus Type is Ref, this value must be 0.0.

Area

The area the bus is in.

Stored in the Egret bus dictionary as area. An area dictionary is added to the Egret model for each unique area mentioned in the file. The Egret area dictionary is found at ['elements']['area'][<Area>]. See Areas.

Zone

The zone the bus is in.

Stored in the Egret bus dictionary as zone.

MW Shunt G

Optional.

Stored in the shunt dictionary as gs. See Shunts.

MVAR Shunt B

Optional.

Stored in the shunt dictionary as bs. See Shunts.

va

Reference bus angle. If the Bus Type is Ref, va is required and must be zero.

Additional Bus Values

The following values are automatically added to the bus dictionary:

  • v_min = 0.95

  • v_max = 1.05

Bus Loads

If a bus has a non-zero MW Load or MVAR Load, a load dictionary is added to Egret at ['elements']['load'][<Bus Name>]. The load dictionary will have the following values taken from bus.csv:

  • bus = Bus Name

  • p_load = MW Load

  • q_load = MVAR Load

  • area = Area

  • zone = Zone

An additional property is automatically added, always with the same value:

  • in_service = true

Loads can (and usually do) vary throughout the study horizon. Variable loads are defined using a timeseries (see timeseries_pointers.csv).

Shunts

If a bus has a non-zero MW Shunt G or a non-zero MVAR Shunt B, a shunt dictionary is added to Egret at ['elements']['shunt'][<Bus Name>]. The shunt dictionary will have the following values taken from bus.csv:

  • bus = Bus Name

  • gs = MW Shunt G

  • bs = MVAR Shunt B

An additional property is automatically added, always with the same value:

  • shunt_type = fixed

Areas

Each unique area mentioned in bus.csv leads to an area being created in the Egret model at ['elements']['area'][<Area>], using the area name as it appears in bus.csv.