Skip to content

Rung 20: phase shifter — a transformer whose per-snapshot phase shift is optimised, holding it at its rating and rerouting the surplus around the cycle

One rung of the PyPSA corpus: the file pypsa.yaml projected onto what this network builds, attached to that network, and held to what PyPSA solves it to.

✔ Verified against pypsa master at 3625c816 — objective 16455.0 on both sides; structure ✔ 10 constraints · 5 variables, name for name; size ✔ 88 rows · ✔ 36 columns · ✔ 128 nonzeros; duals ✔ 88 rows; model for model: 15 blocks equal, 0 documented splits, 1 recorded deviations.

Rows and columns, PyPSA against specsolve, name for name
row PyPSA specsolve
Bus-nodal_balance 20 20
Generator-fix-p-lower 16 16
Generator-fix-p-upper 16 16
Kirchhoff-Voltage-Law 4 4
Line-fix-s-lower 8 8
Line-fix-s-upper 8 8
Link-fix-p-lower 4 4
Link-fix-p-upper 4 4
Transformer-fix-s-lower 4 4
Transformer-fix-s-upper 4 4
column PyPSA specsolve
Generator-p 16 16
Line-s 8 8
Link-p 4 4
Transformer-phase_shift 4 4
Transformer-s 4 4

The model

The same model, as math

The file states a plain n.optimize(), its multi-period class under the multi_investment_periods keyword, and its stochastic class, which n.set_scenarios(...) sets. Every quantity chosen once the future is known (second-stage) spans the futures dispatch is chosen in (scenario). Capacity is chosen once, before the future is known, and paid at its expected cost in each investment period its build year and lifetime span. Operation is the expectation over the scenarios' weights, with a share priced at the worst-outcome mean cost (CVaR) only where a risk preference is set. A plain run's data has one scenario, one period, unit weights, no outage and every active flag true, so the problem is the standard one. On a security-constrained run, PyPSA copies each branch flow limit once per outage, and the outage factors, active flags and scenario weights come from data prep.

Sets

Symbol Meaning
\(\mathcal{B}\) index \(b\) — breakpoint — the corners of a piecewise-linear curve, in order. A curve runs over the breakpoints its data has rows for, so curves may differ in length
\(\mathcal{N}\) index \(n\) — bus with \(\mathrm{Generator\_bus}: \mathcal{G} \to \mathcal{N},\ \mathrm{Line\_bus0}: \mathcal{K} \to \mathcal{N},\ \mathrm{Line\_bus1}: \mathcal{K} \to \mathcal{N},\ \mathrm{Link\_bus0}: \mathcal{L} \to \mathcal{N},\ \mathrm{Link\_output\_bus}: \mathcal{O} \to \mathcal{N},\ \mathrm{Load\_bus}: \mathcal{D} \to \mathcal{N},\ \mathrm{Process\_output\_bus}: \mathcal{R} \to \mathcal{N},\ \mathrm{Transformer\_bus0}: \mathcal{M} \to \mathcal{N},\ \mathrm{Transformer\_bus1}: \mathcal{M} \to \mathcal{N}\) — network nodes
\(\mathcal{C}\) index \(c\) — cycle — independent cycles of the passive network graph, the cycle basis, data prep. Each period has its own basis, of the branches that are active in it. A label is a position in that period's basis, so one label is a different cycle in another period
\(\mathcal{G}\) index \(g\) — generator with \(\mathrm{Generator\_bus}: \mathcal{G} \to \mathcal{N}\) — generating units, each on one bus
\(\mathcal{K}\) index \(k\) — line with \(\mathrm{Line\_bus0}: \mathcal{K} \to \mathcal{N},\ \mathrm{Line\_bus1}: \mathcal{K} \to \mathcal{N}\) — passive branches, each between two buses, their flow set by impedance
\(\mathcal{L}\) index \(l\) — link with \(\mathrm{Link\_bus0}: \mathcal{L} \to \mathcal{N},\ \mathrm{Link\_output\_link}: \mathcal{O} \to \mathcal{L}\) — controllable connections, each from one bus to the buses it delivers to
\(\mathcal{O}\) index \(o\) — link_output with \(\mathrm{Link\_output\_bus}: \mathcal{O} \to \mathcal{N},\ \mathrm{Link\_output\_link}: \mathcal{O} \to \mathcal{L}\) — a link's output ports, one label per port a link declares. The labels are PyPSA's bus1, bus2, … columns read long, data prep. A link of any number of output ports is then one term in the balance
\(\mathcal{D}\) index \(d\) — load with \(\mathrm{Load\_bus}: \mathcal{D} \to \mathcal{N}\) — demands, each on one bus
\(\mathcal{Y}\) index \(y\) — period with \(\mathrm{snapshot\_period}: \mathcal{T} \to \mathcal{Y}\) — investment periods. It is PyPSA's investment_periods
\(\mathcal{J}\) index \(j\) — process with \(\mathrm{Process\_output\_process}: \mathcal{R} \to \mathcal{J}\) — generalised multi-port converters, each with an internal power that every port draws or delivers at its own rate
\(\mathcal{R}\) index \(r\) — process_output with \(\mathrm{Process\_output\_bus}: \mathcal{R} \to \mathcal{N},\ \mathrm{Process\_output\_process}: \mathcal{R} \to \mathcal{J}\) — a process's ports, one label per port a process declares. The labels are PyPSA's bus0, bus1, …, each with a signed rate, data prep. A process of any number of ports is then one term in the balance
\(\Xi\) index \(\xi\) — scenario — the futures dispatch is chosen in, each with a weight
\(\mathcal{T}\) index \(t\) — snapshot with \(\mathrm{snapshot\_period}: \mathcal{T} \to \mathcal{Y}\) — dispatch periods
\(\mathcal{M}\) index \(m\) — transformer with \(\mathrm{Transformer\_bus0}: \mathcal{M} \to \mathcal{N},\ \mathrm{Transformer\_bus1}: \mathcal{M} \to \mathcal{N}\) — passive branches between two buses, their flow set by impedance and tap ratio, with a phase shift fixed or optimised

Parameters

Symbol Meaning
\(\mathrm{Bus\_attached}\) Bus_attached over \(\mathcal{N} \times \mathcal{T}\) — whether a load, a unit, a port or a branch that is active in the snapshot's period is attached to the bus, data prep. A bus nothing is attached to has no balance row
\(\mathrm{Cycle\_in\_basis}\) Cycle_in_basis over \(\mathcal{C} \times \mathcal{Y}\) — whether a period's cycle basis reaches the cycle label, data prep. A label beyond the basis of the period has no Kirchhoff voltage law row
\(\mathrm{on}\) Generator_active over \(\mathcal{G} \times \mathcal{T}\) — whether a generator is active in a snapshot's period. It is PyPSA's active, from build year and lifetime, data prep
\(\mathrm{act}\) Generator_active_asset over \(\mathcal{G}\) — whether a generator is one of PyPSA's active_assets, by its active flag alone, without build year and lifetime. A unit that is active in no snapshot of the horizon still counts. PyPSA refuses one that differs by scenario (constants.py:54)
\(\mathrm{com}\) Generator_committable over \(\mathcal{G}\) — whether output is gated by an on/off status decision
\(\mathrm{c}\) Generator_marginal_cost over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — cost of one unit of output
\(\mathrm{p}^{\mathrm{curve}}\) Generator_marginal_cost_curve_p over \(\mathcal{B} \times \mathcal{G}\), absent where the data has no row — the output at each breakpoint of a generator's piecewise marginal_cost curve: PyPSA's p_pu breakpoints times p_nom, data prep. A generator with no curve has no rows
\(\mathrm{c}^{(2)}\) Generator_marginal_cost_quadratic over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — cost of the square of one unit of output
\(\overline{\mathrm{p}}\) Generator_p_max_pu over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — most output, per unit of nominal power: an availability profile
\(\underline{\mathrm{p}}\) Generator_p_min_pu over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — least output, per unit of nominal power
\(\mathrm{p}^{\mathrm{nom}}\) Generator_p_nom over \(\mathcal{G} \times \Xi\) — nominal power
\(\mathrm{ext}\) Generator_p_nom_extendable over \(\mathcal{G}\) — whether the nominal power is a decision
\(\mathrm{sgn}\) Generator_sign over \(\mathcal{G}\) — the sign output enters its bus's balance with. It is PyPSA's sign, 1 unless given, -1 for a unit that draws power. PyPSA refuses one that differs by scenario (constants.py:46)
\(\mathrm{on}^{s}\) Line_active over \(\mathcal{K} \times \mathcal{T}\) — whether a line is active in a snapshot's period. It is PyPSA's active, data prep
\(\mathrm{x}\) Line_cycle_weight over \(\mathcal{C} \times \mathcal{K} \times \mathcal{Y}\), absent where the data has no row — the line's series impedance, signed by its orientation in the cycle: the cycle basis, data prep. A line in no cycle has no row. PyPSA builds the cycle basis from the first scenario (networks.py:1430-1437), and refuses a v_nom, x_pu_eff or r_pu_eff that differs by scenario (constants.py:33-35). So the weight is the same in every scenario
\(\overline{\mathrm{s}}\) Line_s_max_pu over \(\mathcal{K} \times \Xi \times \mathcal{T}\) — most flow either way, per unit of nominal apparent power
\(\mathrm{s}^{\mathrm{nom}}\) Line_s_nom over \(\mathcal{K} \times \Xi\) — nominal apparent power
\(\mathrm{ext}^{s}\) Line_s_nom_extendable over \(\mathcal{K}\) — whether the nominal apparent power is a decision
\(\mathrm{on}^{f}\) Link_active over \(\mathcal{L} \times \mathcal{T}\) — whether a link is active in a snapshot's period. It is PyPSA's active, data prep
\(\mathrm{com}^{f}\) Link_committable over \(\mathcal{L}\) — whether flow is gated by an on/off status decision
\(\eta\) Link_efficiency over \(\mathcal{O} \times \Xi \times \mathcal{T}\) — share of the flow that arrives at an output port, PyPSA's efficiency, efficiency2, … read long: negative where that port consumes rather than delivers. Read at the snapshot the flow arrives, so a delayed port delivers at its arrival snapshot's efficiency (constraints.py:1575)
\(\mathrm{c}^{f}\) Link_marginal_cost over \(\mathcal{L} \times \Xi \times \mathcal{T}\) — cost of one unit of flow
\(\mathrm{c}^{f,(2)}\) Link_marginal_cost_quadratic over \(\mathcal{L} \times \Xi \times \mathcal{T}\) — cost of the square of one unit of flow
\(\mathrm{cyc}^{f}\) Link_output_cyclic_delay over \(\mathcal{O}\) — whether a delayed port's flow wraps from the end of its investment period (PyPSA's cyclic_delay, cyclic_delay2, …). Where it does not, the flow still in transit at each period's first snapshots is lost. The flag is the same in every scenario, as the delay is
\(\mathrm{d}^{f}\) Link_output_delay over \(\mathcal{O}\) — snapshots a port's delivery lags its link's flow (PyPSA's delay, delay2, … read long). In data prep you divide it by the snapshot_weightings.generators value and round it up. It is zero for a port that delivers at once. A port has the same delay in every scenario, because PyPSA refuses a delay that differs by scenario (constants.py:55)
\(\overline{\mathrm{f}}\) Link_p_max_pu over \(\mathcal{L} \times \Xi \times \mathcal{T}\) — most flow, per unit of nominal power
\(\underline{\mathrm{f}}\) Link_p_min_pu over \(\mathcal{L} \times \Xi \times \mathcal{T}\) — least flow, per unit of nominal power: negative for a link that carries both ways
\(\mathrm{f}^{\mathrm{nom}}\) Link_p_nom over \(\mathcal{L} \times \Xi\) — nominal power
\(\mathrm{ext}^{f}\) Link_p_nom_extendable over \(\mathcal{L}\) — whether the nominal power is a decision
\(\mathrm{on}^{\mathrm{load}}\) Load_active over \(\mathcal{D}\) — whether a load is active in the network, PyPSA's active. A load has no build year and no lifetime, so the flag is the same in every snapshot. PyPSA refuses one that differs by scenario (constants.py:54)
\(\mathrm{load}\) Load_p_set over \(\mathcal{D} \times \Xi \times \mathcal{T}\) — demand
\(\mathrm{sgn}^{\mathrm{load}}\) Load_sign over \(\mathcal{D}\) — the sign a load's demand enters its bus's balance with. It is PyPSA's sign, -1 unless given, 1 for a load that feeds its bus. PyPSA refuses one that differs by scenario (constants.py:46)
\(\mathrm{on}^{z}\) Process_active over \(\mathcal{J} \times \mathcal{T}\) — whether a process is active in a snapshot's period. It is PyPSA's active, data prep
\(\mathrm{cyc}^{z}\) Process_output_cyclic_delay over \(\mathcal{R}\) — whether a delayed port's transfer wraps from the end of its investment period (PyPSA's cyclic_delay0, cyclic_delay1, …). Where it does not, the energy still in transit at each period's first snapshots is lost. The flag is the same in every scenario, as the delay is
\(\mathrm{d}^{z}\) Process_output_delay over \(\mathcal{R}\) — snapshots a port's transfer lags its process's internal power (PyPSA's delay0, delay1, … read long). In data prep you divide it by the snapshot_weightings.generators value and round it up. It is zero for a port that transfers at once. A port has the same delay in every scenario, as a link's port has
\(\alpha\) Process_rate over \(\mathcal{R} \times \Xi \times \mathcal{T}\) — the energy a port draws or delivers per unit of internal power (PyPSA's rate0, rate1, … read long). It is negative where the port withdraws and positive where it injects. A link is a process whose bus0 rate is minus one and whose output rates are its efficiencies. The rate at the snapshot the transfer arrives applies, so a delayed port transfers at its arrival snapshot's rate (constraints.py:1575)
\(\mathrm{on}^{\sigma}\) Transformer_active over \(\mathcal{T} \times \mathcal{M}\) — whether a transformer is active in a snapshot's period. It is PyPSA's active, data prep
\(\mathrm{x}^{\sigma}\) Transformer_cycle_weight over \(\mathcal{C} \times \mathcal{Y} \times \mathcal{M}\), absent where the data has no row — the transformer's effective series reactance, x times its tap ratio, signed by its orientation in the cycle. It is PyPSA's x_pu_eff, the cycle basis, data prep. A transformer in no cycle has no row. It is the same in every scenario, as a line's
\(\mathrm{Transformer\_phase\_shift\_cycle\_weight}\) Transformer_phase_shift_cycle_weight over \(\mathcal{C} \times \mathcal{Y} \times \Xi \times \mathcal{M}\) — the cycle sign for a varying transformer's phase shift, times π/180 so a shift in degrees enters the cycle sum in radians, data prep. It is zero for a fixed transformer or one in no cycle
\(\mathrm{Transformer\_phase\_shift\_max}\) Transformer_phase_shift_max over \(\Xi \times \mathcal{M}\) — the most a varying transformer's phase shift may take, in degrees. It is PyPSA's phase_shift_max. Equal to phase_shift_min for a fixed transformer
\(\mathrm{Transformer\_phase\_shift\_min}\) Transformer_phase_shift_min over \(\Xi \times \mathcal{M}\) — the least a varying transformer's phase shift may take, in degrees. It is PyPSA's phase_shift_min. Where it is below phase_shift_max the shift is a decision, otherwise the transformer keeps its fixed phase_shift
\(\mathrm{Transformer\_phase\_shift\_varying}\) Transformer_phase_shift_varying over \(\Xi \times \mathcal{M}\) — whether a transformer's phase shift is a decision (PyPSA's phase_shift_min < phase_shift_max, read as a flag in data prep). False is a fixed shift, set by phase_shift. It may differ by scenario, as PyPSA reads it per scenario (variables.py:446-456)
\(\overline{\sigma}\) Transformer_s_max_pu over \(\Xi \times \mathcal{T} \times \mathcal{M}\) — most flow either way, per unit of nominal apparent power
\(\sigma^{\mathrm{nom}}\) Transformer_s_nom over \(\Xi \times \mathcal{M}\) — nominal apparent power
\(\mathrm{ext}^{\sigma}\) Transformer_s_nom_extendable over \(\mathcal{M}\) — whether the nominal apparent power is a decision
\(\mathrm{w}^{y}\) period_weight_objective over \(\mathcal{Y}\) — PyPSA's investment_period_weightings.objective — what a period's cost weighs. PyPSA reads it only under multi_investment_periods. Otherwise you feed one in data prep, whatever the column contains (optimize.py:231-233, :293-297)
\(\pi\) scenario_weight over \(\Xi\) — PyPSA's scenario_weightings.weight — the probability of a future
\(\mathrm{w}\) snapshot_weightings_objective over \(\mathcal{T}\) — PyPSA's snapshot_weightings.objective — hours a snapshot weighs in the cost

Conditions

Symbol Meaning
\(\mathrm{Generator\_marginal\_cost\_curve}\) Generator_marginal_cost_curve over \(\mathcal{G}\) — a generator that pays along a piecewise marginal_cost curve: one of PyPSA's active_assets with curve data (optimize.py:307, piecewise.py:230-257)

Variables

Symbol Meaning
\(C^{\mathrm{curve}}\) Generator_marginal_cost_piecewise over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — Generator-marginal_cost_piecewise — the running cost of a generator that pays along a curve, held above the curve
\(p\) Generator_p over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — Generator-p — output of a generator in a snapshot
\(s\) Line_s over \(\mathcal{K} \times \Xi \times \mathcal{T}\) — Line-s — PyPSA's p0, the flow measured at the Line_bus0 end: a positive value withdraws there and injects at Line_bus1, lossless
\(f\) Link_p over \(\mathcal{L} \times \Xi \times \mathcal{T}\) — Link-p — PyPSA's p0, the flow measured at the Link_bus0 end. A positive value withdraws there and injects at every bus the link's output ports deliver to
\(z\) Process_p over \(\mathcal{J} \times \Xi \times \mathcal{T}\) — Process-p — PyPSA's internal power p. A positive value drives every port at its own rate, withdrawing where the rate is negative and injecting where it is positive
\(\mathit{Transformer\_phase\_shift}\) Transformer_phase_shift over \(\Xi \times \mathcal{T} \times \mathcal{M}\), \(0\) where the mask leaves it out — Transformer-phase_shift — a phase-shifting transformer's voltage angle shift in degrees, chosen per snapshot to redistribute the flows around its cycles without moving active power. Absent, and zero in the cycle sum, where the shift is fixed
\(\sigma\) Transformer_s over \(\Xi \times \mathcal{T} \times \mathcal{M}\) — Transformer-s — PyPSA's p0, the flow measured at the Transformer_bus0 end: a positive value withdraws there and injects at Transformer_bus1, lossless

Definitions

Symbol Meaning
\(\mathit{Bus\_injection}\) Bus_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\) — what every component puts into a bus, less what it takes out of it. PyPSA writes each term into the balance, and a load on its right-hand side
\(\mathit{Cycle\_angle\_sum}\) Cycle_angle_sum over \(\mathcal{C} \times \Xi \times \mathcal{T}\) — the voltage angle differences around a cycle: every branch flow times its cycle weight, and every transformer phase shift
\(\mathit{Generator\_injection}\) Generator_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\)
\(\mathit{Generator\_opex}\) Generator_opex over \(\Xi\)
\(\mathit{Generator\_running\_cost}\) Generator_running_cost over \(\mathcal{G} \times \Xi \times \mathcal{T}\) — what a generator's output costs in a snapshot: the value read off its piecewise curve where it has one, and its linear marginal_cost otherwise. A curve replaces the linear cost, as PyPSA drops the unit from that term (optimize.py:333-348)
\(\mathit{Line\_angle\_sum}\) Line_angle_sum over \(\mathcal{C} \times \Xi \times \mathcal{T}\)
\(\mathit{Line\_injection}\) Line_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\)
\(\mathit{Link\_injection}\) Link_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\)
\(\mathit{Link\_opex}\) Link_opex over \(\Xi\)
\(\mathit{Link\_output\_arrival}\) Link_output_arrival over \(\mathcal{O} \times \Xi \times \mathcal{T}\) — what a link delivers to an output port at a snapshot. It is its flow delayed by the port's delay within its investment period. It is multiplied by the port's efficiency at the snapshot the flow arrives. Where the port is cyclic_delay, the delayed flow wraps from the period's end. Where it is not, the flow still in transit at the period's first snapshots is lost. A port that does not delay (delay zero) delivers its flow unshifted, cyclic or not
\(\mathrm{Load\_demand}\) Load_demand over \(\mathcal{D} \times \Xi \times \mathcal{T}\) — what a load draws from its bus's balance. It is its demand times its sign where it is active, and nothing where it is not. PyPSA drops an inactive load from the balance (constraints.py:1591-1592)
\(\mathrm{Load\_injection}\) Load_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\)
\(\mathit{Process\_injection}\) Process_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\)
\(\mathit{Process\_output\_arrival}\) Process_output_arrival over \(\mathcal{R} \times \Xi \times \mathcal{T}\) — what a process transfers at a port at a snapshot. It is its internal power delayed by the port's delay within its investment period. It is multiplied by the port's rate at the snapshot the transfer arrives. Where the port is cyclic_delay, the delayed transfer wraps from the period's end. Where it is not, the energy still in transit at the period's first snapshots is lost. A port that does not delay (delay zero) transfers at once, cyclic or not
\(\mathit{Transformer\_angle\_sum}\) Transformer_angle_sum over \(\mathcal{C} \times \Xi \times \mathcal{T}\)
\(\mathit{Transformer\_injection}\) Transformer_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\)
\(\mathit{risk\_weighted\_opex}\) risk_weighted_opex (scalar)
\(\mathit{scenario\_opex}\) scenario_opex over \(\Xi\) — what a future costs to run: every operating term, weighted by the snapshot's hours and its period, before the scenario's own weight. A start and a stop cost what they cost, unweighted, as PyPSA adds them (optimize.py:448-468)
\(\mathit{total\_cost}\) total_cost (scalar) — what the system costs. Capacity counts once per active period at its expected cost over the scenarios. Operation counts in expectation over the scenarios, and a share of it at the tail

Notation

Symbol Meaning
\(t \ominus k\) edge='wrap' — \(t-k\), cyclic
\(t \boxminus_{v} k\) edge=v — \(t-k\), and \(v\) past the edge
\(t \ominus^{\mathrm{relation}(t)} k\) within=relation[...] — \(t-k\) inside the group of \(t\)

Conditions

Generator_marginal_cost_curve

\[ \mathrm{Generator\_marginal\_cost\_curve}_{g} \iff \lvert \{ b \in \mathcal{B} \,:\, \mathrm{p}^{\mathrm{curve}}_{b,g} \text{ is defined} \} \rvert > 0 \wedge \mathrm{act}_{g} \qquad \forall\, g \in \mathcal{G} \]

Variable domains

Generator_marginal_cost_piecewise

\[ C^{\mathrm{curve}}_{g,\xi,t} \in \mathbb{R} \qquad \forall\, g \in \mathcal{G},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{Generator\_marginal\_cost\_curve}_{g} \wedge \mathrm{on}_{g,t} \]

Generator_p

\[ p_{g,\xi,t} \in \mathbb{R} \qquad \forall\, g \in \mathcal{G},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{on}_{g,t} \]

Line_s

\[ s_{k,\xi,t} \in \mathbb{R} \qquad \forall\, k \in \mathcal{K},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{on}^{s}_{k,t} \]

Link_p

\[ f_{l,\xi,t} \in \mathbb{R} \qquad \forall\, l \in \mathcal{L},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{on}^{f}_{l,t} \]

Process_p

\[ z_{j,\xi,t} \in \mathbb{R} \qquad \forall\, j \in \mathcal{J},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{on}^{z}_{j,t} \]

Transformer_phase_shift

\[ \mathrm{Transformer\_phase\_shift\_min}_{\xi,m} \le \mathit{Transformer\_phase\_shift}_{\xi,t,m} \le \mathrm{Transformer\_phase\_shift\_max}_{\xi,m} \qquad \forall\, \xi \in \Xi,\ t \in \mathcal{T},\ m \in \mathcal{M} \,:\, \mathrm{Transformer\_phase\_shift\_varying}_{\xi,m} \wedge \mathrm{on}^{\sigma}_{t,m} \]

Transformer_s

\[ \sigma_{\xi,t,m} \in \mathbb{R} \qquad \forall\, \xi \in \Xi,\ t \in \mathcal{T},\ m \in \mathcal{M} \,:\, \mathrm{on}^{\sigma}_{t,m} \]

Definitions

Bus_injection

\[ \mathit{Bus\_injection}_{n,\xi,t} = \mathit{Generator\_injection}_{n,\xi,t} + \mathit{Line\_injection}_{n,\xi,t} + \mathit{Link\_injection}_{n,\xi,t} + \mathrm{Load\_injection}_{n,\xi,t} + \mathit{Process\_injection}_{n,\xi,t} + \mathit{Transformer\_injection}_{n,\xi,t} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Cycle_angle_sum

\[ \mathit{Cycle\_angle\_sum}_{c,\xi,t} = \mathit{Line\_angle\_sum}_{c,\xi,t} + \mathit{Transformer\_angle\_sum}_{c,\xi,t} \qquad \forall\, c \in \mathcal{C},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Generator_injection

\[ \mathit{Generator\_injection}_{n,\xi,t} = \sum_{g \in \mathcal{G} \,:\, \mathrm{Generator\_bus}(g) = n} \mathrm{sgn}_{g} \cdot p_{g,\xi,t} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Generator_opex

\[ \mathit{Generator\_opex}_{\xi} = \sum_{t \in \mathcal{T}} \sum_{g \in \mathcal{G}} \mathit{Generator\_running\_cost}_{g,\xi,t} \cdot \mathrm{w}_{t} \cdot \mathrm{w}^{y}_{\mathrm{snapshot\_period}(t)} + \sum_{t \in \mathcal{T}} \sum_{g \in \mathcal{G}} p_{g,\xi,t} \cdot p_{g,\xi,t} \cdot \mathrm{c}^{(2)}_{g,\xi,t} \cdot \mathrm{w}_{t} \cdot \mathrm{w}^{y}_{\mathrm{snapshot\_period}(t)} \qquad \forall\, \xi \in \Xi \]

Generator_running_cost

\[ \mathit{Generator\_running\_cost}_{g,\xi,t} = \begin{cases} C^{\mathrm{curve}}_{g,\xi,t} & \text{if } \mathrm{Generator\_marginal\_cost\_curve}_{g} \\ p_{g,\xi,t} \cdot \mathrm{c}_{g,\xi,t} & \text{otherwise} \end{cases} \qquad \forall\, g \in \mathcal{G},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Line_angle_sum

\[ \mathit{Line\_angle\_sum}_{c,\xi,t} = \sum_{k \in \mathcal{K}} s_{k,\xi,t} \cdot \mathrm{x}_{c,k,\mathrm{snapshot\_period}(t)} \qquad \forall\, c \in \mathcal{C},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Line_injection

\[ \mathit{Line\_injection}_{n,\xi,t} = -\left( \sum_{k \in \mathcal{K} \,:\, \mathrm{Line\_bus0}(k) = n} s_{k,\xi,t} \right) + \sum_{k \in \mathcal{K} \,:\, \mathrm{Line\_bus1}(k) = n} s_{k,\xi,t} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Link_injection

\[ \mathit{Link\_injection}_{n,\xi,t} = -\left( \sum_{l \in \mathcal{L} \,:\, \mathrm{Link\_bus0}(l) = n} f_{l,\xi,t} \right) + \sum_{o \in \mathcal{O} \,:\, \mathrm{Link\_output\_bus}(o) = n} \mathit{Link\_output\_arrival}_{o,\xi,t} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Link_opex

\[ \mathit{Link\_opex}_{\xi} = \sum_{t \in \mathcal{T}} \sum_{l \in \mathcal{L}} f_{l,\xi,t} \cdot \mathrm{c}^{f}_{l,\xi,t} \cdot \mathrm{w}_{t} \cdot \mathrm{w}^{y}_{\mathrm{snapshot\_period}(t)} + \sum_{t \in \mathcal{T}} \sum_{l \in \mathcal{L}} f_{l,\xi,t} \cdot f_{l,\xi,t} \cdot \mathrm{c}^{f,(2)}_{l,\xi,t} \cdot \mathrm{w}_{t} \cdot \mathrm{w}^{y}_{\mathrm{snapshot\_period}(t)} \qquad \forall\, \xi \in \Xi \]

Link_output_arrival

\[ \mathit{Link\_output\_arrival}_{o,\xi,t} = \begin{cases} f_{\mathrm{Link\_output\_link}(o),\xi,t \ominus^{\mathrm{snapshot\_period}(t)} \mathrm{d}^{f}} \cdot \eta_{o,\xi,t} & \text{if } \mathrm{cyc}^{f}_{o} \\ f_{\mathrm{Link\_output\_link}(o),\xi,t \boxminus_{0}^{\mathrm{snapshot\_period}(t)} \mathrm{d}^{f}} \cdot \eta_{o,\xi,t} & \text{otherwise} \end{cases} \qquad \forall\, o \in \mathcal{O},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Load_demand

\[ \mathrm{Load\_demand}_{d,\xi,t} = \begin{cases} \mathrm{sgn}^{\mathrm{load}}_{d} \cdot \mathrm{load}_{d,\xi,t} & \text{if } \mathrm{on}^{\mathrm{load}}_{d} \\ 0 & \text{otherwise} \end{cases} \qquad \forall\, d \in \mathcal{D},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Load_injection

\[ \mathrm{Load\_injection}_{n,\xi,t} = \sum_{d \in \mathcal{D} \,:\, \mathrm{Load\_bus}(d) = n} \mathrm{Load\_demand}_{d,\xi,t} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Process_injection

\[ \mathit{Process\_injection}_{n,\xi,t} = \sum_{r \in \mathcal{R} \,:\, \mathrm{Process\_output\_bus}(r) = n} \mathit{Process\_output\_arrival}_{r,\xi,t} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Process_output_arrival

\[ \mathit{Process\_output\_arrival}_{r,\xi,t} = \begin{cases} z_{\mathrm{Process\_output\_process}(r),\xi,t \ominus^{\mathrm{snapshot\_period}(t)} \mathrm{d}^{z}} \cdot \alpha_{r,\xi,t} & \text{if } \mathrm{cyc}^{z}_{r} \\ z_{\mathrm{Process\_output\_process}(r),\xi,t \boxminus_{0}^{\mathrm{snapshot\_period}(t)} \mathrm{d}^{z}} \cdot \alpha_{r,\xi,t} & \text{otherwise} \end{cases} \qquad \forall\, r \in \mathcal{R},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Transformer_angle_sum

\[ \mathit{Transformer\_angle\_sum}_{c,\xi,t} = \sum_{m \in \mathcal{M}} \sigma_{\xi,t,m} \cdot \mathrm{x}^{\sigma}_{c,\mathrm{snapshot\_period}(t),m} + \sum_{m \in \mathcal{M}} \mathit{Transformer\_phase\_shift}_{\xi,t,m} \cdot \mathrm{Transformer\_phase\_shift\_cycle\_weight}_{c,\mathrm{snapshot\_period}(t),\xi,m} \qquad \forall\, c \in \mathcal{C},\ \xi \in \Xi,\ t \in \mathcal{T} \]

Transformer_injection

\[ \mathit{Transformer\_injection}_{n,\xi,t} = -\left( \sum_{m \in \mathcal{M} \,:\, \mathrm{Transformer\_bus0}(m) = n} \sigma_{\xi,t,m} \right) + \sum_{m \in \mathcal{M} \,:\, \mathrm{Transformer\_bus1}(m) = n} \sigma_{\xi,t,m} \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \]

risk_weighted_opex

\[ \mathit{risk\_weighted\_opex} = \sum_{\xi \in \Xi} \pi_{\xi} \cdot \mathit{scenario\_opex}_{\xi} \]

scenario_opex

\[ \mathit{scenario\_opex}_{\xi} = \mathit{Generator\_opex}_{\xi} + \mathit{Link\_opex}_{\xi} \qquad \forall\, \xi \in \Xi \]

total_cost

\[ \mathit{total\_cost} = \mathit{risk\_weighted\_opex} \]

Objective

\[ \min \mathit{total\_cost} \]

Subject to

Bus_nodal_balance

\[ \mathit{Bus\_injection}_{n,\xi,t} = 0 \qquad \forall\, n \in \mathcal{N},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{Bus\_attached}_{n,t} \]

Generator_fix_p_lower

\[ p_{g,\xi,t} \ge \underline{\mathrm{p}}_{g,\xi,t} \cdot \mathrm{p}^{\mathrm{nom}}_{g,\xi} \qquad \forall\, g \in \mathcal{G},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \neg \mathrm{ext}_{g} \wedge \neg \mathrm{com}_{g} \wedge \mathrm{on}_{g,t} \]

Generator_fix_p_upper

\[ p_{g,\xi,t} \le \overline{\mathrm{p}}_{g,\xi,t} \cdot \mathrm{p}^{\mathrm{nom}}_{g,\xi} \qquad \forall\, g \in \mathcal{G},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \neg \mathrm{ext}_{g} \wedge \neg \mathrm{com}_{g} \wedge \mathrm{on}_{g,t} \]

Kirchhoff_Voltage_Law

\[ \mathit{Cycle\_angle\_sum}_{c,\xi,t} = 0 \qquad \forall\, c \in \mathcal{C},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \mathrm{Cycle\_in\_basis}_{c,\mathrm{snapshot\_period}(t)} \]

Line_fix_s_lower

\[ s_{k,\xi,t} \ge -\overline{\mathrm{s}}_{k,\xi,t} \cdot \mathrm{s}^{\mathrm{nom}}_{k,\xi} \qquad \forall\, k \in \mathcal{K},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \neg \mathrm{ext}^{s}_{k} \wedge \mathrm{on}^{s}_{k,t} \]

Line_fix_s_upper

\[ s_{k,\xi,t} \le \overline{\mathrm{s}}_{k,\xi,t} \cdot \mathrm{s}^{\mathrm{nom}}_{k,\xi} \qquad \forall\, k \in \mathcal{K},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \neg \mathrm{ext}^{s}_{k} \wedge \mathrm{on}^{s}_{k,t} \]

Link_fix_p_lower

\[ f_{l,\xi,t} \ge \underline{\mathrm{f}}_{l,\xi,t} \cdot \mathrm{f}^{\mathrm{nom}}_{l,\xi} \qquad \forall\, l \in \mathcal{L},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \neg \mathrm{ext}^{f}_{l} \wedge \neg \mathrm{com}^{f}_{l} \wedge \mathrm{on}^{f}_{l,t} \]

Link_fix_p_upper

\[ f_{l,\xi,t} \le \overline{\mathrm{f}}_{l,\xi,t} \cdot \mathrm{f}^{\mathrm{nom}}_{l,\xi} \qquad \forall\, l \in \mathcal{L},\ \xi \in \Xi,\ t \in \mathcal{T} \,:\, \neg \mathrm{ext}^{f}_{l} \wedge \neg \mathrm{com}^{f}_{l} \wedge \mathrm{on}^{f}_{l,t} \]

Transformer_fix_s_lower

\[ \sigma_{\xi,t,m} \ge -\overline{\sigma}_{\xi,t,m} \cdot \sigma^{\mathrm{nom}}_{\xi,m} \qquad \forall\, \xi \in \Xi,\ t \in \mathcal{T},\ m \in \mathcal{M} \,:\, \neg \mathrm{ext}^{\sigma}_{m} \wedge \mathrm{on}^{\sigma}_{t,m} \]

Transformer_fix_s_upper

\[ \sigma_{\xi,t,m} \le \overline{\sigma}_{\xi,t,m} \cdot \sigma^{\mathrm{nom}}_{\xi,m} \qquad \forall\, \xi \in \Xi,\ t \in \mathcal{T},\ m \in \mathcal{M} \,:\, \neg \mathrm{ext}^{\sigma}_{m} \wedge \mathrm{on}^{\sigma}_{t,m} \]

The spec, differential/pypsa/rungs/rung_20_phase_shifter.yaml — the file projected onto what this rung builds:

version: 0
description: The file states a plain `n.optimize()`, its multi-period class under the `multi_investment_periods`
  keyword, and its stochastic class, which `n.set_scenarios(...)` sets. Every quantity chosen once the
  future is known (second-stage) spans the futures dispatch is chosen in (`scenario`). Capacity is chosen
  once, before the future is known, and paid at its expected cost in each investment `period` its build
  year and lifetime span. Operation is the expectation over the scenarios' weights, with a share priced
  at the worst-outcome mean cost (CVaR) only where a risk preference is set. A plain run's data has one
  scenario, one period, unit weights, no outage and every `active` flag true, so the problem is the standard
  one. On a security-constrained run, PyPSA copies each branch flow limit once per `outage`, and the outage
  factors, `active` flags and scenario weights come from data prep.
dimensions:
  breakpoint: {dtype: int, ordered: true, description: 'the corners of a piecewise-linear curve, in order.
      A curve runs over the breakpoints its data has rows for, so curves may differ in length'}
  bus: {description: network nodes}
  cycle: {description: 'independent cycles of the passive network graph, the cycle basis, data prep. Each
      period has its own basis, of the branches that are active in it. A label is a position in that period''s
      basis, so one label is a different cycle in another period'}
  generator: {description: 'generating units, each on one bus'}
  line: {description: 'passive branches, each between two buses, their flow set by impedance'}
  link: {description: 'controllable connections, each from one bus to the buses it delivers to'}
  link_output: {description: 'a link''s output ports, one label per port a link declares. The labels are
      PyPSA''s `bus1`, `bus2`, … columns read long, data prep. A link of any number of output ports is
      then one term in the balance'}
  load: {description: 'demands, each on one bus'}
  period: {dtype: int, ordered: true, description: investment periods. It is PyPSA's `investment_periods`}
  process: {description: 'generalised multi-port converters, each with an internal power that every port
      draws or delivers at its own rate'}
  process_output: {description: 'a process''s ports, one label per port a process declares. The labels
      are PyPSA''s `bus0`, `bus1`, …, each with a signed `rate`, data prep. A process of any number of
      ports is then one term in the balance'}
  scenario: {description: 'the futures dispatch is chosen in, each with a weight'}
  snapshot: {dtype: datetime, ordered: true, description: dispatch periods}
  transformer: {description: 'passive branches between two buses, their flow set by impedance and tap
      ratio, with a phase shift fixed or optimised'}
relations:
  Generator_bus: {key: generator, values: bus, description: the bus a generator sits on}
  Line_bus0: {key: line, values: bus, description: the bus a line's flow is measured at}
  Line_bus1: {key: line, values: bus, description: the bus at a line's other end}
  Link_bus0: {key: link, values: bus, description: the bus a link leaves}
  Link_output_bus: {key: link_output, values: bus, description: 'the bus an output port delivers to. It
      is PyPSA''s `bus1`, `bus2`, … columns. A link of three output ports is three labels here rather
      than a third relation, so the file states any number of them'}
  Link_output_link: {key: link_output, values: link, description: the link an output port belongs to}
  Load_bus: {key: load, values: bus, description: the bus a load sits on}
  Process_output_bus: {key: process_output, values: bus, description: 'the bus a port draws from or delivers
      to. It is PyPSA''s `bus0`, `bus1`, … columns. A process of three ports is three labels here rather
      than a third relation, so the file states any number of them'}
  Process_output_process: {key: process_output, values: process, description: the process a port belongs
      to}
  Transformer_bus0: {key: transformer, values: bus, description: the bus a transformer's flow is measured
      at}
  Transformer_bus1: {key: transformer, values: bus, description: the bus at a transformer's other end}
  snapshot_period: {key: snapshot, values: period, description: the investment period a snapshot falls
      in}
parameters:
  Bus_attached:
    dims: [bus, snapshot]
    dtype: bool
    description: whether a load, a unit, a port or a branch that is active in the snapshot's period is
      attached to the bus, data prep. A bus nothing is attached to has no balance row
  Cycle_in_basis:
    dims: [cycle, period]
    dtype: bool
    description: whether a period's cycle basis reaches the cycle label, data prep. A label beyond the
      basis of the period has no Kirchhoff voltage law row
  Generator_active:
    dims: [generator, snapshot]
    dtype: bool
    description: whether a generator is active in a snapshot's period. It is PyPSA's `active`, from build
      year and lifetime, data prep
  Generator_active_asset:
    dims: [generator]
    dtype: bool
    description: whether a generator is one of PyPSA's `active_assets`, by its `active` flag alone, without
      build year and lifetime. A unit that is active in no snapshot of the horizon still counts. PyPSA
      refuses one that differs by scenario (`constants.py:54`)
  Generator_committable:
    dims: [generator]
    dtype: bool
    description: whether output is gated by an on/off status decision
  Generator_marginal_cost:
    dims: [generator, scenario, snapshot]
    description: cost of one unit of output
  Generator_marginal_cost_curve_p:
    dims: [breakpoint, generator]
    missing: absent
    description: 'the output at each breakpoint of a generator''s piecewise `marginal_cost` curve: PyPSA''s
      `p_pu` breakpoints times `p_nom`, data prep. A generator with no curve has no rows'
  Generator_marginal_cost_quadratic:
    dims: [generator, scenario, snapshot]
    description: cost of the square of one unit of output
  Generator_p_max_pu:
    dims: [generator, scenario, snapshot]
    description: 'most output, per unit of nominal power: an availability profile'
  Generator_p_min_pu:
    dims: [generator, scenario, snapshot]
    description: least output, per unit of nominal power
  Generator_p_nom:
    dims: [generator, scenario]
    description: nominal power
  Generator_p_nom_extendable:
    dims: [generator]
    dtype: bool
    description: whether the nominal power is a decision
  Generator_sign:
    dims: [generator]
    description: the sign output enters its bus's balance with. It is PyPSA's `sign`, `1` unless given,
      `-1` for a unit that draws power. PyPSA refuses one that differs by scenario (`constants.py:46`)
  Line_active:
    dims: [line, snapshot]
    dtype: bool
    description: whether a line is active in a snapshot's period. It is PyPSA's `active`, data prep
  Line_cycle_weight:
    dims: [cycle, line, period]
    missing: absent
    description: 'the line''s series impedance, signed by its orientation in the cycle: the cycle basis,
      data prep. A line in no cycle has no row. PyPSA builds the cycle basis from the first scenario (`networks.py:1430-1437`),
      and refuses a `v_nom`, `x_pu_eff` or `r_pu_eff` that differs by scenario (`constants.py:33-35`).
      So the weight is the same in every scenario'
  Line_s_max_pu:
    dims: [line, scenario, snapshot]
    description: most flow either way, per unit of nominal apparent power
  Line_s_nom:
    dims: [line, scenario]
    description: nominal apparent power
  Line_s_nom_extendable:
    dims: [line]
    dtype: bool
    description: whether the nominal apparent power is a decision
  Link_active:
    dims: [link, snapshot]
    dtype: bool
    description: whether a link is active in a snapshot's period. It is PyPSA's `active`, data prep
  Link_committable:
    dims: [link]
    dtype: bool
    description: whether flow is gated by an on/off status decision
  Link_efficiency:
    dims: [link_output, scenario, snapshot]
    description: 'share of the flow that arrives at an output port, PyPSA''s `efficiency`, `efficiency2`,
      … read long: negative where that port consumes rather than delivers. Read at the snapshot the flow
      arrives, so a delayed port delivers at its arrival snapshot''s efficiency (`constraints.py:1575`)'
  Link_marginal_cost:
    dims: [link, scenario, snapshot]
    description: cost of one unit of flow
  Link_marginal_cost_quadratic:
    dims: [link, scenario, snapshot]
    description: cost of the square of one unit of flow
  Link_output_cyclic_delay:
    dims: [link_output]
    dtype: bool
    description: whether a delayed port's flow wraps from the end of its investment period (PyPSA's `cyclic_delay`,
      `cyclic_delay2`, …). Where it does not, the flow still in transit at each period's first snapshots
      is lost. The flag is the same in every scenario, as the delay is
  Link_output_delay:
    dims: [link_output]
    dtype: int
    description: snapshots a port's delivery lags its link's flow (PyPSA's `delay`, `delay2`, … read long).
      In data prep you divide it by the `snapshot_weightings.generators` value and round it up. It is
      zero for a port that delivers at once. A port has the same delay in every scenario, because PyPSA
      refuses a delay that differs by scenario (`constants.py:55`)
  Link_p_max_pu:
    dims: [link, scenario, snapshot]
    description: most flow, per unit of nominal power
  Link_p_min_pu:
    dims: [link, scenario, snapshot]
    description: 'least flow, per unit of nominal power: negative for a link that carries both ways'
  Link_p_nom:
    dims: [link, scenario]
    description: nominal power
  Link_p_nom_extendable:
    dims: [link]
    dtype: bool
    description: whether the nominal power is a decision
  Load_active:
    dims: [load]
    dtype: bool
    description: whether a load is active in the network, PyPSA's `active`. A load has no build year and
      no lifetime, so the flag is the same in every snapshot. PyPSA refuses one that differs by scenario
      (`constants.py:54`)
  Load_p_set:
    dims: [load, scenario, snapshot]
    description: demand
  Load_sign:
    dims: [load]
    description: the sign a load's demand enters its bus's balance with. It is PyPSA's `sign`, `-1` unless
      given, `1` for a load that feeds its bus. PyPSA refuses one that differs by scenario (`constants.py:46`)
  Process_active:
    dims: [process, snapshot]
    dtype: bool
    description: whether a process is active in a snapshot's period. It is PyPSA's `active`, data prep
  Process_output_cyclic_delay:
    dims: [process_output]
    dtype: bool
    description: whether a delayed port's transfer wraps from the end of its investment period (PyPSA's
      `cyclic_delay0`, `cyclic_delay1`, …). Where it does not, the energy still in transit at each period's
      first snapshots is lost. The flag is the same in every scenario, as the delay is
  Process_output_delay:
    dims: [process_output]
    dtype: int
    description: snapshots a port's transfer lags its process's internal power (PyPSA's `delay0`, `delay1`,
      … read long). In data prep you divide it by the `snapshot_weightings.generators` value and round
      it up. It is zero for a port that transfers at once. A port has the same delay in every scenario,
      as a link's port has
  Process_rate:
    dims: [process_output, scenario, snapshot]
    description: the energy a port draws or delivers per unit of internal power (PyPSA's `rate0`, `rate1`,
      … read long). It is negative where the port withdraws and positive where it injects. A link is a
      process whose `bus0` rate is minus one and whose output rates are its efficiencies. The rate at
      the snapshot the transfer arrives applies, so a delayed port transfers at its arrival snapshot's
      rate (`constraints.py:1575`)
  Transformer_active:
    dims: [snapshot, transformer]
    dtype: bool
    description: whether a transformer is active in a snapshot's period. It is PyPSA's `active`, data
      prep
  Transformer_cycle_weight:
    dims: [cycle, period, transformer]
    missing: absent
    description: the transformer's effective series reactance, `x` times its tap ratio, signed by its
      orientation in the cycle. It is PyPSA's `x_pu_eff`, the cycle basis, data prep. A transformer in
      no cycle has no row. It is the same in every scenario, as a line's
  Transformer_phase_shift_cycle_weight:
    dims: [cycle, period, scenario, transformer]
    description: the cycle sign for a varying transformer's phase shift, times π/180 so a shift in degrees
      enters the cycle sum in radians, data prep. It is zero for a fixed transformer or one in no cycle
  Transformer_phase_shift_max:
    dims: [scenario, transformer]
    description: the most a varying transformer's phase shift may take, in degrees. It is PyPSA's `phase_shift_max`.
      Equal to `phase_shift_min` for a fixed transformer
  Transformer_phase_shift_min:
    dims: [scenario, transformer]
    description: the least a varying transformer's phase shift may take, in degrees. It is PyPSA's `phase_shift_min`.
      Where it is below `phase_shift_max` the shift is a decision, otherwise the transformer keeps its
      fixed `phase_shift`
  Transformer_phase_shift_varying:
    dims: [scenario, transformer]
    dtype: bool
    description: whether a transformer's phase shift is a decision (PyPSA's `phase_shift_min < phase_shift_max`,
      read as a flag in data prep). False is a fixed shift, set by `phase_shift`. It may differ by scenario,
      as PyPSA reads it per scenario (`variables.py:446-456`)
  Transformer_s_max_pu:
    dims: [scenario, snapshot, transformer]
    description: most flow either way, per unit of nominal apparent power
  Transformer_s_nom:
    dims: [scenario, transformer]
    description: nominal apparent power
  Transformer_s_nom_extendable:
    dims: [transformer]
    dtype: bool
    description: whether the nominal apparent power is a decision
  period_weight_objective:
    dims: [period]
    description: PyPSA's `investment_period_weightings.objective` — what a period's cost weighs. PyPSA
      reads it only under `multi_investment_periods`. Otherwise you feed one in data prep, whatever the
      column contains (`optimize.py:231-233`, `:293-297`)
  scenario_weight:
    dims: [scenario]
    description: PyPSA's `scenario_weightings.weight` — the probability of a future
  snapshot_weightings_objective:
    dims: [snapshot]
    description: PyPSA's `snapshot_weightings.objective` — hours a snapshot weighs in the cost
variables:
  Generator_p:
    dims: [generator, scenario, snapshot]
    where: Generator_active
    description: '`Generator-p` — output of a generator in a snapshot'
  Line_s:
    dims: [line, scenario, snapshot]
    where: Line_active
    description: '`Line-s` — PyPSA''s `p0`, the flow measured at the `Line_bus0` end: a positive value
      withdraws there and injects at `Line_bus1`, lossless'
  Link_p:
    dims: [link, scenario, snapshot]
    where: Link_active
    description: '`Link-p` — PyPSA''s `p0`, the flow measured at the `Link_bus0` end. A positive value
      withdraws there and injects at every bus the link''s output ports deliver to'
  Transformer_phase_shift:
    dims: [scenario, snapshot, transformer]
    where: Transformer_phase_shift_varying AND Transformer_active
    bounds: {lower: Transformer_phase_shift_min, upper: Transformer_phase_shift_max}
    missing: 0.0
    description: '`Transformer-phase_shift` — a phase-shifting transformer''s voltage angle shift in degrees,
      chosen per snapshot to redistribute the flows around its cycles without moving active power. Absent,
      and zero in the cycle sum, where the shift is fixed'
  Transformer_s:
    dims: [scenario, snapshot, transformer]
    where: Transformer_active
    description: '`Transformer-s` — PyPSA''s `p0`, the flow measured at the `Transformer_bus0` end: a
      positive value withdraws there and injects at `Transformer_bus1`, lossless'
  Process_p:
    dims: [process, scenario, snapshot]
    where: Process_active
    description: '`Process-p` — PyPSA''s internal power `p`. A positive value drives every port at its
      own rate, withdrawing where the rate is negative and injecting where it is positive'
  Generator_marginal_cost_piecewise:
    dims: [generator, scenario, snapshot]
    where: Generator_marginal_cost_curve AND Generator_active
    description: '`Generator-marginal_cost_piecewise` — the running cost of a generator that pays along
      a curve, held above the curve'
constraints:
  Bus_nodal_balance:
    dims: [bus, scenario, snapshot]
    where: Bus_attached
    expression: Bus_injection == 0
    description: '`Bus-nodal_balance` — what is generated at a bus meets the load there, less half of
      every incident line''s and transformer''s loss. What is generated includes storage dispatch and
      stores. It is net of what the links take away, plus what arrives over them after losses and any
      delay at every port they deliver to. Each process port draws or delivers at its own rate, and each
      passive branch carries its flow. PyPSA dissipates a branch''s loss half at either end. Each generator,
      storage unit, store and load term enters with its component''s `sign` (`constraints.py:1480-1481`,
      `:1592`), and an inactive load not at all. A bus nothing is attached to has no row. PyPSA refuses
      one that carries load. The file states no assumption for it.'
  Generator_fix_p_lower:
    dims: [generator, scenario, snapshot]
    where: not Generator_p_nom_extendable AND not Generator_committable AND Generator_active
    expression: Generator_p >= Generator_p_min_pu * Generator_p_nom
    description: '`Generator-fix-p-lower` — a fixed generator outputs at least its minimum'
  Generator_fix_p_upper:
    dims: [generator, scenario, snapshot]
    where: not Generator_p_nom_extendable AND not Generator_committable AND Generator_active
    expression: Generator_p <= Generator_p_max_pu * Generator_p_nom
    description: '`Generator-fix-p-upper` — a fixed generator outputs at most what is available'
  Kirchhoff_Voltage_Law:
    dims: [cycle, scenario, snapshot]
    where: at(Cycle_in_basis, by=snapshot_period[period])
    expression: Cycle_angle_sum == 0
    description: '`Kirchhoff-Voltage-Law` — around every independent cycle the impedance-weighted flows
      sum to nothing. This makes the linear power flow physical rather than transport. A transformer''s
      flow weighs its effective reactance, and its phase shift enters the cycle sum too. The shift is
      a constant where it is fixed. Where a phase-shifting transformer chooses its shift, it is the shift
      decision times its cycle weight. A snapshot uses the cycles of its own period, of the branches that
      are active in it (`constraints.py:1710-1729`). A cycle label that period''s basis does not reach
      has no row'
  Line_fix_s_lower:
    dims: [line, scenario, snapshot]
    where: not Line_s_nom_extendable AND Line_active
    expression: Line_s >= (-Line_s_max_pu) * Line_s_nom
    description: '`Line-fix-s-lower` — a fixed line carries at least the negative of its rating, the loss
      counted against it'
  Line_fix_s_upper:
    dims: [line, scenario, snapshot]
    where: not Line_s_nom_extendable AND Line_active
    expression: Line_s <= Line_s_max_pu * Line_s_nom
    description: '`Line-fix-s-upper` — a fixed line carries at most its rating, the loss included'
  Link_fix_p_lower:
    dims: [link, scenario, snapshot]
    where: not Link_p_nom_extendable AND not Link_committable AND Link_active
    expression: Link_p >= Link_p_min_pu * Link_p_nom
    description: '`Link-fix-p-lower` — a fixed link carries at least its minimum, negative for the other
      way'
  Link_fix_p_upper:
    dims: [link, scenario, snapshot]
    where: not Link_p_nom_extendable AND not Link_committable AND Link_active
    expression: Link_p <= Link_p_max_pu * Link_p_nom
    description: '`Link-fix-p-upper` — a fixed link carries at most its nominal power'
  Transformer_fix_s_lower:
    dims: [scenario, snapshot, transformer]
    where: not Transformer_s_nom_extendable AND Transformer_active
    expression: Transformer_s >= (-Transformer_s_max_pu) * Transformer_s_nom
    description: '`Transformer-fix-s-lower` — a fixed transformer carries at least the negative of its
      rating, the loss counted against it'
  Transformer_fix_s_upper:
    dims: [scenario, snapshot, transformer]
    where: not Transformer_s_nom_extendable AND Transformer_active
    expression: Transformer_s <= Transformer_s_max_pu * Transformer_s_nom
    description: '`Transformer-fix-s-upper` — a fixed transformer carries at most its rating, the loss
      included'
expressions:
  Bus_injection:
    dims: [bus, scenario, snapshot]
    expression: ((((Generator_injection + Line_injection) + Link_injection) + Load_injection) + Process_injection)
      + Transformer_injection
    description: what every component puts into a bus, less what it takes out of it. PyPSA writes each
      term into the balance, and a load on its right-hand side
  Cycle_angle_sum:
    dims: [cycle, scenario, snapshot]
    expression: Line_angle_sum + Transformer_angle_sum
    description: 'the voltage angle differences around a cycle: every branch flow times its cycle weight,
      and every transformer phase shift'
  Generator_injection: {expression: 'sum(Generator_sign * Generator_p, over=generator, by=Generator_bus[bus])'}
  Generator_opex: {expression: 'sum(sum((Generator_running_cost * snapshot_weightings_objective) * at(period_weight_objective,
      by=snapshot_period[period]), over=generator), over=snapshot) + sum(sum((((Generator_p * Generator_p)
      * Generator_marginal_cost_quadratic) * snapshot_weightings_objective) * at(period_weight_objective,
      by=snapshot_period[period]), over=generator), over=snapshot)'}
  Generator_running_cost:
    dims: [generator, scenario, snapshot]
    description: 'what a generator''s output costs in a snapshot: the value read off its piecewise curve
      where it has one, and its linear `marginal_cost` otherwise. A curve replaces the linear cost, as
      PyPSA drops the unit from that term (`optimize.py:333-348`)'
    cases:
      curve: {when: Generator_marginal_cost_curve, expression: Generator_marginal_cost_piecewise}
    otherwise: Generator_p * Generator_marginal_cost
  Line_angle_sum: {expression: 'sum(Line_s * at(Line_cycle_weight, by=snapshot_period[period]), over=line)'}
  Line_injection: {expression: '(-sum(Line_s, over=line, by=Line_bus0[bus])) + sum(Line_s, over=line,
      by=Line_bus1[bus])'}
  Link_injection: {expression: '-sum(Link_p, over=link, by=Link_bus0[bus]) + sum(Link_output_arrival,
      over=link_output, by=Link_output_bus[bus])'}
  Link_opex: {expression: 'sum(sum(((Link_p * Link_marginal_cost) * snapshot_weightings_objective) * at(period_weight_objective,
      by=snapshot_period[period]), over=link), over=snapshot) + sum(sum((((Link_p * Link_p) * Link_marginal_cost_quadratic)
      * snapshot_weightings_objective) * at(period_weight_objective, by=snapshot_period[period]), over=link),
      over=snapshot)'}
  Link_output_arrival:
    dims: [link_output, scenario, snapshot]
    description: what a link delivers to an output port at a snapshot. It is its flow delayed by the port's
      `delay` within its investment period. It is multiplied by the port's efficiency at the snapshot
      the flow arrives. Where the port is `cyclic_delay`, the delayed flow wraps from the period's end.
      Where it is not, the flow still in transit at the period's first snapshots is lost. A port that
      does not delay (`delay` zero) delivers its flow unshifted, cyclic or not
    cases:
      wrapping: {when: Link_output_cyclic_delay, expression: 'shift(at(Link_p, by=Link_output_link[link]),
          along=snapshot, offset=Link_output_delay, edge=''wrap'', within=snapshot_period[period]) * Link_efficiency'}
    otherwise: shift(at(Link_p, by=Link_output_link[link]), along=snapshot, offset=Link_output_delay,
      edge=0, within=snapshot_period[period]) * Link_efficiency
  Load_demand:
    dims: [load, scenario, snapshot]
    description: what a load draws from its bus's balance. It is its demand times its sign where it is
      active, and nothing where it is not. PyPSA drops an inactive load from the balance (`constraints.py:1591-1592`)
    cases:
      active: {when: Load_active, expression: Load_sign * Load_p_set}
    otherwise: '0'
  Load_injection: {expression: 'sum(Load_demand, over=load, by=Load_bus[bus])'}
  Process_injection: {expression: 'sum(Process_output_arrival, over=process_output, by=Process_output_bus[bus])'}
  Process_output_arrival:
    dims: [process_output, scenario, snapshot]
    description: what a process transfers at a port at a snapshot. It is its internal power delayed by
      the port's `delay` within its investment period. It is multiplied by the port's rate at the snapshot
      the transfer arrives. Where the port is `cyclic_delay`, the delayed transfer wraps from the period's
      end. Where it is not, the energy still in transit at the period's first snapshots is lost. A port
      that does not delay (`delay` zero) transfers at once, cyclic or not
    cases:
      wrapping: {when: Process_output_cyclic_delay, expression: 'shift(at(Process_p, by=Process_output_process[process]),
          along=snapshot, offset=Process_output_delay, edge=''wrap'', within=snapshot_period[period])
          * Process_rate'}
    otherwise: shift(at(Process_p, by=Process_output_process[process]), along=snapshot, offset=Process_output_delay,
      edge=0, within=snapshot_period[period]) * Process_rate
  Transformer_angle_sum: {expression: 'sum(Transformer_s * at(Transformer_cycle_weight, by=snapshot_period[period]),
      over=transformer) + sum(Transformer_phase_shift * at(Transformer_phase_shift_cycle_weight, by=snapshot_period[period]),
      over=transformer)'}
  Transformer_injection: {expression: '(-sum(Transformer_s, over=transformer, by=Transformer_bus0[bus]))
      + sum(Transformer_s, over=transformer, by=Transformer_bus1[bus])'}
  risk_weighted_opex: {expression: 'sum(scenario_weight * scenario_opex, over=scenario)'}
  scenario_opex:
    dims: [scenario]
    expression: Generator_opex + Link_opex
    description: 'what a future costs to run: every operating term, weighted by the snapshot''s hours
      and its period, before the scenario''s own weight. A start and a stop cost what they cost, unweighted,
      as PyPSA adds them (`optimize.py:448-468`)'
  total_cost:
    dims: []
    expression: risk_weighted_opex
    description: what the system costs. Capacity counts once per active period at its expected cost over
      the scenarios. Operation counts in expectation over the scenarios, and a share of it at the tail
conditions:
  Generator_marginal_cost_curve: {condition: 'count(Generator_marginal_cost_curve_p, over=breakpoint)
      > 0 AND Generator_active_asset', description: 'a generator that pays along a piecewise `marginal_cost`
      curve: one of PyPSA''s `active_assets` with curve data (`optimize.py:307`, `piecewise.py:230-257`)'}
objective: {sense: minimize, expression: total_cost}

The prep — every table the spec declares, from the network — and the solve:

from differential.pypsa.prep import relation, static, varying, weighting


n = build()  # the network from the PyPSA tab

sources = {
    'bus': pl.Series('bus', list(names(n.buses.index).astype(str)), dtype=pl.String),
        **{
            dim: pl.Series(dim, list(names(n.static(component).index).astype(str)), dtype=pl.String)
            for component, dim in DIM.items()
        },
        **scenarios(n),
        **periods(n, multi),
        **carriers(n, multi),
    'snapshot': pl.Series('snapshot', list(timesteps(n)), dtype=pl.Datetime('us')),
    'Generator_bus': relation(n, 'Generator', 'bus'),
    'Link_bus0': relation(n, 'Link', 'bus0'),
    'Load_bus': relation(n, 'Load', 'bus'),
    'Bus_attached': attached(n),
    'Generator_sign': per_component('Generator', first_scenario(n.generators['sign'])),
    'Load_active': per_component('Load', first_scenario(loads['active']), bool),
    'Load_p_set': varying(n, 'Load', 'p_set'),
    'Load_sign': per_component('Load', first_scenario(loads['sign'])),
    'snapshot_weightings_objective': weighting(n, 'objective'),
}

with sps.solve('differential/pypsa/rungs/rung_20_phase_shifter.yaml', sources) as solution:
    solution.objective  # 16455.0

The network, rung_20_phase_shifter.py in the corpus — the spine plus what this rung adds:

# SPDX-FileCopyrightText: mathspec Contributors
#
# SPDX-License-Identifier: MIT

"""Rung 20: phase shifter — a transformer whose per-snapshot phase shift is optimised, holding it at its rating and rerouting the surplus around the cycle.

The parallel lines carry low reactance, so a few degrees of shift move tens of
megawatts: the phase-shifting transformer keeps its flow at its ``s_nom`` while
the upstream hydro serves the whole varying load, and the costly local unit
stays off. A fixed shift could not follow the load, so the shift is a decision.
"""

from __future__ import annotations

import spine


def build():
    """The spine plus a triangle where a phase-shifting transformer reroutes cheap power around a binding leg, as a ``pypsa.Network``."""
    n = spine.build()
    n.add('Bus', ['a', 'b', 'c'])
    n.add('Generator', 'hydro20', bus='a', p_nom=300, marginal_cost=10)
    n.add('Generator', 'diesel20', bus='c', p_nom=300, marginal_cost=200)
    n.add('Load', 'town20', bus='c', p_set=[90, 75, 120, 105])
    n.add('Line', 'ab20', bus0='a', bus1='b', carrier='AC', x=0.002, r=0.0002, s_nom=120)
    n.add('Line', 'bc20', bus0='b', bus1='c', carrier='AC', x=0.002, r=0.0002, s_nom=120)
    n.add(
        'Transformer',
        'ca20',
        bus0='c',
        bus1='a',
        x=0.002,
        r=0.0002,
        s_nom=40,
        phase_shift_min=-30,
        phase_shift_max=30,
    )
    return n
n = build()
n.optimize(solver_name='highs')
n.objective  # 16455.0

The data

The tables this rung is the first to declare (4), as the prep produced them:

Transformer_phase_shift_cycle_weight.csv

cycle,period,scenario,transformer,value
0,0,base,ca20,-1745.32925199433

Transformer_phase_shift_max.csv

scenario,transformer,value
base,ca20,30.0

Transformer_phase_shift_min.csv

scenario,transformer,value
base,ca20,-30.0

Transformer_phase_shift_varying.csv

scenario,transformer,value
base,ca20,true