PSCAD component reference

Every parameter of every component in PSCAD's Master Library, read out of PSCAD 5.0.0 itself: 345 definitions and 8,919 parameters, each with its unit, default, range and meaning, and the symbol each Choice is written as from a script.

The parameters people look up most

You wantParameterUnit or valueDefinition
Time a faultTF, DFsmaster:tfaultn
Which phases a fault is onA, B, C, GYES or NOmaster:tpflt
Fault resistanceRONohmmaster:tpflt
Time a breakerTO1, TO2smaster:tbreakn
Breaker state at the startBOpen1OPEN or CLOSEmaster:breaker3
A resistance, inductance or capacitanceR, L, Cohm, H, uFmaster:resistor, master:inductor, master:capacitor
Grid source voltageEskVmaster:source3
Single phase source voltage and frequencyVm, fkV, Hzmaster:source_1
The name a channel is read byName·master:pgb
A set-point held in a constantValue·master:const
Load powerPO, QOMW, MVARmaster:fixed_load
Machine inertiaHsmaster:sync_machine
Transformer saturation on or offEnab·master:xfmr-3p2w

PSCAD has no event list: a fault or a switching is a component drawn in the case, and a script times it by writing that component's parameters. The Three Phase Fault takes its timing from the Timed Fault Logic wired to it, which is why the timing is on master:tfaultn.

How a definition and a parameter are named

Definition
Namespace first, then the name, as PSCAD writes it: master:resistor, master:xfmr-3p2w. A component defined in the case itself has the case's own namespace.
Parameter
The short name in the first column, letter case included: R, RON, Vm. The description is what the component's dialog shows.
Unit
A number that carries a unit is written with it, "0.05 [ohm]", and PSCAD keeps the unit you give rather than converting it.
Choice
Written as its symbol: "YES", "BEHIND_SOURCE_IMPEDANCE". The words in the dialog are not accepted.
Used when
A parameter that only counts in some settings of another one, as the dialog shows or hides it.

Read and write any parameter

import mhi.pscad

pscad = mhi.pscad.connect()                # the PSCAD that is open; launch() starts one
project = pscad.project("my_case")         # a case loaded in the workspace

for r in project.find_all("master:resistor"):
    print(str(r.parameters()["R"]))         # its text carries the unit

flt = project.find_all("master:tfaultn")[0]
flt.parameters(TF="1.0 [s]", DF="0.12 [s]")  # fault at 1 s for 120 ms

project.run()                              # build if needed, then run the EMT simulation

New to it? Start with the PSCAD Python guide, or see every study you can automate. The Workflow Builder writes the whole script from blocks, and its component picker reads these same definitions.

Sources

Voltage and current sources, a battery, a photovoltaic and a wind source.

Passive branches, loads and filters

Resistors, inductors and capacitors, the configurable loads, tuned and high-pass filters, arresters.

Transformers and reactors

Classical and UMEC transformers of every winding count, saturable reactors, the SVC, instrument transformers.

Lines, cables and towers

Tower and cable cross-sections for the line constants program, PI sections, the line and cable interfaces.

Machines, exciters and governors

Synchronous, induction, permanent magnet and DC machines, with the IEEE exciters, governors and turbines.

Faults and switching

Faults and the timed fault logic that drives them, breakers and the timed breaker logic, power electronic switches.

Protection

Relays and the CT and CCVT models they read through.

Meters and output

Output channels, multimeters, RMS, frequency and power meters, harmonic calculators.

Control blocks

Constants, gains, transfer functions, limiters, logic, sequencers and signal transformations.

Runtime

File read, the optimum run and the components that act on the run itself.

Other components

Node labels, MMC cells, gamma controllers and the components PSCAD files under no other group.