pwrs.core.runpf#

pwrs.core.runpf.runpf(casedata: str | MatpowerCase | Mapping[str, object], mpopt: MatpowerConfig | None = None, fname: str = '', solvedcase: str = '', *, nargout: None | Literal[1] = None) → PowerFlowResult[source]#
pwrs.core.runpf.runpf(casedata: str | MatpowerCase | Mapping[str, object], mpopt: MatpowerConfig | None = None, fname: str = '', solvedcase: str = '', *, nargout: Literal[2]) → tuple[PowerFlowResult, bool]
pwrs.core.runpf.runpf(casedata: str | MatpowerCase | Mapping[str, object], mpopt: MatpowerConfig | None = None, fname: str = '', solvedcase: str = '', *, nargout: int) → PowerFlowResult | tuple[PowerFlowResult, bool] | PowerFlowExpandedResult | None

Run a power flow.

Parameters:

  • casedata (MatpowerCase or dict) – MATPOWER case struct or dictionary.

  • mpopt (MatpowerConfig, optional) – MATPOWER options dict controlling the PF algorithm, tolerances, output options, and related settings.

  • fname (str, optional) – File name to which pretty-printed output is appended.

  • solvedcase (str, optional) – File name where the solved case is saved in MATPOWER case format.

  • nargout (int, optional) – Number of outputs to emulate from the MATLAB interface.

Returns:

With one or two outputs, returns the structured solved result and optional success flag. With more outputs, returns the MATLAB-style tuple for the solved case data and summary outputs.

Return type:

PowerFlowResult or tuple

pwrs.core.runpf.runpf_with_success(casedata, mpopt=None, fname='', solvedcase='')[source]#

Run a power flow and return (results, success).

Parameters:
Return type:

tuple[PowerFlowResult, bool]

pwrs.core.runpf.runpf_expanded(casedata, mpopt=None, fname='', solvedcase='')[source]#

Run a power flow and return the named MATLAB-style expanded result.

Parameters:
Return type:

PowerFlowExpandedResult