Module caseformat

source code

Defines the PYPOWER case file format.

A PYPOWER case file is a Python file or MAT-file that defines or returns a dict named ppc, referred to as a "PYPOWER case dict". The keys of this dict are baseMVA, bus, gen, branch, and (optional) gencost. With the exception of baseMVA, a scalar, each data variable is an array, where a row corresponds to a single bus, branch, gen, etc. The format of the data is similar to the PTI format described in

http://www.ee.washington.edu/research/pstca/formats/pti.txt

PYPOWER Case Version Information:

There are two versions of the PYPOWER case file format. The current version of PYPOWER uses version 2 of the PYPOWER case format internally, and includes a 'version' field with a value of '2' to make the version explicit. Earlier versions of PYPOWER used the version 1 case format, which defined the data matrices as individual variables, as opposed to keys of a dict. Case files in version 1 format with OPF data also included an (unused) 'areas' variable. While the version 1 format has now been deprecated, it is still be handled automatically by loadcase and savecase which are able to load and save case files in both version 1 and version 2 formats.

See also idx_bus, idx_brch, idx_gen, idx_area and idx_cost regarding constants which can be used as named column indices for the data matrices. Also described in the first three are additional results columns that are added to the bus, branch and gen matrices by the power flow and OPF solvers.

The case dict also also allows for additional fields to be included. The OPF is designed to recognize fields named A, l, u, H, Cw, N, fparm, z0, zl and zu as parameters used to directly extend the OPF formulation (see opf for details). Other user-defined fields may also be included and will be automatically loaded by the loadcase function and, given an appropriate 'savecase' callback function (see add_userfcn), saved by the savecase function.

Bus Data Format

1. bus number (positive integer)
2. bus type
   • PQ bus = 1
   • PV bus = 2
   • reference bus = 3
   • isolated bus = 4
3. Pd, real power demand (MW)
4. Qd, reactive power demand (MVAr)
5. Gs, shunt conductance (MW demanded at V = 1.0 p.u.)
6. Bs, shunt susceptance (MVAr injected at V = 1.0 p.u.)
7. area number, (positive integer)
8. Vm, voltage magnitude (p.u.)
9. Va, voltage angle (degrees)
10. baseKV, base voltage (kV)
11. zone, loss zone (positive integer)
12. maxVm, maximum voltage magnitude (p.u.)
13. minVm, minimum voltage magnitude (p.u.)

Generator Data Format

1. bus number
2. Pg, real power output (MW)
3. Qg, reactive power output (MVAr)
4. Qmax, maximum reactive power output (MVAr)
5. Qmin, minimum reactive power output (MVAr)
6. Vg, voltage magnitude setpoint (p.u.)
7. mBase, total MVA base of this machine, defaults to baseMVA
8. status,
   • > 0 - machine in service
   • <= 0 - machine out of service
9. Pmax, maximum real power output (MW)
10. Pmin, minimum real power output (MW)
11. Pc1, lower real power output of PQ capability curve (MW)
12. Pc2, upper real power output of PQ capability curve (MW)
13. Qc1min, minimum reactive power output at Pc1 (MVAr)
14. Qc1max, maximum reactive power output at Pc1 (MVAr)
15. Qc2min, minimum reactive power output at Pc2 (MVAr)
16. Qc2max, maximum reactive power output at Pc2 (MVAr)
17. ramp rate for load following/AGC (MW/min)
18. ramp rate for 10 minute reserves (MW)
19. ramp rate for 30 minute reserves (MW)
20. ramp rate for reactive power (2 sec timescale) (MVAr/min)
21. APF, area participation factor

Branch Data Format

1. f, from bus number
2. t, to bus number
3. r, resistance (p.u.)
4. x, reactance (p.u.)
5. b, total line charging susceptance (p.u.)
6. rateA, MVA rating A (long term rating)
7. rateB, MVA rating B (short term rating)
8. rateC, MVA rating C (emergency rating)
9. ratio, transformer off nominal turns ratio ( = 0 for lines )
10. angle, transformer phase shift angle (degrees), positive => delay (Gf, shunt conductance at from bus p.u.) (Bf, shunt susceptance at from bus p.u.) (Gt, shunt conductance at to bus p.u.) (Bt, shunt susceptance at to bus p.u.)
11. initial branch status, 1 - in service, 0 - out of service
12. minimum angle difference, angle(Vf) - angle(Vt) (degrees)
13. maximum angle difference, angle(Vf) - angle(Vt) (degrees)

Generator Cost Data Format

NOTE: If gen has ng rows, then the first ng rows of gencost contain the cost for active power produced by the corresponding generators. If gencost has 2*ng rows then rows ng+1 to 2*ng contain the reactive power costs in the same format.

1. model, 1 - piecewise linear, 2 - polynomial
2. startup, startup cost in US dollars
3. shutdown, shutdown cost in US dollars
4. N, number of cost coefficients to follow for polynomial cost function, or number of data points for piecewise linear
5. and following, parameters defining total cost function f(p), units of f and p are $/hr and MW (or MVAr), respectively. (MODEL = 1) : p0, f0, p1, f1, ..., pn, fn where p0 < p1 < ... < pn and the cost f(p) is defined by the coordinates (p0,f0), (p1,f1), ..., (pn,fn) of the end/break-points of the piecewise linear cost function (MODEL = 2) : cn, ..., c1, c0 n+1 coefficients of an n-th order polynomial cost function, starting with highest order, where cost is f(p) = cn*p^n + ... + c1*p + c0

Area Data Format (deprecated)

(this data is not used by PYPOWER and is no longer necessary for version 2 case files with OPF data).

1. i, area number
2. price_ref_bus, reference bus for that area