pwrs.core.runopf#

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

Run an optimal power flow.

Parameters:

  • casedata (dict or str, optional) – MATPOWER case dict or case-file name. Defaults to "case9".

  • mpopt (MatpowerConfig or dict, optional) – MATPOWER options configuration used to select the OPF algorithm, output options, tolerances, 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 (baseMVA, bus, gen, gencost, branch, f, success, et).

Return type:

OptimalPowerFlowResult or tuple

pwrs.core.runopf.runopf_with_success(casedata='case9', mpopt=None, fname='', solvedcase='')[source]#

Run an OPF and return (result, success).

Parameters:

  • casedata (str | MatpowerCase | Mapping[str, object])

  • mpopt (MatpowerConfig | Mapping[str, object] | None)

  • fname (str)

  • solvedcase (str)

Return type:

tuple[OptimalPowerFlowResult, bool]

pwrs.core.runopf.runopf_expanded(casedata='case9', mpopt=None, fname='', solvedcase='')[source]#

Run an OPF and return the named MATLAB-style expanded result.

Parameters:

  • casedata (str | MatpowerCase | Mapping[str, object])

  • mpopt (MatpowerConfig | Mapping[str, object] | None)

  • fname (str)

  • solvedcase (str)

Return type:

OptimalPowerFlowExpandedResult