Rung 58: a committable unit takes its status rows in every scenario¶

description: A plain `n.optimize()`, and its multi-period and stochastic classes, in one file. Every second-stage
  quantity spans a `scenario` (a future dispatch is chosen in) and every asset stands in the investment
  `period`s its build year and lifetime span. A parameter spans `scenario` exactly when PyPSA reads it
  per scenario. Capacity is chosen once, before the future is known, and paid once per active period at
  its cost in expectation over the scenarios; operation is the expectation over the scenarios' weights,
  with a share priced at the tail through the CVaR rows, which stand only where a risk preference is set.
  A plain run feeds one scenario, one period, all-active masks and unit weights, and the model collapses
  to the standard one. A security-constrained run copies each branch flow limit once per outage in an
  `outage` set that a plain run leaves empty. Which snapshots an asset is active in, a scenario's weight,
  and the outage factors are data prep.
dimensions:
  scenario: {description: 'the futures dispatch is chosen in, each with a weight'}
  snapshot: {description: dispatch periods, dtype: datetime, ordered: true}
  bus: {description: network nodes}
  generator: {description: 'generating units, each on one bus'}
  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 — PyPSA''s `bus1`,
      `bus2`, … columns read long, so a link of any number of output ports is one term in the balance,
      data prep'}
  process: {description: 'generalized 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 — PyPSA''s
      `bus0`, `bus1`, … each carry a signed `rate`, so a process of any number of ports is one term in
      the balance, data prep'}
  load: {description: 'demands, each on one bus'}
  period: {description: investment periods — PyPSA's `investment_periods`, dtype: int, ordered: true}
properties:
  snapshot:
    period:
      description: the investment period a snapshot falls in
      into: period
  generator:
    bus:
      description: the bus a generator sits on
      into: bus
  link:
    bus0:
      description: the bus a link leaves
      into: bus
  link_output:
    link:
      description: the link an output port belongs to
      into: link
    bus:
      description: >-
        the bus an output port delivers to — PyPSA's `bus1`, `bus2`, … columns.
        A link of three output ports is three labels here rather than a third
        property, so the file states any number of them
      into: bus
  process_output:
    process:
      description: the process a port belongs to
      into: process
    bus:
      description: >-
        the bus a port draws from or delivers to — PyPSA's `bus0`, `bus1`, …
        columns. A process of three ports is three labels here rather than a
        third property, so the file states any number of them
      into: bus
  load:
    bus:
      description: the bus a load sits on
      into: bus

parameters:
  snapshot_weightings_objective:
    description: PyPSA's `snapshot_weightings.objective` — hours a snapshot stands for in the cost
    dims: [snapshot]
  Generator_p_nom:
    description: nominal power
    dims: [scenario, generator]
  Generator_p_nom_extendable:
    description: whether the nominal power is a decision
    dims: [generator]
    dtype: bool
  Generator_p_min_pu:
    description: least output, per unit of nominal power
    dims: [scenario, snapshot, generator]
  Generator_p_max_pu:
    description: most output, per unit of nominal power — an availability profile
    dims: [scenario, snapshot, generator]
  Generator_marginal_cost:
    description: cost of one unit of output
    dims: [scenario, snapshot, generator]
  Generator_marginal_cost_quadratic:
    description: cost of the square of one unit of output
    dims: [scenario, snapshot, generator]
  Generator_sign:
    description: the sign output enters its bus's balance with — PyPSA's `sign`, `1` unless given, `-1`
      for a unit that draws power. PyPSA refuses one that differs by scenario (`constants.py:43`)
    dims: [generator]
  Generator_committable:
    description: whether output is gated by an on/off status decision
    dims: [generator]
    dtype: bool
  Generator_min_up_time:
    description: least snapshots a unit stays on once started
    dims: [scenario, generator]
    dtype: int
  Generator_status_initial:
    description: one where the unit was on before the first snapshot, zero where off — PyPSA's `up_time_before
      > 0`, data prep
    dims: [scenario, generator]
    dtype: int
  Generator_start_up_cost:
    description: cost of one start in this snapshot
    dims: [scenario, snapshot, generator]
  Generator_shut_down_cost:
    description: cost of one stop in this snapshot
    dims: [scenario, snapshot, generator]
  Generator_stand_by_cost:
    description: cost of one snapshot spent on
    dims: [scenario, snapshot, generator]
  Generator_p_nom_mod:
    description: the module size a build comes in whole numbers of; no value means the build is continuous
    dims: [generator]
    missing: absent
  Generator_modules_installed:
    description: 'how many whole modules a committable build has in place: `Generator_p_nom / Generator_p_nom_mod`
      where a fixed build is modular, one where it is not, data prep. PyPSA refuses a fixed modular build
      whose nominal power is not a whole number of modules'
    dims: [scenario, generator]
  Link_p_nom:
    description: nominal power
    dims: [scenario, link]
  Link_p_nom_extendable:
    description: whether the nominal power is a decision
    dims: [link]
    dtype: bool
  Link_p_min_pu:
    description: least flow, per unit of nominal power — negative for a link that carries both ways
    dims: [scenario, snapshot, link]
  Link_p_max_pu:
    description: most flow, per unit of nominal power
    dims: [scenario, snapshot, link]
  Link_efficiency:
    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:1498`)
    dims: [scenario, snapshot, link_output]
  Link_output_delay:
    description: snapshots a port's delivery lags its link's flow — PyPSA's `delay`, `delay2`, … read
      long, divided by the `snapshot_weightings.generators` value and rounded up in data prep; 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:52`)
    dims: [link_output]
    dtype: int
  Link_output_cyclic_delay:
    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
    dims: [link_output]
    dtype: bool
  Link_marginal_cost:
    description: cost of one unit of flow
    dims: [scenario, snapshot, link]
  Link_marginal_cost_quadratic:
    description: cost of the square of one unit of flow
    dims: [scenario, snapshot, link]
  Link_committable:
    description: whether flow is gated by an on/off status decision
    dims: [link]
    dtype: bool
  Process_rate:
    description: the energy a port draws or delivers per unit of internal power, PyPSA's `rate0`, `rate1`,
      … read long — negative where the port withdraws, positive where it injects; a link is a process
      whose `bus0` rate is minus one and whose output rates are its efficiencies. Read at the snapshot
      the transfer arrives, so a delayed port transfers at its arrival snapshot's rate (`constraints.py:1498`)
    dims: [scenario, snapshot, process_output]
  Process_output_delay:
    description: snapshots a port's transfer lags its process's internal power — PyPSA's `delay0`, `delay1`,
      … read long, divided by the `snapshot_weightings.generators` value and rounded up in data prep;
      zero for a port that transfers at once. A port has the same delay in every scenario, as a link's
      port has
    dims: [process_output]
    dtype: int
  Process_output_cyclic_delay:
    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
    dims: [process_output]
    dtype: bool
  Load_p_set:
    description: demand
    dims: [scenario, snapshot, load]
  Load_sign:
    description: the sign a load's demand enters its bus's balance with — PyPSA's `sign`, `-1` unless
      given, `1` for a load that feeds its bus. PyPSA refuses one that differs by scenario (`constants.py:43`)
    dims: [load]
  Load_active:
    description: whether a load stands in the model — PyPSA's `active`. A load has no build year and no
      lifetime, so the flag holds in every snapshot. PyPSA refuses one that differs by scenario (`constants.py:51`)
    dims: [load]
    dtype: bool
  scenario_weight:
    description: PyPSA's `scenario_weightings.weight` — the probability of a future
    dims: [scenario]
  period_weight_objective:
    description: PyPSA's `investment_period_weightings.objective` — what a period's cost weighs; PyPSA
      reads it only under `multi_investment_periods`, so data prep feeds one otherwise, whatever the column
      holds (`optimize.py:205-207`, `:264-266`)
    dims: [period]
  Generator_active:
    description: whether a generator stands in a snapshot's period — PyPSA's `active`, from build year
      and lifetime, data prep
    dims: [snapshot, generator]
    dtype: bool
  Link_active:
    description: whether a link stands in a snapshot's period — PyPSA's `active`, data prep
    dims: [snapshot, link]
    dtype: bool
  Process_active:
    description: whether a process stands in a snapshot's period — PyPSA's `active`, data prep
    dims: [snapshot, process]
    dtype: bool
variables:
  Generator_p:
    description: '`Generator-p` — output of a generator in a snapshot'
    dims: [scenario, snapshot, generator]
    where: Generator_active
  Link_p:
    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'
    dims: [scenario, snapshot, link]
    where: Link_active
  Generator_status:
    description: '`Generator-status` — how much of a committable unit is on: an integer the rows below
      cap at one, or at the module count where the build is modular'
    dims: [scenario, snapshot, generator]
    where: Generator_committed
    domain: integer
    bounds: {lower: 0}
  Generator_start_up:
    description: '`Generator-start_up` — how much of a committable unit turns on this snapshot, capped
      as the status is'
    dims: [scenario, snapshot, generator]
    where: Generator_committed
    domain: integer
    bounds: {lower: 0}
  Generator_shut_down:
    description: '`Generator-shut_down` — how much of a committable unit turns off this snapshot, capped
      as the status is'
    dims: [scenario, snapshot, generator]
    where: Generator_committed
    domain: integer
    bounds: {lower: 0}
  Process_p:
    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'
    dims: [scenario, snapshot, process]
    where: Process_active
constraints:
  Generator_fix_p_lower:
    description: '`Generator-fix-p-lower` — a fixed generator outputs at least its minimum'
    dims: [scenario, snapshot, generator]
    where: not Generator_p_nom_extendable AND not Generator_committable AND Generator_active
    expression: Generator_p >= Generator_p_min_pu * Generator_p_nom
  Generator_fix_p_upper:
    description: '`Generator-fix-p-upper` — a fixed generator outputs at most what is available'
    dims: [scenario, snapshot, generator]
    where: not Generator_p_nom_extendable AND not Generator_committable AND Generator_active
    expression: Generator_p <= Generator_p_max_pu * Generator_p_nom
  Link_fix_p_lower:
    description: '`Link-fix-p-lower` — a fixed link carries at least its minimum, negative for the other
      way'
    dims: [scenario, snapshot, link]
    where: not Link_p_nom_extendable AND not Link_committable AND Link_active
    expression: Link_p >= Link_p_min_pu * Link_p_nom
  Link_fix_p_upper:
    description: '`Link-fix-p-upper` — a fixed link carries at most its nominal power'
    dims: [scenario, snapshot, link]
    where: not Link_p_nom_extendable AND not Link_committable AND Link_active
    expression: Link_p <= Link_p_max_pu * Link_p_nom
  Generator_com_p_lower:
    description: '`Generator-com-p-lower` — a committed unit outputs at least its minimum; off, at least
      nothing'
    dims: [scenario, snapshot, generator]
    where: Generator_committed AND NOT Generator_p_nom_extendable AND NOT (Generator_p_nom_mod > 0)
    expression: Generator_p >= (Generator_p_min_pu * Generator_p_nom) * Generator_status
  Generator_com_p_upper:
    description: '`Generator-com-p-upper` — a committed unit outputs at most what is available; off, at
      most nothing'
    dims: [scenario, snapshot, generator]
    where: Generator_committed AND NOT Generator_p_nom_extendable AND NOT (Generator_p_nom_mod > 0)
    expression: Generator_p <= (Generator_p_max_pu * Generator_p_nom) * Generator_status
  Generator_com_transition_start_up:
    description: '`Generator-com-transition-start-up` — turning on is a start, counted against the state
      the unit carried into the snapshot'
    dims: [scenario, snapshot, generator]
    where: Generator_committed
    expression: Generator_start_up >= Generator_status - Generator_previous_status
  Generator_com_transition_shut_down:
    description: '`Generator-com-transition-shut-down` — turning off is a stop, counted against the state
      the unit carried into the snapshot'
    dims: [scenario, snapshot, generator]
    where: Generator_committed
    expression: Generator_shut_down >= Generator_previous_status - Generator_status
  Generator_com_up_time:
    description: '`Generator-com-up-time` — a unit started within its own minimum up time is still on.
      The first snapshot''s share of the window is the brought-in up time''s, which the must-stay-up mask
      carries'
    dims: [scenario, snapshot, generator]
    where: Generator_committed AND Generator_min_up_time > 0 AND position(snapshot) > 0
    expression: sum_back(Generator_start_up, along=snapshot, window=Generator_min_up_time) <= Generator_status
  Generator_status_p_fixed_upper:
    description: '`Generator-status-p-fixed-upper` — a status is at most the modules in place, an explicit
      row as PyPSA writes it: one where the build is not modular, and the fixed build''s whole count of
      modules where it is'
    dims: [scenario, snapshot, generator]
    where: Generator_committed AND NOT (Generator_p_nom_extendable AND Generator_p_nom_mod > 0)
    expression: Generator_status <= Generator_modules_installed
  Generator_start_up_p_fixed_upper:
    description: '`Generator-start_up-p-fixed-upper` — a start is at most the modules in place, an explicit
      row as PyPSA writes it: one where the build is not modular, and the fixed build''s whole count of
      modules where it is'
    dims: [scenario, snapshot, generator]
    where: Generator_committed AND NOT (Generator_p_nom_extendable AND Generator_p_nom_mod > 0)
    expression: Generator_start_up <= Generator_modules_installed
  Generator_shut_down_p_fixed_upper:
    description: '`Generator-shut_down-p-fixed-upper` — a stop is at most the modules in place, an explicit
      row as PyPSA writes it: one where the build is not modular, and the fixed build''s whole count of
      modules where it is'
    dims: [scenario, snapshot, generator]
    where: Generator_committed AND NOT (Generator_p_nom_extendable AND Generator_p_nom_mod > 0)
    expression: Generator_shut_down <= Generator_modules_installed
  Bus_nodal_balance:
    description: '`Bus-nodal_balance` — what is generated at a bus, storage dispatch and stores included,
      less what the links take away, plus what arrives over them after losses and any delay at every port
      they deliver to, each process port drawing or delivering at its own rate and each passive branch
      carrying its flow, meets the load there, less half of every incident line''s and transformer''s
      loss — 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:1404-1405`, `:1514`), and an
      inactive load not at all. A bus nothing is attached to has no row; PyPSA refuses one that carries
      load, and this file does not yet.'
    dims: [scenario, snapshot, bus]
    expression: Bus_injection == 0
expressions:
  Generator_previous_status:
    description: the commitment state a generator carries into a snapshot — off at the first snapshot
      it stands in past the first of the horizon, as PyPSA reads a status it did not build (`constraints.py:298`),
      and the state carried over otherwise
    dims: [scenario, snapshot, generator]
    cases:
      opening_late: {when: 'position(snapshot) > 0 AND NOT shift(Generator_active, along=snapshot, offset=1)',
        expression: 0}
    otherwise: Generator_status_carried_over
  Generator_status_carried_over:
    description: the state a generator carries over into a snapshot — the state it brought into the horizon
      at the first, the previous snapshot's after that
    dims: [scenario, snapshot, generator]
    cases:
      opening: {when: position(snapshot) == 0, expression: Generator_status_initial}
    otherwise: shift(Generator_status, along=snapshot, offset=1)
  Link_output_arrival:
    description: what a link delivers to an output port at a snapshot — its flow delayed by the port's
      `delay` within its investment period, times 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, and 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
    dims: [scenario, snapshot, link_output]
    cases:
      wrapping: {when: Link_output_cyclic_delay, expression: 'shift(at(Link_p, by=link_output[link]),
          along=snapshot, offset=Link_output_delay, edge=''wrap'', within=snapshot[period]) * Link_efficiency'}
    otherwise: shift(at(Link_p, by=link_output[link]), along=snapshot, offset=Link_output_delay,
      edge=0, within=snapshot[period]) * Link_efficiency
  Process_output_arrival:
    description: what a process transfers at a port at a snapshot — its internal power delayed by the
      port's `delay` within its investment period, times 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, and
      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
    dims: [scenario, snapshot, process_output]
    cases:
      wrapping: {when: Process_output_cyclic_delay, expression: 'shift(at(Process_p, by=process_output[process]),
          along=snapshot, offset=Process_output_delay, edge=''wrap'', within=snapshot[period])
          * Process_rate'}
    otherwise: shift(at(Process_p, by=process_output[process]), along=snapshot, offset=Process_output_delay,
      edge=0, within=snapshot[period]) * Process_rate
  Generator_opex: {expression: 'sum(sum(((Generator_p * Generator_marginal_cost) * snapshot_weightings_objective)
      * at(period_weight_objective, by=snapshot[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]), over=generator), over=snapshot)'}
  Generator_commitment_opex: {expression: 'sum(sum(((Generator_status * Generator_stand_by_cost) * snapshot_weightings_objective)
      * at(period_weight_objective, by=snapshot[period]), over=generator), over=snapshot) + sum(sum(Generator_start_up
      * Generator_start_up_cost, over=generator), over=snapshot) + sum(sum(Generator_shut_down * Generator_shut_down_cost,
      over=generator), over=snapshot)'}
  Link_opex: {expression: 'sum(sum(((Link_p * Link_marginal_cost) * snapshot_weightings_objective) * at(period_weight_objective,
      by=snapshot[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]), over=link),
      over=snapshot)'}
  scenario_opex:
    dims: [scenario]
    expression: (Generator_opex + Generator_commitment_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:415-432`)
  risk_weighted_opex: {expression: 'sum(scenario_weight * scenario_opex, over=scenario)'}
  total_cost:
    dims: []
    expression: risk_weighted_opex
    description: what the system costs — capacity once per active period at its expected cost over the
      scenarios, operation in expectation over the scenarios, and a share of it at the tail
  Load_demand:
    description: what a load draws from its bus's balance — its demand times its sign where it is active,
      nothing where it is not, since PyPSA drops an inactive load from the balance (`constraints.py:1513-1514`)
    dims: [scenario, snapshot, load]
    cases:
      active: {when: Load_active, expression: Load_sign * Load_p_set}
    otherwise: 0
  Generator_injection: {expression: 'sum(Generator_sign * Generator_p, over=generator, by=generator[bus])'}
  Link_injection: {expression: '-sum(Link_p, over=link, by=link[bus0]) + sum(Link_output_arrival,
      over=link_output, by=link_output[bus])'}
  Load_injection: {expression: 'sum(Load_demand, over=load, by=load[bus])'}
  Process_injection: {expression: 'sum(Process_output_arrival, over=process_output, by=process_output[bus])'}
  Bus_injection:
    dims: [scenario, snapshot, bus]
    expression: ((Generator_injection + Link_injection) + Load_injection) + Process_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
conditions:
  Generator_committed: {description: a committable generator that stands in the snapshot's period — every
      unit-commitment row's set, condition: Generator_committable AND Generator_active}
objective: {sense: minimize, expression: total_cost}

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


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

sources = {
    'snapshot': pl.Series('snapshot', list(timesteps(n)), dtype=pl.Datetime('us')),
    '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),
    'generator.bus': prop(n, 'Generator', 'bus'),
    'link.bus0': prop(n, 'Link', 'bus0'),
    'load.bus': prop(n, 'Load', 'bus'),
    'snapshot_weightings_objective': weighting(n, 'objective'),
    'Generator_sign': per_component('Generator', first_scenario(n.generators['sign'])),
    'Load_p_set': varying(n, 'Load', 'p_set'),
    'Load_sign': per_component('Load', first_scenario(loads['sign'])),
    'Load_active': per_component('Load', first_scenario(loads['active']), bool),
}

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

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

"""Rung 58: a committable unit takes its status rows in every scenario.

The two futures are identical, so the expected cost is the cost of the same
network without scenarios.
"""

from __future__ import annotations

import spine


def network():
    """The spine plus a cheap committable unit that cannot run below 40 % of its build."""
    n = spine.build()
    n.add(
        'Generator',
        'uc58',
        bus='north',
        committable=True,
        p_nom=50,
        marginal_cost=5,
        p_min_pu=0.4,
        min_up_time=2,
        up_time_before=0,
        start_up_cost=100,
    )
    n.add('Load', 'swing58', bus='north', p_set=[5, 45, 45, 10])
    return n


def build():
    """The same network over two identical futures."""
    n = network()
    n.set_scenarios({'calm': 0.6, 'stormy': 0.4})
    return n

n = build()
n.optimize(solver_name='highs')
n.objective  # 7430.0