Source code for pypowsybl.shortcircuit.impl.util

# Copyright (c) 2023, RTE (
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at
# SPDX-License-Identifier: MPL-2.0
from typing import List
from pypowsybl import _pypowsybl
from .short_circuit_analysis import ShortCircuitAnalysis

[docs]def create_analysis() -> ShortCircuitAnalysis: """ Creates a short-circuit analysis object, which can be used to run a short-circuit analysis on a network Examples: .. code-block:: >>> analysis = pypowsybl.shortcircuit.create_analysis() >>> analysis.set_faults(id='F1', element_id='Bus1', r= 1, x= 2) >>> res =, parameters, provider_name) Returns: A short-circuit analysis object. """ return ShortCircuitAnalysis(_pypowsybl.create_shortcircuit_analysis())
[docs]def set_default_provider(provider: str) -> None: """ Set the default short-circuit analysis provider. Args: provider: name of the default short-circuit analysis provider to set """ _pypowsybl.set_default_shortcircuit_analysis_provider(provider)
[docs]def get_default_provider() -> str: """ Get the current default short-circuit analysis provider. Returns: the name of the current default short-circuit analysis provider """ return _pypowsybl.get_default_shortcircuit_analysis_provider()
[docs]def get_provider_names() -> List[str]: """ Get list of supported provider names Returns: the list of supported provider names """ return _pypowsybl.get_shortcircuit_provider_names()
def get_provider_parameters_names(provider: str = '') -> List[str]: """ Get list of parameters for the specified short-circuit analysis provider. If not specified the provider will be the default one. Returns: the list of provider's parameters """ return _pypowsybl.get_shortcircuit_provider_parameters_names(provider)