pwrs.core.runcpf#

pwrs.core.runcpf.runcpf(basecasedata: str | MatpowerCase | Mapping[str, object], targetcasedata: str | MatpowerCase | Mapping[str, object], mpopt_value: MatpowerConfig | Mapping[str, object] | None = None, fname: str = '', solvedcase: str = '', *, nargout: None | Literal[1] = None) → ContinuationPowerFlowResult[source]#
pwrs.core.runcpf.runcpf(basecasedata: str | MatpowerCase | Mapping[str, object], targetcasedata: str | MatpowerCase | Mapping[str, object], mpopt_value: MatpowerConfig | Mapping[str, object] | None = None, fname: str = '', solvedcase: str = '', *, nargout: Literal[2]) → tuple[ContinuationPowerFlowResult, bool]
pwrs.core.runcpf.runcpf(basecasedata: str | MatpowerCase | Mapping[str, object], targetcasedata: str | MatpowerCase | Mapping[str, object], mpopt_value: MatpowerConfig | Mapping[str, object] | None = None, fname: str = '', solvedcase: str = '', *, nargout: int) → ContinuationPowerFlowResult | tuple[ContinuationPowerFlowResult, bool]

Run a full AC continuation power flow.

Parameters:

  • basecasedata (dict or str, optional) – MATPOWER case dict or case-file name defining the base loading and generation.

  • targetcasedata (dict or str, optional) – MATPOWER case dict or case-file name defining the target loading and generation.

  • mpopt_value (dict, optional) – MATPOWER options dict controlling parameterization, adaptive step sizing, limits enforcement, and output behavior.

  • 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 CPF result and optional success flag.

Return type:

ContinuationPowerFlowResult or tuple

pwrs.core.runcpf.runcpf_with_success(basecasedata, targetcasedata, mpopt_value=None, fname='', solvedcase='')[source]#

Run a CPF and return (result, success).

Parameters:

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

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

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

  • fname (str)

  • solvedcase (str)

Return type:

tuple[ContinuationPowerFlowResult, bool]