Running a short-circuit analysis#

You can use the module pypowsybl.shortcircuit in order to perform a shortcircuit analysis on a network. Please have a look at the examples below.

For detailed documentation of involved classes and methods, please refer to the API reference.

Note that pypowsybl currently does not include a simulator to perform short-circuit analyses.

Short-circuit analysis#

The current APIs allow the simulation of three-phase faults on buses or branches.

To perform a short-circuit analysis, you need a network and at least one fault to simulate on that network. The network should have a transient or subtransient reactance on at least one generator. This reactance is stored in the ‘generatorShortCircuit’ extension. The results of the analysis include the calculated currents and voltages on the network after the fault. Depending on parameters, the results will be given as three-phase magnitude or detailed on each phase. Optionally, depending on specific parameters of the simulation, the results also include

  • the contributions of each feeder to the short-circuit current

  • a list of all the violations after the fault

  • the voltages, that are higher than a threshold, calculated after the fault on the whole network

Available parameters#

The parameters available to run a shortcircuit analysis are:

  • with_fortescue_result: indicates whether the currents and voltages are to be given in three-phase magnitude or detailed with magnitude and angle on each phase. This parameter also applies to the feeder results and voltage results.

  • with_feeder_result: indicates whether the contributions of each feeder to the short circuit current at the fault node should be calculated.

  • with_limit_violations: indicates whether limit violations should be returned after the calculation. If true, a list of buses where the calculated shortcircuit current is higher than the maximum admissible current (stored in ip_max in the identifiableShortCircuit extension) or lower than the minimum admissible current (stored in ip_min in the identifiableShortCircuit extension).

  • with_voltage_result: indicates whether the voltage profile should be calculated on every node of the network

  • min_voltage_drop_proportional_threshold: specifies a threshold for filtering the voltage results. Only nodes where the voltage drop due to the short circuit is greater than this property are retained.

  • study_type: specifies the type of short circuit study. It can be SUB_TRANSIENT, TRANSIENT or STEADY_STATE.


Default value














Faults can be defined either on buses or on branches. The fault resistance and reactance, if specified, are connected in series to ground. In the case of faults on branches, then the location of the fault should be specified, in percent between the two sides of the branch, with the reference to the side 1.

The default values for the fault characteristics are:


Default value





proportional_location (for branch faults)


Simple example#

>>> import pypowsybl as pp
>>> import as pn
>>> import pandas as pd
>>> # create a network
>>> n = pn.create_four_substations_node_breaker_network()
>>> # sets some short-circuit parameters
>>> pars = pp.shortcircuit.Parameters(with_feeder_result = False, with_limit_violations = False, study_type = pp.shortcircuit.ShortCircuitStudyType.TRANSIENT)
>>> # create a short-circuit analysis context
>>> sc = pp.shortcircuit.create_analysis()
>>> # create a bus fault on the first two buses
>>> buses = n.get_buses()
>>> branches = n.get_branches()
>>> sc.set_faults(id = ['fault_1', 'fault_2'], element_id = [buses.index[0], branches.index[0]], r = [1, 1], x = [2, 2], )
>>> # perform the short-circuit analysis
>>> # results =, pars, 'sc_provider_1')
>>> # returns the analysis results
>>> # results.fault_results