Device models

class Bus(*, ibus, name='', baskv=0.0, ide=1, area=1, zone=1, owner=1, vm=1.0, va=0.0, nvhi=1.1, nvlo=0.9, evhi=1.1, evlo=0.9, gl=0.0, bl=0.0)

Bases: BaseModel

Bus record.

class Load(*, ibus, id='1', status=1, area=0, zone=0, pl=0.0, ql=0.0, ip=0.0, iq=0.0, yp=0.0, yq=0.0, owner=0, scale=1.0, intrpt=0, dgenp=0.0, dgenq=0.0, dgenm=0)

Bases: BaseModel

Load record.

class Generator(*, ibus, id='1', pg=0.0, qg=0.0, qt=9999.0, qb=-9999.0, vs=1.0, ireg=0, mbase=100.0, zr=0.0, zx=1.0, rt=0.0, xt=0.0, gtap=1.0, status=1, rmpct=100.0, pt=9999.0, pb=-9999.0, o1=0, f1=0.0, o2=0, f2=0.0, o3=0, f3=0.0, o4=0, f4=0.0, wmod=0, wpf=1.0, nreg=0)

Bases: BaseModel

Generator record.

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

• self -- The BaseModel instance.

• context -- The context.

class Branch(*, ibus, jbus, ckt='1', rpu=0.0, xpu=0.0, bpu=0.0, name='', rate1=0.0, rate2=0.0, rate3=0.0, rate4=0.0, rate5=0.0, rate6=0.0, rate7=0.0, rate8=0.0, rate9=0.0, rate10=0.0, rate11=0.0, rate12=0.0, gi=0.0, bi=0.0, gj=0.0, bj=0.0, st=1, met=1, length=0.0, o1=0, f1=0.0, o2=0, f2=0.0, o3=0, f3=0.0, o4=0, f4=0.0)

Bases: BaseModel

Non-transformer Branch (AC Line) record.

class Transformer(*, ibus, jbus, kbus=0, ckt='1', cw=1, cz=1, cm=1, mag1=0.0, mag2=0.0, line_b=0.0, nmetr=2, name='', status=1, o1=1, f1=1.0, o2=0, f2=0.0, o3=0, f3=0.0, o4=0, f4=0.0, vecgrp='', zcod=0, r1_2=0.0, x1_2=0.0, sbase1_2=100.0, r2_3=0.0, x2_3=0.0, sbase2_3=100.0, r3_1=0.0, x3_1=0.0, sbase3_1=100.0, vmstar=1.0, anstar=0.0, windv1=1.0, nomv1=0.0, ang1=0.0, wdg1rate1=0.0, wdg1rate2=0.0, wdg1rate3=0.0, cod1=0, cont1=0, rma1=1.1, rmi1=0.9, vma1=1.1, vmi1=0.9, ntp1=33, tab1=0, cr1=0.0, cx1=0.0, cnxa1=0.0, nod1=0, rate1_4=0.0, rate1_5=0.0, rate1_6=0.0, rate1_7=0.0, rate1_8=0.0, rate1_9=0.0, rate1_10=0.0, rate1_11=0.0, rate1_12=0.0, windv2=1.0, nomv2=0.0, ang2=0.0, wdg2rate1=0.0, wdg2rate2=0.0, wdg2rate3=0.0, cod2=0, cont2=0, rma2=1.1, rmi2=0.9, vma2=1.1, vmi2=0.9, ntp2=33, tab2=0, cr2=0.0, cx2=0.0, cnxa2=0.0, nod2=0, rate2_4=0.0, rate2_5=0.0, rate2_6=0.0, rate2_7=0.0, rate2_8=0.0, rate2_9=0.0, rate2_10=0.0, rate2_11=0.0, rate2_12=0.0, windv3=1.0, nomv3=0.0, ang3=0.0, wdg3rate1=0.0, wdg3rate2=0.0, wdg3rate3=0.0, cod3=0, cont3=0, rma3=1.1, rmi3=0.9, vma3=1.1, vmi3=0.9, ntp3=33, tab3=0, cr3=0.0, cx3=0.0, cnxa3=0.0, nod3=0, rate3_4=0.0, rate3_5=0.0, rate3_6=0.0, rate3_7=0.0, rate3_8=0.0, rate3_9=0.0, rate3_10=0.0, rate3_11=0.0, rate3_12=0.0)

Bases: BaseModel

Transformer record (2-winding or 3-winding).

property is_3winding

True if this is a 3-winding transformer.

class FixedShunt(*, ibus, id='1', status=1, gl=0.0, bl=0.0)

Bases: BaseModel

Fixed Shunt record.

class Area(*, iarea, isw=0, pdes=0.0, ptol=0.0, arname='')

Bases: BaseModel

Area record.

class Zone(*, izone, zoname='')

Bases: BaseModel

Zone record.

class Owner(*, i, owname='')

Bases: BaseModel

Owner record.

class SwitchedShunt(*, i, id='1', modsw=1, adjm=0, stat=1, vswhi=1.0, vswlo=1.0, swrem=0, swreg=0, nreg=0, rmpct=100.0, rmidnt='', binit=0.0, s1=1, n1=0, b1=0.0, s2=1, n2=0, b2=0.0, s3=1, n3=0, b3=0.0, s4=1, n4=0, b4=0.0, s5=1, n5=0, b5=0.0, s6=1, n6=0, b6=0.0, s7=1, n7=0, b7=0.0, s8=1, n8=0, b8=0.0)

Bases: BaseModel

Switched Shunt record.

class SystemSwitchingDevice(*, ibus, jbus, ckt='1', xpu=0.0, rate1=0.0, rate2=0.0, rate3=0.0, rate4=0.0, rate5=0.0, rate6=0.0, rate7=0.0, rate8=0.0, rate9=0.0, rate10=0.0, rate11=0.0, rate12=0.0, status=1, nstat=1, metered=1, stype=2, name='')

Bases: BaseModel

v34+ System Switching Device record (breaker or disconnect).

A switching device is functionally a non-transformer branch for power-flow purposes: it is treated as a zero-impedance line when its X is below ZTHRES, otherwise as a regular branch. The record has no R column — only a reactance X — and 12 ratings. STATUS in {1, 2} means closed (in service); STATUS = 0 is open.

class InterArea(*, arfrom, arto, id='1', ptran=0.0)

Bases: BaseModel

Inter-Area Transfer record.

class TwoTerminalDC(*, name='', mdc=0, rdc=0.0, setvl=0.0, vschd=0.0, vcmod=0.0, rcomp=0.0, delti=0.0, met='I', dcvmin=0.0, cccitmx=20, cccacc=1.0, ipr=0, nbr=1, anmxr=0.0, anmnr=0.0, rcr=0.0, xcr=0.0, ebasr=0.0, trr=1.0, tapr=1.0, tmxr=1.5, tmnr=0.51, stpr=0.00625, icr=0, ndr=0, ifr=0, itr=0, idr='1', xcapr=0.0, ipi=0, nbi=1, anmxi=0.0, anmni=0.0, rci=0.0, xci=0.0, ebasi=0.0, tri=1.0, tapi=1.0, tmxi=1.5, tmni=0.51, stpi=0.00625, ici=0, ndi=0, ifi=0, iti=0, idi='1', xcapi=0.0)

Bases: BaseModel

Two-Terminal DC Line record (3-line format).

class VscDCLine(*, name='', mdc=1, rdc=0.0, o1=None, f1=None, o2=None, f2=None, o3=None, f3=None, o4=None, f4=None, ibus1=0, type1=1, mode1=1, dcset1=0.0, acset1=1.0, aloss1=0.0, bloss1=0.0, minloss1=0.0, smax1=0.0, imax1=0.0, pwf1=1.0, maxq1=9999.0, minq1=-9999.0, vsreg1=0, nreg1=0, rmpct1=100.0, ibus2=0, type2=1, mode2=1, dcset2=0.0, acset2=1.0, aloss2=0.0, bloss2=0.0, minloss2=0.0, smax2=0.0, imax2=0.0, pwf2=1.0, maxq2=9999.0, minq2=-9999.0, vsreg2=0, nreg2=0, rmpct2=100.0)

Bases: BaseModel

VSC DC Line record (3-line format).

class MTDCConverter(*, ib, nbrdg, angmx, angmn, rc, xc, ebas, tr=1.0, tap=1.0, tpmx=1.5, tpmn=0.51, tstp=0.00625, setvl, dcpf=1.0, marg=0.0, cnvcod=1)

Bases: BaseModel

Multi-Terminal DC converter station.

class MTDCBus(*, idc, ib=0, area=1, zone=1, dcname='', idc2=0, rgrnd=0.0, owner=1)

Bases: BaseModel

Multi-Terminal DC bus.

class MTDCLink(*, idc, jdc, dcckt='1', met=1, rdc, ldc=0.0)

Bases: BaseModel

Multi-Terminal DC link (branch).

class MultiTerminalDC(*, name='', nconv, ndcbs, ndcln, mdc=0, vconv, vcmod=0.0, vconvn=0, converters=<factory>, dcbuses=<factory>, dclinks=<factory>)

Bases: BaseModel

Multi-Terminal DC transmission line (variable-length record).

class Facts(*, name='', i, j=0, mode=1, pdes=0.0, qdes=0.0, vset=1.0, shmx=9999.0, trmx=9999.0, vtmn=0.9, vtmx=1.1, vsmx=1.0, imx=0.0, linx=0.05, rmpct=100.0, owner=1, set1=0.0, set2=0.0, vsref=0, fcreg=0, nreg=0, remot=0, mname='')

Bases: BaseModel

FACTS Device record.

class MultiSectionLine(*, i, j, id='&1', met=1, dum1=None, dum2=None, dum3=None, dum4=None, dum5=None, dum6=None, dum7=None, dum8=None, dum9=None)

Bases: BaseModel

Multi-Section Line Grouping record.

class ImpedanceCorrection(*, i, t1=0.0, f1=0.0, t2=None, f2=None, t3=None, f3=None, t4=None, f4=None, t5=None, f5=None, t6=None, f6=None, t7=None, f7=None, t8=None, f8=None, t9=None, f9=None, t10=None, f10=None, t11=None, f11=None, t12=None, f12=None, im_f1=0.0, im_f2=None, im_f3=None, im_f4=None, im_f5=None, im_f6=None, im_f7=None, im_f8=None, im_f9=None, im_f10=None, im_f11=None, im_f12=None)

Bases: BaseModel

Impedance Correction Table record.