Rung 60: efficiencies per snapshot — a link, a process, a storage unit, a fuel unit under a primary-energy cap and a transformer with a fixed phase shift, each reading its coefficient per snapshot¶
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 130562.094184 on both sides; structure ✔ 20 constraints · 8 variables, name for name; size ✔ 133 rows · ✔ 52 columns · ✔ 204 nonzeros; duals ✔ 133 rows; model for model: 28 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 |
20 | 20 |
Generator-fix-p-upper |
20 | 20 |
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 |
Process-fix-p-lower |
4 | 4 |
Process-fix-p-upper |
4 | 4 |
StorageUnit-energy_balance |
4 | 4 |
StorageUnit-fix-p_dispatch-lower |
4 | 4 |
StorageUnit-fix-p_dispatch-upper |
4 | 4 |
StorageUnit-fix-p_store-lower |
4 | 4 |
StorageUnit-fix-p_store-upper |
4 | 4 |
StorageUnit-fix-state_of_charge-lower |
4 | 4 |
StorageUnit-fix-state_of_charge-upper |
4 | 4 |
Transformer-fix-s-lower |
4 | 4 |
Transformer-fix-s-upper |
4 | 4 |
primary_energy |
1 | 1 |
| column | PyPSA | specsolve |
|---|---|---|
Generator-p |
20 | 20 |
Line-s |
8 | 8 |
Link-p |
4 | 4 |
Process-p |
4 | 4 |
StorageUnit-p_dispatch |
4 | 4 |
StorageUnit-p_store |
4 | 4 |
StorageUnit-state_of_charge |
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{StorageUnit\_bus}: \mathcal{S} \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{L}\) | index \(l\) — global_constraint — PyPSA's GlobalConstraint rows, one label per declared limit |
| \(\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{S}\) | index \(s\) — storage_unit with \(\mathrm{StorageUnit\_bus}: \mathcal{S} \to \mathcal{N}\) — storage units, dispatch and store behind one bus connection |
| \(\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{a}\) | Generator_primary_energy_weight over \(\mathcal{G} \times \mathcal{L} \times \Xi \times \mathcal{T}\), absent where the data has no row — the constrained attribute per unit of energy at the bus: the carrier's co2_emissions over the generator's efficiency at the snapshot, data prep. A generator of an unweighted carrier has no row |
| \(\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{K}\) | GlobalConstraint_constant over \(\mathcal{L} \times \Xi\) — the constant the total is held against. What a variable cannot represent is folded in here in data prep. That is an initial charge, times its period's years for each counted period where the storage reopens per period, or a non-extendable build. PyPSA reads it per scenario (global_constraints.py:577, :780, :859-864) |
| \(\mathrm{in}\) | GlobalConstraint_counts_snapshot over \(\mathcal{L} \times \Xi \times \mathcal{T}\), false where the data has no row — whether a row counts a snapshot in a scenario (PyPSA's investment_period), data prep. It is every snapshot where the row states no period, and only that period's where it states one. A row that states a period the run does not model has no label here, as PyPSA skips it (global_constraints.py:388). PyPSA reads the column only under multi_investment_periods. It fails on a row that states a period without it (global_constraints.py:380-385) |
| \(\mathrm{sense}\) | GlobalConstraint_sense over \(\mathcal{L} \times \Xi\) — the row's sense in each scenario: <=, >= or ==. PyPSA reads a row's sense per scenario (global_constraints.py:576, :779, :859-864) |
| \(\mathrm{type}\) | GlobalConstraint_type over \(\mathcal{L}\) — which formula the row takes: primary_energy, operational_limit, transmission_volume_expansion_limit, transmission_expansion_cost_limit, tech_capacity_expansion_limit or flow_based |
| \(\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{com}^{z}\) | Process_committable over \(\mathcal{J}\) — whether internal power is gated by an on/off status decision |
| \(\mathrm{c}^{z}\) | Process_marginal_cost over \(\mathcal{J} \times \Xi \times \mathcal{T}\) — cost of one unit of internal power |
| \(\mathrm{c}^{z,(2)}\) | Process_marginal_cost_quadratic over \(\mathcal{J} \times \Xi \times \mathcal{T}\) — cost of the square of one unit of internal power |
| \(\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 |
| \(\overline{\mathrm{z}}\) | Process_p_max_pu over \(\mathcal{J} \times \Xi \times \mathcal{T}\) — most internal power, per unit of nominal power |
| \(\underline{\mathrm{z}}\) | Process_p_min_pu over \(\mathcal{J} \times \Xi \times \mathcal{T}\) — least internal power, per unit of nominal power: negative for a process that runs both ways |
| \(\mathrm{z}^{\mathrm{nom}}\) | Process_p_nom over \(\mathcal{J} \times \Xi\) — nominal internal power |
| \(\mathrm{ext}^{z}\) | Process_p_nom_extendable over \(\mathcal{J}\) — whether the nominal internal power is a decision |
| \(\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}^{h}\) | StorageUnit_active over \(\mathcal{T} \times \mathcal{S}\) — whether a storage unit is active in a snapshot's period. It is PyPSA's active, data prep |
| \(\mathrm{cyc}\) | StorageUnit_cyclic_state_of_charge over \(\Xi \times \mathcal{S}\) — whether the horizon closes on itself instead of opening on the initial charge |
| \(\mathrm{cyc}^{y}\) | StorageUnit_cyclic_state_of_charge_per_period over \(\Xi \times \mathcal{S}\) — whether each investment period closes on itself instead of carrying its charge on to the next. It overrides cyclic_state_of_charge and state_of_charge_initial_per_period. PyPSA reads it only under multi_investment_periods. Otherwise you feed false in data prep |
| \(\eta^{+}\) | StorageUnit_efficiency_dispatch over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — share of the charge drawn down that reaches the bus |
| \(\eta^{-}\) | StorageUnit_efficiency_store over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — share of the power drawn from the bus that becomes charge |
| \(\mathrm{idle}\) | StorageUnit_inactive_snapshots over \(\mathcal{S}\) — how many snapshots a storage unit is not active in. It is PyPSA's (~active).sum(), data prep. A cyclic unit reaches back this many snapshots further, so it closes on the last snapshot it is active in |
| \(\mathrm{inflow}\) | StorageUnit_inflow over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — energy arriving per hour, a river into a reservoir |
| \(\mathrm{c}^{h}\) | StorageUnit_marginal_cost over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — cost of one unit of dispatch |
| \(\mathrm{c}^{h,(2)}\) | StorageUnit_marginal_cost_quadratic over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — cost of the square of one unit of dispatch. Storing is not charged |
| \(\mathrm{c}^{\mathrm{soc}}\) | StorageUnit_marginal_cost_storage over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — cost of one unit of charge held over one snapshot |
| \(\mathrm{T}^{h}\) | StorageUnit_max_hours over \(\Xi \times \mathcal{S}\) — energy capacity, as hours of dispatch at nominal power |
| \(\mathrm{open}\) | StorageUnit_opens_late over \(\mathcal{T} \times \mathcal{S}\) — whether a snapshot is the first a storage unit is active in, where that is not the first of the horizon, data prep. It is PyPSA's active.cumsum() == 1 over the snapshots it is active in, past the first snapshot. It is false in a run where every unit is active throughout |
| \(\overline{\mathrm{h}}\) | StorageUnit_p_max_pu over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — most dispatch, per unit of nominal power |
| \(\underline{\mathrm{h}}\) | StorageUnit_p_min_pu over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — most storing, per unit of nominal power and negated |
| \(\mathrm{h}^{\mathrm{nom}}\) | StorageUnit_p_nom over \(\Xi \times \mathcal{S}\) — nominal power |
| \(\mathrm{ext}^{h}\) | StorageUnit_p_nom_extendable over \(\mathcal{S}\) — whether the nominal power is a decision |
| \(\rho\) | StorageUnit_retention over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — share of charge kept over a snapshot. It is PyPSA's (1 - standing_loss) ** elapsed hours, data prep |
| \(\mathrm{sgn}^{h}\) | StorageUnit_sign over \(\mathcal{S}\) — the sign net dispatch enters its bus's balance with. It is PyPSA's sign, 1 unless given. PyPSA refuses one that differs by scenario (constants.py:46) |
| \(\mathrm{soc}^{0}\) | StorageUnit_state_of_charge_initial over \(\Xi \times \mathcal{S}\) — charge held before the first snapshot |
| \(\mathrm{reset}\) | StorageUnit_state_of_charge_initial_per_period over \(\Xi \times \mathcal{S}\) — whether each investment period opens on the initial charge instead of carrying the previous period's. PyPSA reads it only under multi_investment_periods. Otherwise you feed false in data prep |
| \(\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 |
| \(\vartheta\) | Transformer_phase_shift_weight over \(\mathcal{C} \times \Xi \times \mathcal{T} \times \mathcal{M}\), absent where the data has no row — a fixed transformer's phase shift in radians at each snapshot, signed by its orientation in the cycle, data prep. It is a constant added to the cycle sum. It is zero for a varying transformer, whose shift is a decision instead. The constant and the variable term thus never both count a shift. A transformer with no shift or in no cycle of its snapshot's period has no row |
| \(\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) |
| \(\mathrm{w}^{\mathrm{yr}}\) | period_weight_years over \(\mathcal{Y}\) — PyPSA's investment_period_weightings.years — what a period's energy weighs in a primary_energy, operational_limit or e_sum row. PyPSA reads it only under multi_investment_periods. Otherwise you feed one in data prep |
| \(\pi\) | scenario_weight over \(\Xi\) — PyPSA's scenario_weightings.weight — the probability of a future |
| \(\mathrm{w}^{\mathrm{gen}}\) | snapshot_weightings_generators over \(\mathcal{T}\) — PyPSA's snapshot_weightings.generators — hours a snapshot weighs in an energy total |
| \(\mathrm{w}\) | snapshot_weightings_objective over \(\mathcal{T}\) — PyPSA's snapshot_weightings.objective — hours a snapshot weighs in the cost |
| \(\mathrm{w}^{\mathrm{sto}}\) | snapshot_weightings_stores over \(\mathcal{T}\) — PyPSA's snapshot_weightings.stores — hours a snapshot weighs in a storage balance |
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) |
| \(\mathrm{StorageUnit\_fix}\) | StorageUnit_fix over \(\mathcal{T} \times \mathcal{S}\) — a storage unit with a fixed build that is active in the snapshot's period. It is PyPSA's fix rows |
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 |
| \(h^{+}\) | StorageUnit_p_dispatch over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — StorageUnit-p_dispatch — power delivered to the bus |
| \(h^{-}\) | StorageUnit_p_store over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — StorageUnit-p_store — power drawn from the bus into charge |
| \(\mathit{soc}\) | StorageUnit_state_of_charge over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — StorageUnit-state_of_charge — energy held at the end of a snapshot |
| \(\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\_primary\_energy}\) | Generator_primary_energy over \(\mathcal{L} \times \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) |
| \(\mathrm{GlobalConstraint\_energy\_weight}\) | GlobalConstraint_energy_weight over \(\mathcal{L} \times \Xi \times \mathcal{T}\) — what one unit of power at a snapshot counts for in a row. Where the row counts the snapshot, it is the generator weighting times the years of the snapshot's period. Where it does not, it is nothing |
| \(\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\_opex}\) | Process_opex over \(\Xi\) |
| \(\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{StorageUnit\_charge\_carried\_in}\) | StorageUnit_charge_carried_in over \(\Xi \times \mathcal{T} \times \mathcal{S}\) — the charge a unit opens a snapshot with. At the first snapshot it is active in, it is its last such snapshot's less standing loss where it is cyclic. Where it is not, it is the given initial charge, which no standing loss has touched yet. Otherwise it is the previous snapshot's less standing loss. A unit built in a later period opens in that period, and a cyclic one that retires closes on its own last snapshot. Per period, the same holds with each investment period as the horizon |
| \(\mathit{StorageUnit\_injection}\) | StorageUnit_injection over \(\mathcal{N} \times \Xi \times \mathcal{T}\) |
| \(\mathit{StorageUnit\_opex}\) | StorageUnit_opex over \(\Xi\) |
| \(\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{primary\_energy}\) | primary_energy over \(\mathcal{L} \times \Xi\) — what a primary_energy row totals: weighted generator energy over the snapshots it counts, less the charge left in weighted storage at the close. The initial charge it is compared against is folded into the row's constant |
| \(\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\) |
| \(\mathrm{pos}(t)\) | position() — the position of \(t\), counted from \(0\); \(t\) is the label |
| \(\mathrm{pos}_{\mathrm{relation}(t)}(t)\) | position(within=relation[...]) — the position of \(t\) inside its group |
Conditions¶
Generator_marginal_cost_curve
StorageUnit_fix
Variable domains¶
Generator_marginal_cost_piecewise
Generator_p
Line_s
Link_p
Process_p
StorageUnit_p_dispatch
StorageUnit_p_store
StorageUnit_state_of_charge
Transformer_s
Definitions¶
Bus_injection
Cycle_angle_sum
Generator_injection
Generator_opex
Generator_primary_energy
Generator_running_cost
GlobalConstraint_energy_weight
Line_angle_sum
Line_injection
Link_injection
Link_opex
Link_output_arrival
Load_demand
Load_injection
Process_injection
Process_opex
Process_output_arrival
StorageUnit_charge_carried_in
StorageUnit_injection
StorageUnit_opex
Transformer_angle_sum
Transformer_injection
primary_energy
risk_weighted_opex
scenario_opex
total_cost
Objective¶
Subject to¶
Bus_nodal_balance
Generator_fix_p_lower
Generator_fix_p_upper
GlobalConstraint_primary_energy_ub
Kirchhoff_Voltage_Law
Line_fix_s_lower
Line_fix_s_upper
Link_fix_p_lower
Link_fix_p_upper
Process_fix_p_lower
Process_fix_p_upper
StorageUnit_energy_balance
StorageUnit_fix_p_dispatch_lower
StorageUnit_fix_p_dispatch_upper
StorageUnit_fix_p_store_lower
StorageUnit_fix_p_store_upper
StorageUnit_fix_state_of_charge_lower
StorageUnit_fix_state_of_charge_upper
Transformer_fix_s_lower
Transformer_fix_s_upper
The spec, differential/pypsa/rungs/rung_60_efficiency_per_snapshot.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'}
global_constraint: {description: 'PyPSA''s `GlobalConstraint` rows, one label per declared limit'}
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}
storage_unit: {description: 'storage units, dispatch and store behind one bus connection'}
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}
StorageUnit_bus: {key: storage_unit, values: bus, description: the bus a storage unit sits on}
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_primary_energy_weight:
dims: [generator, global_constraint, scenario, snapshot]
missing: absent
description: 'the constrained attribute per unit of energy at the bus: the carrier''s `co2_emissions`
over the generator''s efficiency at the snapshot, data prep. A generator of an unweighted carrier
has no row'
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`)
GlobalConstraint_constant:
dims: [global_constraint, scenario]
description: the constant the total is held against. What a variable cannot represent is folded in
here in data prep. That is an initial charge, times its period's years for each counted period where
the storage reopens per period, or a non-extendable build. PyPSA reads it per scenario (`global_constraints.py:577`,
`:780`, `:859-864`)
GlobalConstraint_counts_snapshot:
dims: [global_constraint, scenario, snapshot]
dtype: bool
missing: false
description: whether a row counts a snapshot in a scenario (PyPSA's `investment_period`), data prep.
It is every snapshot where the row states no period, and only that period's where it states one.
A row that states a period the run does not model has no label here, as PyPSA skips it (`global_constraints.py:388`).
PyPSA reads the column only under `multi_investment_periods`. It fails on a row that states a period
without it (`global_constraints.py:380-385`)
GlobalConstraint_sense:
dims: [global_constraint, scenario]
dtype: str
description: 'the row''s sense in each scenario: `<=`, `>=` or `==`. PyPSA reads a row''s sense per
scenario (`global_constraints.py:576`, `:779`, `:859-864`)'
GlobalConstraint_type:
dims: [global_constraint]
dtype: str
description: 'which formula the row takes: `primary_energy`, `operational_limit`, `transmission_volume_expansion_limit`,
`transmission_expansion_cost_limit`, `tech_capacity_expansion_limit` or `flow_based`'
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_committable:
dims: [process]
dtype: bool
description: whether internal power is gated by an on/off status decision
Process_marginal_cost:
dims: [process, scenario, snapshot]
description: cost of one unit of internal power
Process_marginal_cost_quadratic:
dims: [process, scenario, snapshot]
description: cost of the square of one unit of internal power
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_p_max_pu:
dims: [process, scenario, snapshot]
description: most internal power, per unit of nominal power
Process_p_min_pu:
dims: [process, scenario, snapshot]
description: 'least internal power, per unit of nominal power: negative for a process that runs both
ways'
Process_p_nom:
dims: [process, scenario]
description: nominal internal power
Process_p_nom_extendable:
dims: [process]
dtype: bool
description: whether the nominal internal power is a decision
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`)
StorageUnit_active:
dims: [snapshot, storage_unit]
dtype: bool
description: whether a storage unit is active in a snapshot's period. It is PyPSA's `active`, data
prep
StorageUnit_cyclic_state_of_charge:
dims: [scenario, storage_unit]
dtype: bool
description: whether the horizon closes on itself instead of opening on the initial charge
StorageUnit_cyclic_state_of_charge_per_period:
dims: [scenario, storage_unit]
dtype: bool
description: whether each investment period closes on itself instead of carrying its charge on to
the next. It overrides `cyclic_state_of_charge` and `state_of_charge_initial_per_period`. PyPSA
reads it only under `multi_investment_periods`. Otherwise you feed false in data prep
StorageUnit_efficiency_dispatch:
dims: [scenario, snapshot, storage_unit]
description: share of the charge drawn down that reaches the bus
StorageUnit_efficiency_store:
dims: [scenario, snapshot, storage_unit]
description: share of the power drawn from the bus that becomes charge
StorageUnit_inactive_snapshots:
dims: [storage_unit]
dtype: int
description: how many snapshots a storage unit is not active in. It is PyPSA's `(~active).sum()`,
data prep. A cyclic unit reaches back this many snapshots further, so it closes on the last snapshot
it is active in
StorageUnit_inflow:
dims: [scenario, snapshot, storage_unit]
description: energy arriving per hour, a river into a reservoir
StorageUnit_marginal_cost:
dims: [scenario, snapshot, storage_unit]
description: cost of one unit of dispatch
StorageUnit_marginal_cost_quadratic:
dims: [scenario, snapshot, storage_unit]
description: cost of the square of one unit of dispatch. Storing is not charged
StorageUnit_marginal_cost_storage:
dims: [scenario, snapshot, storage_unit]
description: cost of one unit of charge held over one snapshot
StorageUnit_max_hours:
dims: [scenario, storage_unit]
description: energy capacity, as hours of dispatch at nominal power
StorageUnit_opens_late:
dims: [snapshot, storage_unit]
dtype: bool
description: whether a snapshot is the first a storage unit is active in, where that is not the first
of the horizon, data prep. It is PyPSA's `active.cumsum() == 1` over the snapshots it is active
in, past the first snapshot. It is false in a run where every unit is active throughout
StorageUnit_p_max_pu:
dims: [scenario, snapshot, storage_unit]
description: most dispatch, per unit of nominal power
StorageUnit_p_min_pu:
dims: [scenario, snapshot, storage_unit]
description: most storing, per unit of nominal power and negated
StorageUnit_p_nom:
dims: [scenario, storage_unit]
description: nominal power
StorageUnit_p_nom_extendable:
dims: [storage_unit]
dtype: bool
description: whether the nominal power is a decision
StorageUnit_retention:
dims: [scenario, snapshot, storage_unit]
description: share of charge kept over a snapshot. It is PyPSA's `(1 - standing_loss) ** elapsed hours`,
data prep
StorageUnit_sign:
dims: [storage_unit]
description: the sign net dispatch enters its bus's balance with. It is PyPSA's `sign`, `1` unless
given. PyPSA refuses one that differs by scenario (`constants.py:46`)
StorageUnit_state_of_charge_initial:
dims: [scenario, storage_unit]
description: charge held before the first snapshot
StorageUnit_state_of_charge_initial_per_period:
dims: [scenario, storage_unit]
dtype: bool
description: whether each investment period opens on the initial charge instead of carrying the previous
period's. PyPSA reads it only under `multi_investment_periods`. Otherwise you feed false in data
prep
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_weight:
dims: [cycle, scenario, snapshot, transformer]
missing: absent
description: a fixed transformer's phase shift in radians at each snapshot, signed by its orientation
in the cycle, data prep. It is a constant added to the cycle sum. It is zero for a varying transformer,
whose shift is a decision instead. The constant and the variable term thus never both count a shift.
A transformer with no shift or in no cycle of its snapshot's period has no row
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`)
period_weight_years:
dims: [period]
description: PyPSA's `investment_period_weightings.years` — what a period's energy weighs in a `primary_energy`,
`operational_limit` or `e_sum` row. PyPSA reads it only under `multi_investment_periods`. Otherwise
you feed one in data prep
scenario_weight:
dims: [scenario]
description: PyPSA's `scenario_weightings.weight` — the probability of a future
snapshot_weightings_generators:
dims: [snapshot]
description: PyPSA's `snapshot_weightings.generators` — hours a snapshot weighs in an energy total
snapshot_weightings_objective:
dims: [snapshot]
description: PyPSA's `snapshot_weightings.objective` — hours a snapshot weighs in the cost
snapshot_weightings_stores:
dims: [snapshot]
description: PyPSA's `snapshot_weightings.stores` — hours a snapshot weighs in a storage balance
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'
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'
StorageUnit_p_dispatch:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_active
description: '`StorageUnit-p_dispatch` — power delivered to the bus'
StorageUnit_p_store:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_active
description: '`StorageUnit-p_store` — power drawn from the bus into charge'
StorageUnit_state_of_charge:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_active
description: '`StorageUnit-state_of_charge` — energy held at the end of a snapshot'
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'
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'
GlobalConstraint_primary_energy_ub:
dims: [global_constraint, scenario]
where: GlobalConstraint_type == 'primary_energy' AND GlobalConstraint_sense == '<='
expression: primary_energy <= GlobalConstraint_constant
description: '`primary_energy` — its total, at most its constant'
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'
Process_fix_p_lower:
dims: [process, scenario, snapshot]
where: not Process_p_nom_extendable AND not Process_committable AND Process_active
expression: Process_p >= Process_p_min_pu * Process_p_nom
description: '`Process-fix-p-lower` — a fixed process runs at least its minimum, negative for the
other way'
Process_fix_p_upper:
dims: [process, scenario, snapshot]
where: not Process_p_nom_extendable AND not Process_committable AND Process_active
expression: Process_p <= Process_p_max_pu * Process_p_nom
description: '`Process-fix-p-upper` — a fixed process runs at most its nominal power'
StorageUnit_energy_balance:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_active
expression: ((StorageUnit_charge_carried_in + ((StorageUnit_efficiency_store * StorageUnit_p_store)
* snapshot_weightings_stores)) - ((StorageUnit_p_dispatch * snapshot_weightings_stores) / StorageUnit_efficiency_dispatch))
+ (StorageUnit_inflow * snapshot_weightings_stores) == StorageUnit_state_of_charge
description: '`StorageUnit-energy_balance` — the charge carried in, plus what is stored after its
efficiency, less what dispatch draws down before its own, plus inflow not spilled'
StorageUnit_fix_p_dispatch_lower:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_fix
expression: StorageUnit_p_dispatch >= 0
description: '`StorageUnit-fix-p_dispatch-lower` — dispatch is non-negative'
StorageUnit_fix_p_dispatch_upper:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_fix
expression: StorageUnit_p_dispatch <= StorageUnit_p_max_pu * StorageUnit_p_nom
description: '`StorageUnit-fix-p_dispatch-upper` — a fixed unit dispatches at most its nominal power'
StorageUnit_fix_p_store_lower:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_fix
expression: StorageUnit_p_store >= 0
description: '`StorageUnit-fix-p_store-lower` — storing is non-negative'
StorageUnit_fix_p_store_upper:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_fix
expression: StorageUnit_p_store <= -StorageUnit_p_min_pu * StorageUnit_p_nom
description: '`StorageUnit-fix-p_store-upper` — a fixed unit stores at most its nominal power, the
minimum-per-unit column carrying that cap negated'
StorageUnit_fix_state_of_charge_lower:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_fix
expression: StorageUnit_state_of_charge >= 0
description: '`StorageUnit-fix-state_of_charge-lower` — charge is non-negative'
StorageUnit_fix_state_of_charge_upper:
dims: [scenario, snapshot, storage_unit]
where: StorageUnit_fix
expression: StorageUnit_state_of_charge <= StorageUnit_max_hours * StorageUnit_p_nom
description: '`StorageUnit-fix-state_of_charge-upper` — a fixed unit holds at most its hours at 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)
+ StorageUnit_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_primary_energy: {expression: 'sum(sum((Generator_p * GlobalConstraint_energy_weight) * Generator_primary_energy_weight,
over=snapshot), over=generator)'}
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
GlobalConstraint_energy_weight:
dims: [global_constraint, scenario, snapshot]
description: what one unit of power at a snapshot counts for in a row. Where the row counts the snapshot,
it is the generator weighting times the years of the snapshot's period. Where it does not, it is
nothing
cases:
counted: {when: GlobalConstraint_counts_snapshot, expression: 'snapshot_weightings_generators *
at(period_weight_years, by=snapshot_period[period])'}
otherwise: '0'
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_opex: {expression: 'sum(sum(((Process_p * Process_marginal_cost) * snapshot_weightings_objective)
* at(period_weight_objective, by=snapshot_period[period]), over=process), over=snapshot) + sum(sum((((Process_p
* Process_p) * Process_marginal_cost_quadratic) * snapshot_weightings_objective) * at(period_weight_objective,
by=snapshot_period[period]), over=process), over=snapshot)'}
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
StorageUnit_charge_carried_in:
dims: [scenario, snapshot, storage_unit]
description: the charge a unit opens a snapshot with. At the first snapshot it is active in, it is
its last such snapshot's less standing loss where it is cyclic. Where it is not, it is the given
initial charge, which no standing loss has touched yet. Otherwise it is the previous snapshot's
less standing loss. A unit built in a later period opens in that period, and a cyclic one that retires
closes on its own last snapshot. Per period, the same holds with each investment period as the horizon
cases:
cyclic: {when: StorageUnit_cyclic_state_of_charge AND NOT StorageUnit_cyclic_state_of_charge_per_period
AND NOT StorageUnit_state_of_charge_initial_per_period AND (position(snapshot) == 0 OR StorageUnit_opens_late),
expression: 'StorageUnit_retention * shift(shift(StorageUnit_state_of_charge, along=snapshot,
offset=1, edge=''wrap''), along=snapshot, offset=StorageUnit_inactive_snapshots, edge=''wrap'')'}
opening: {when: NOT StorageUnit_cyclic_state_of_charge AND NOT StorageUnit_cyclic_state_of_charge_per_period
AND NOT StorageUnit_state_of_charge_initial_per_period AND (position(snapshot) == 0 OR StorageUnit_opens_late),
expression: StorageUnit_state_of_charge_initial}
period_cyclic: {when: StorageUnit_cyclic_state_of_charge_per_period, expression: 'StorageUnit_retention
* shift(StorageUnit_state_of_charge, along=snapshot, offset=1, edge=''wrap'', within=snapshot_period[period])'}
period_opening: {when: 'StorageUnit_state_of_charge_initial_per_period AND NOT StorageUnit_cyclic_state_of_charge_per_period
AND position(snapshot, within=snapshot_period[period]) == 0', expression: StorageUnit_state_of_charge_initial}
otherwise: StorageUnit_retention * shift(StorageUnit_state_of_charge, along=snapshot, offset=1)
StorageUnit_injection: {expression: 'sum(StorageUnit_sign * (StorageUnit_p_dispatch - StorageUnit_p_store),
over=storage_unit, by=StorageUnit_bus[bus])'}
StorageUnit_opex: {expression: '(sum(sum(((StorageUnit_p_dispatch * StorageUnit_marginal_cost) * snapshot_weightings_objective)
* at(period_weight_objective, by=snapshot_period[period]), over=storage_unit), over=snapshot) +
sum(sum((((StorageUnit_p_dispatch * StorageUnit_p_dispatch) * StorageUnit_marginal_cost_quadratic)
* snapshot_weightings_objective) * at(period_weight_objective, by=snapshot_period[period]), over=storage_unit),
over=snapshot)) + sum(sum(((StorageUnit_state_of_charge * StorageUnit_marginal_cost_storage) * snapshot_weightings_objective)
* at(period_weight_objective, by=snapshot_period[period]), over=storage_unit), over=snapshot)'}
Transformer_angle_sum: {expression: 'sum(Transformer_s * at(Transformer_cycle_weight, by=snapshot_period[period]),
over=transformer) + sum(Transformer_phase_shift_weight, over=transformer)'}
Transformer_injection: {expression: '(-sum(Transformer_s, over=transformer, by=Transformer_bus0[bus]))
+ sum(Transformer_s, over=transformer, by=Transformer_bus1[bus])'}
primary_energy:
dims: [global_constraint, scenario]
expression: Generator_primary_energy
description: 'what a `primary_energy` row totals: weighted generator energy over the snapshots it
counts, less the charge left in weighted storage at the close. The initial charge it is compared
against is folded into the row''s constant'
risk_weighted_opex: {expression: 'sum(scenario_weight * scenario_opex, over=scenario)'}
scenario_opex:
dims: [scenario]
expression: ((Generator_opex + Link_opex) + Process_opex) + StorageUnit_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`)'}
StorageUnit_fix: {condition: NOT StorageUnit_p_nom_extendable AND StorageUnit_active, description: a
storage unit with a fixed build that is active in the snapshot's period. It is PyPSA's `fix` rows}
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
def _cycle_periods(n: pypsa.Network, multi: bool) -> list[tuple[object, object]]:
"""``(label, investment_period)`` per period PyPSA builds cycles for — every period under ``multi_investment_periods``, else the one with no period, which takes every branch."""
return [(p, p) for p in period_labels(n)] if multi else [(PLAIN_PERIOD, None)]
def _cycle_weights(n: pypsa.Network, multi: bool) -> dict[str, object]:
"""The KVL rows PyPSA itself writes, per period and branch — ``n.cycle_matrix(apply_weights=True)``, times the 1e5 PyPSA scales every cycle row by for conditioning.
Each period has its own basis, of the branches standing in it, so a cycle
label is a position in its period's basis. A branch whose weight is NaN — an
extendable one at zero nominal rating, whose per-unit reactance is infinite
— has no term: linopy drops it.
A transformer's phase shift enters the same rows: a fixed one as a constant
in radians at each snapshot of the period, a varying one as the shift
decision times its cycle sign and π/180. PyPSA builds the basis from the
first scenario only, and adds a shift only for a transformer that stands;
a fixed shift of zero adds nothing and has no row.
"""
n.determine_network_topology()
n.calculate_dependent_values()
transformers = first_scenario(n.static('Transformer'))
varying_ = transformers['phase_shift_min'] < transformers['phase_shift_max']
dense = get_switchable_as_dense(n, 'Transformer', 'phase_shift').set_axis(timesteps(n), axis=0)
if dense.columns.nlevels > 1:
dense = dense.T.groupby(level='name').first().T
active = active_by_snapshot(n, 'Transformer')
stamps = pd.Series(period_of(n) if multi else PLAIN_PERIOD, index=timesteps(n))
rows: dict[str, list[dict]] = {'Line': [], 'Transformer': []}
shift_rows, decision_rows = [], []
basis: dict[object, set[str]] = {}
for label, period in _cycle_periods(n, multi):
weighted = n.cycle_matrix(investment_period=period, apply_weights=True) * 1e5
if weighted.empty:
continue
basis[label] = {str(cycle) for cycle in weighted.columns}
for (kind, name), weights in weighted.iterrows():
rows.setdefault(kind, [])
rows[kind].extend(
{'period': label, DIM[kind]: str(name), 'cycle': str(cycle), 'value': float(w)}
for cycle, w in weights.items()
if w and not math.isnan(w)
)
plain = n.cycle_matrix(investment_period=period, apply_weights=False)
if 'Transformer' not in plain.index.get_level_values(0):
continue
snapshots = stamps.index[stamps.to_numpy() == label]
for name, signs in plain.loc['Transformer'].iterrows():
for cycle, sign in signs.items():
if not sign:
continue
if varying_.get(name, False):
decision_rows.append(
{
'period': label,
'transformer': str(name),
'cycle': str(cycle),
'value': sign * math.pi / 180 * 1e5,
}
)
continue
shift_rows.extend(
{
'snapshot': t,
'transformer': str(name),
'cycle': str(cycle),
'value': float(sign) * float(dense.at[t, name]) * math.pi / 180 * 1e5,
}
for t in snapshots
if dense.at[t, name] and active.at[t, name]
)
line = pd.DataFrame(rows['Line'], columns=['period', 'line', 'cycle', 'value']).astype({'value': float})
transformer = pd.DataFrame(rows['Transformer'], columns=['period', 'transformer', 'cycle', 'value']).astype(
{'value': float}
)
cycles = list(pd.unique(pd.concat([line['cycle'], transformer['cycle']])))
return {
'cycle': pl.Series('cycle', cycles, dtype=pl.String),
'Cycle_in_basis': pd.DataFrame(
[
{'period': label, 'cycle': cycle, 'value': cycle in basis.get(label, set())}
for label, _ in _cycle_periods(n, multi)
for cycle in cycles
],
columns=['period', 'cycle', 'value'],
).astype({'value': bool}),
'Line_cycle_weight': line,
'Transformer_cycle_weight': transformer,
'Transformer_phase_shift_weight': pd.DataFrame(
shift_rows, columns=['snapshot', 'transformer', 'cycle', 'value']
).astype({'value': float}),
'Transformer_phase_shift_cycle_weight': _everywhere(
pd.DataFrame(decision_rows, columns=['period', 'transformer', 'cycle', 'value']),
{
'period': [label for label, _ in _cycle_periods(n, multi)],
'transformer': list(transformers.index.astype(str)),
'cycle': cycles,
},
),
'Transformer_phase_shift_varying': per_component('Transformer', varying_, bool),
'Transformer_phase_shift_min': per_component('Transformer', transformers['phase_shift_min']),
'Transformer_phase_shift_max': per_component('Transformer', transformers['phase_shift_max']),
'Transformer_phase_shift_fixed': long('Transformer', dense),
}
def _everywhere(table: pd.DataFrame, labels: dict[str, list]) -> pd.DataFrame:
"""*table* with a zero at every combination of *labels* it has no row for — a table the file refuses to find short."""
product = pd.MultiIndex.from_product(list(labels.values()), names=list(labels)).to_frame(index=False)
return product.merge(table, on=list(labels), how='left').fillna({'value': 0.0}).astype({'value': float})
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'),
'StorageUnit_bus': relation(n, 'StorageUnit', '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_generators': weighting(n, 'generators'),
**{name: table for component in DISPATCHABLE for name, table in dispatchable(n, component, optimize).items()},
**ports(n, 'Link'),
**ports(n, 'Process'),
**storage(n, multi),
**branches(n),
**_cycle_weights(n, multi),
**losses(n, optimize, outages),
**security(n, outages, multi),
**global_constraints(n, multi),
**flow_based(n),
**marginal_cost_curve(n),
'snapshot_weightings_objective': weighting(n, 'objective'),
'snapshot_weightings_stores': weighting(n, 'stores'),
}
with sps.solve('differential/pypsa/rungs/rung_60_efficiency_per_snapshot.yaml', sources) as solution:
solution.objective # 130562.094184
The network, rung_60_efficiency_per_snapshot.py in the corpus — the spine plus what this rung adds:
# SPDX-FileCopyrightText: mathspec Contributors
#
# SPDX-License-Identifier: MIT
"""Rung 60: efficiencies per snapshot — a link, a process, a storage unit, a fuel unit under a primary-energy cap and a transformer with a fixed phase shift, each reading its coefficient per snapshot."""
from __future__ import annotations
from datetime import datetime
#: Four hourly stamps. The `generators` weighting is uniform, as rung 16's, so a
#: `delay` of one is a shift of one snapshot position. The `objective` and
#: `stores` columns stay non-uniform, so no cost or storage factor passes as identity.
SNAPSHOTS = [datetime(2015, 1, 1, hour) for hour in range(4)]
WEIGHTINGS = {'objective': [2.0, 1.5, 2.5, 3.0], 'stores': [0.5, 2.0, 1.5, 2.5], 'generators': [1.0, 1.0, 1.0, 1.0]}
LINK_EFFICIENCY = [2.0, 3.5, 2.5, 3.0]
PROCESS_RATE = [0.9, 0.5, 0.8, 0.6]
EFFICIENCY_STORE = [0.9, 0.5, 0.9, 0.5]
EFFICIENCY_DISPATCH = [0.6, 0.9, 0.7, 0.95]
FUEL_EFFICIENCY = [0.3, 0.6, 0.4, 0.5]
PHASE_SHIFT = [0.0, 0.5, -0.3, 1.0]
def build():
"""A source feeding a sink over a delayed link and a delayed process, a storage unit and a capped fuel unit at the sink, and a triangle with a fixed phase shift per snapshot."""
import pypsa
n = pypsa.Network()
n.set_snapshots(SNAPSHOTS)
for column, values in WEIGHTINGS.items():
n.snapshot_weightings[column] = values
n.add('Carrier', 'fuel60', co2_emissions=1.0)
n.add('Bus', ['source', 'sink'])
n.add('Generator', 'spring60', bus='source', p_nom=200, marginal_cost=5)
n.add('Generator', 'backup60', bus='sink', p_nom=200, marginal_cost=100)
n.add(
'Generator', 'fuel_unit60', bus='sink', carrier='fuel60', p_nom=40, marginal_cost=20, efficiency=FUEL_EFFICIENCY
)
n.add('Link', 'heat_pump60', bus0='source', bus1='sink', p_nom=10, efficiency=LINK_EFFICIENCY, delay=1)
n.add('Process', 'boiler60', bus0='source', bus1='sink', p_nom=20, rate1=PROCESS_RATE, delay1=1)
n.add(
'StorageUnit',
'battery60',
bus='sink',
p_nom=20,
max_hours=2,
cyclic_state_of_charge=True,
efficiency_store=EFFICIENCY_STORE,
efficiency_dispatch=EFFICIENCY_DISPATCH,
)
n.add('Load', 'sink_load60', bus='sink', p_set=[60.0, 90.0, 50.0, 100.0])
n.add(
'GlobalConstraint',
'fuel_cap60',
type='primary_energy',
carrier_attribute='co2_emissions',
sense='<=',
constant=150,
)
n.add('Bus', ['a', 'b', 'c'])
n.add('Generator', 'hydro60', bus='a', p_nom=300, marginal_cost=10)
n.add('Generator', 'diesel60', bus='c', p_nom=300, marginal_cost=200)
n.add('Load', 'town60', bus='c', p_set=[90.0, 75.0, 120.0, 105.0])
n.add('Line', 'ab60', bus0='a', bus1='b', carrier='AC', x=0.002, r=0.0002, s_nom=120)
n.add('Line', 'bc60', bus0='b', bus1='c', carrier='AC', x=0.002, r=0.0002, s_nom=120)
n.add('Transformer', 'ca60', bus0='c', bus1='a', x=0.002, r=0.0002, s_nom=40, phase_shift=PHASE_SHIFT)
return n
The data¶
Every table this spec declares was first declared by a lower rung; its values here are in the prep above.