pwrs.corex.results#

Structured public result types for MATPOWER-compatible analyses.

class pwrs.corex.results.BoundMultipliers(lower=<factory>, upper=<factory>)[source]#

Bases: StructuredMapping

Lower and upper multipliers; legacy keys are l and u.

Parameters:

  • lower (FloatArray)

  • upper (FloatArray)

to_dict()[source]#

Return a MATPOWER-compatible mapping, including extension fields.

Return type:

dict[str, object]

class pwrs.corex.results.CaseResult(version='2', baseMVA=100.0, bus=<factory>, gen=<factory>, branch=<factory>, success=False, iterations=0, et=0.0, gencost=None, dcline=None, dclinecost=None, areas=None, gentype=None, genfuel=None, bus_name=None, branch_name=None, order=None, A=None, l=None, u=None, N=None, fparm=None, H=None, Cw=None, z0=None, zl=None, zu=None, comments=None, userfcn=None)[source]#

Bases: StructuredMapping

Common solved-case fields shared by PF, OPF and CPF results.

Parameters:

  • version (str)

  • baseMVA (float)

  • bus (FloatArray)

  • gen (FloatArray)

  • branch (FloatArray)

  • success (bool)

  • iterations (int)

  • et (float)

  • gencost (FloatArray | None)

  • dcline (FloatArray | None)

  • dclinecost (FloatArray | None)

  • areas (FloatArray | None)

  • gentype (list[str] | None)

  • genfuel (list[str] | None)

  • bus_name (list[str] | None)

  • branch_name (list[str] | None)

  • order (ResultOrder | None)

  • A (Matrix | None)

  • l (FloatArray | None)

  • u (FloatArray | None)

  • N (Matrix | None)

  • fparm (FloatArray | None)

  • H (Matrix | None)

  • Cw (FloatArray | None)

  • z0 (FloatArray | None)

  • zl (FloatArray | None)

  • zu (FloatArray | None)

  • comments (list[str] | None)

  • userfcn (list[object] | None)

class pwrs.corex.results.ContinuationPowerFlowResult(version='2', baseMVA=100.0, bus=<factory>, gen=<factory>, branch=<factory>, success=False, iterations=0, et=0.0, gencost=None, dcline=None, dclinecost=None, areas=None, gentype=None, genfuel=None, bus_name=None, branch_name=None, order=None, A=None, l=None, u=None, N=None, fparm=None, H=None, Cw=None, z0=None, zl=None, zu=None, comments=None, userfcn=None, cpf=<factory>)[source]#

Bases: CaseResult

Continuation power-flow result with its typed continuation trace.

Parameters:

  • version (str)

  • baseMVA (float)

  • bus (FloatArray)

  • gen (FloatArray)

  • branch (FloatArray)

  • success (bool)

  • iterations (int)

  • et (float)

  • gencost (FloatArray | None)

  • dcline (FloatArray | None)

  • dclinecost (FloatArray | None)

  • areas (FloatArray | None)

  • gentype (list[str] | None)

  • genfuel (list[str] | None)

  • bus_name (list[str] | None)

  • branch_name (list[str] | None)

  • order (ResultOrder | None)

  • A (Matrix | None)

  • l (FloatArray | None)

  • u (FloatArray | None)

  • N (Matrix | None)

  • fparm (FloatArray | None)

  • H (Matrix | None)

  • Cw (FloatArray | None)

  • z0 (FloatArray | None)

  • zl (FloatArray | None)

  • zu (FloatArray | None)

  • comments (list[str] | None)

  • userfcn (list[object] | None)

  • cpf (CpfTrace)

class pwrs.corex.results.CpfEvent(eidx: 'int' = 0, name: 'str' = '', zero: 'bool' = False, idx: 'IntArray' = <factory>, step_scale: 'float | FloatArray' = 1.0, log: 'bool' = False, msg: 'str' = '')[source]#

Bases: StructuredMapping

Parameters:

  • eidx (int)

  • name (str)

  • zero (bool)

  • idx (IntArray)

  • step_scale (float | FloatArray)

  • log (bool)

  • msg (str)

class pwrs.corex.results.CpfTrace(V: 'ComplexArray' = <factory>, V_hat: 'ComplexArray' = <factory>, lam: 'FloatArray' = <factory>, lam_hat: 'FloatArray' = <factory>, steps: 'FloatArray' = <factory>, iterations: 'int' = 0, max_lam: 'float' = 0.0, events: 'list[CpfEvent]' = <factory>, done_msg: 'str' = '')[source]#

Bases: StructuredMapping

Parameters:

  • V (ComplexArray)

  • V_hat (ComplexArray)

  • lam (FloatArray)

  • lam_hat (FloatArray)

  • steps (FloatArray)

  • iterations (int)

  • max_lam (float)

  • events (list[CpfEvent])

  • done_msg (str)

class pwrs.corex.results.NamedBoundMultipliers(lower=<factory>, upper=<factory>)[source]#

Bases: StructuredMapping

Named lower and upper multiplier vectors.

Parameters:

  • lower (dict[str, FloatArray | ComplexArray])

  • upper (dict[str, FloatArray | ComplexArray])

to_dict()[source]#

Return a MATPOWER-compatible mapping, including extension fields.

Return type:

dict[str, object]

class pwrs.corex.results.OpfLinearConstraintResults(mu=<factory>)[source]#

Bases: StructuredMapping

Named linear-constraint multipliers.

Parameters:

mu (NamedBoundMultipliers)

class pwrs.corex.results.OpfMultipliers(var: 'BoundMultipliers | None' = None, nln: 'BoundMultipliers | None' = None, lin: 'BoundMultipliers | None' = None, nle: 'FloatArray | None' = None, nli: 'FloatArray | None' = None)[source]#

Bases: StructuredMapping

Parameters:
class pwrs.corex.results.OpfNonlinearEqualityResults(multipliers=<factory>)[source]#

Bases: StructuredMapping

Named nonlinear-equality multipliers; legacy key is lambda.

Parameters:

multipliers (dict[str, FloatArray | ComplexArray])

to_dict()[source]#

Return a MATPOWER-compatible mapping, including extension fields.

Return type:

dict[str, object]

class pwrs.corex.results.OpfNonlinearInequalityResults(multipliers=<factory>)[source]#

Bases: StructuredMapping

Named nonlinear-inequality multipliers; legacy key is mu.

Parameters:

multipliers (dict[str, FloatArray | ComplexArray])

to_dict()[source]#

Return a MATPOWER-compatible mapping, including extension fields.

Return type:

dict[str, object]

class pwrs.corex.results.OpfVariableResults(values_by_name=<factory>, mu=<factory>)[source]#

Bases: StructuredMapping

Named OPF variable values and bound multipliers.

Parameters:
to_dict()[source]#

Return a MATPOWER-compatible mapping, including extension fields.

Return type:

dict[str, object]

class pwrs.corex.results.OptimalPowerFlowExpandedResult(baseMVA, bus, gen, gencost, branch, f, success, et)[source]#

Bases: NamedTuple

Parameters:

  • baseMVA (float)

  • bus (FloatArray)

  • gen (FloatArray)

  • gencost (FloatArray | None)

  • branch (FloatArray)

  • f (float | FloatArray)

  • success (bool)

  • et (float)

baseMVA: float#

Alias for field number 0

bus: FloatArray#

Alias for field number 1

gen: FloatArray#

Alias for field number 2

gencost: FloatArray | None#

Alias for field number 3

branch: FloatArray#

Alias for field number 4

f: float | FloatArray#

Alias for field number 5

success: bool#

Alias for field number 6

et: float#

Alias for field number 7

class pwrs.corex.results.OptimalPowerFlowResult(version='2', baseMVA=100.0, bus=<factory>, gen=<factory>, branch=<factory>, success=False, iterations=0, et=0.0, gencost=None, dcline=None, dclinecost=None, areas=None, gentype=None, genfuel=None, bus_name=None, branch_name=None, order=None, A=None, l=None, u=None, N=None, fparm=None, H=None, Cw=None, z0=None, zl=None, zu=None, comments=None, userfcn=None, f=0.0, x=None, mu=None, raw=None, om=None, var=None, lin=None, nle=None, nli=None, qdc=None, nlc=None, cost=None, extensions=None)[source]#

Bases: CaseResult

Solved AC or DC optimal-power-flow result.

Parameters:

  • version (str)

  • baseMVA (float)

  • bus (FloatArray)

  • gen (FloatArray)

  • branch (FloatArray)

  • success (bool)

  • iterations (int)

  • et (float)

  • gencost (FloatArray | None)

  • dcline (FloatArray | None)

  • dclinecost (FloatArray | None)

  • areas (FloatArray | None)

  • gentype (list[str] | None)

  • genfuel (list[str] | None)

  • bus_name (list[str] | None)

  • branch_name (list[str] | None)

  • order (ResultOrder | None)

  • A (Matrix | None)

  • l (FloatArray | None)

  • u (FloatArray | None)

  • N (Matrix | None)

  • fparm (FloatArray | None)

  • H (Matrix | None)

  • Cw (FloatArray | None)

  • z0 (FloatArray | None)

  • zl (FloatArray | None)

  • zu (FloatArray | None)

  • comments (list[str] | None)

  • userfcn (list[object] | None)

  • f (float | FloatArray)

  • x (FloatArray | ComplexArray | None)

  • mu (OpfMultipliers | None)

  • raw (Mapping[str, object] | None)

  • om (object | None)

  • var (OpfVariableResults | None)

  • lin (OpfLinearConstraintResults | None)

  • nle (OpfNonlinearEqualityResults | None)

  • nli (OpfNonlinearInequalityResults | None)

  • qdc (Mapping[str, float | FloatArray | ComplexArray] | None)

  • nlc (Mapping[str, float | FloatArray | ComplexArray] | None)

  • cost (Mapping[str, float | FloatArray | ComplexArray] | None)

  • extensions (dict[str, PowerModelExtensionResult] | None)

class pwrs.corex.results.PowerFlowExpandedResult(baseMVA, bus, gen, branch, success, et)[source]#

Bases: NamedTuple

Parameters:

  • baseMVA (float)

  • bus (FloatArray)

  • gen (FloatArray)

  • branch (FloatArray)

  • success (bool)

  • et (float)

baseMVA: float#

Alias for field number 0

bus: FloatArray#

Alias for field number 1

gen: FloatArray#

Alias for field number 2

branch: FloatArray#

Alias for field number 3

success: bool#

Alias for field number 4

et: float#

Alias for field number 5

class pwrs.corex.results.PowerFlowResult(version='2', baseMVA=100.0, bus=<factory>, gen=<factory>, branch=<factory>, success=False, iterations=0, et=0.0, gencost=None, dcline=None, dclinecost=None, areas=None, gentype=None, genfuel=None, bus_name=None, branch_name=None, order=None, A=None, l=None, u=None, N=None, fparm=None, H=None, Cw=None, z0=None, zl=None, zu=None, comments=None, userfcn=None)[source]#

Bases: CaseResult

Solved AC or DC power-flow result.

Parameters:

  • version (str)

  • baseMVA (float)

  • bus (FloatArray)

  • gen (FloatArray)

  • branch (FloatArray)

  • success (bool)

  • iterations (int)

  • et (float)

  • gencost (FloatArray | None)

  • dcline (FloatArray | None)

  • dclinecost (FloatArray | None)

  • areas (FloatArray | None)

  • gentype (list[str] | None)

  • genfuel (list[str] | None)

  • bus_name (list[str] | None)

  • branch_name (list[str] | None)

  • order (ResultOrder | None)

  • A (Matrix | None)

  • l (FloatArray | None)

  • u (FloatArray | None)

  • N (Matrix | None)

  • fparm (FloatArray | None)

  • H (Matrix | None)

  • Cw (FloatArray | None)

  • z0 (FloatArray | None)

  • zl (FloatArray | None)

  • zu (FloatArray | None)

  • comments (list[str] | None)

  • userfcn (list[object] | None)

class pwrs.corex.results.PowerModelConstraintResult(dual=<factory>, native_dual=<factory>, senses=(), violation=<factory>, max_violation=0.0)[source]#

Bases: StructuredMapping

Dual and feasibility data for one named extension constraint group.

Parameters:

  • dual (FloatArray)

  • native_dual (FloatArray)

  • senses (tuple[str, ...])

  • violation (FloatArray)

  • max_violation (float)

class pwrs.corex.results.PowerModelExtensionResult(build_time=0.0, constraints=<factory>, variables=<factory>, objective_terms=<factory>)[source]#

Bases: StructuredMapping

Structured values contributed by one PowerModels extension callback.

Parameters:

  • build_time (float)

  • constraints (dict[str, PowerModelConstraintResult])

  • variables (dict[str, FloatArray | ComplexArray])

  • objective_terms (dict[str, float])

class pwrs.corex.results.ResultOrder(state: 'str' = 'e', ext: 'ResultOrderCase | None' = None, int: 'ResultOrderCase | None' = None, bus: 'ResultOrderEntity' = <factory>, gen: 'ResultOrderEntity' = <factory>, branch: 'ResultOrderBranch' = <factory>)[source]#

Bases: StructuredMapping

Parameters:
class pwrs.corex.results.ResultOrderBranch(status: 'ResultOrderStatus' = <factory>)[source]#

Bases: StructuredMapping

Parameters:

status (ResultOrderStatus)

class pwrs.corex.results.ResultOrderCase(bus: 'FloatArray | None' = None, branch: 'FloatArray | None' = None, gen: 'FloatArray | None' = None, gencost: 'FloatArray | None' = None, A: 'Matrix | None' = None, N: 'Matrix | None' = None)[source]#

Bases: StructuredMapping

Parameters:

  • bus (FloatArray | None)

  • branch (FloatArray | None)

  • gen (FloatArray | None)

  • gencost (FloatArray | None)

  • A (Matrix | None)

  • N (Matrix | None)

class pwrs.corex.results.ResultOrderEntity(e2i: 'IntArray | dict[int, int]'=<factory>, i2e: 'IntArray' = <factory>, status: 'ResultOrderStatus' = <factory>)[source]#

Bases: StructuredMapping

Parameters:
class pwrs.corex.results.ResultOrderStatus(on: 'IntArray' = <factory>, off: 'IntArray' = <factory>)[source]#

Bases: StructuredMapping

Parameters:

  • on (IntArray)

  • off (IntArray)

class pwrs.corex.results.StructuredMapping[source]#

Bases: MutableMapping[str, object]

Dataclass with a mapping compatibility layer and extension fields.

to_dict()[source]#

Return a MATPOWER-compatible mapping, including extension fields.

Return type:

dict[str, object]