Rung 48: a start and a stop cost what they cost — no snapshot weight and no period weight on them, over two weighted periods¶

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 that share is positive.
  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}
  bus: {description: network nodes}
  generator: {description: 'generating units, each on one bus'}
  load: {description: 'demands, each on one bus'}
  period: {description: investment periods — PyPSA's `investment_periods`, dtype: int}
relations:
  snapshot_period: {description: the investment period a snapshot falls in, key: snapshot, values: period}
  Generator_bus: {description: the bus a generator sits on, key: generator, values: bus}
  Load_bus: {description: the bus a load sits on, key: load, values: 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 (`consistency.py:1187`)
    dims: [generator]
  Generator_committable:
    description: whether output is gated by an on/off status decision
    dims: [generator]
    dtype: bool
  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
    dims: [scenario, generator]
  Generator_shut_down_cost:
    description: cost of one stop
    dims: [scenario, 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]
  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]
  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 (`consistency.py:1187`)
    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 (`consistency.py:1195`)
    dims: [load]
    dtype: bool
  scenario_weight:
    description: PyPSA's `scenario_weightings.weight` — the probability of a future
    dims: [scenario]
  CVaR_omega:
    description: PyPSA's `risk_preference['omega']` — the share of operating cost priced at the tail rather
      than in expectation; zero recovers the risk-neutral model
    dims: []
  period_weight_objective:
    description: PyPSA's `investment_period_weightings.objective` — what a period's cost weighs
    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
variables:
  Generator_p:
    description: '`Generator-p` — output of a generator in a snapshot'
    dims: [scenario, snapshot, generator]
    where: Generator_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_committable AND Generator_active
    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_committable AND Generator_active
    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_committable AND Generator_active
    domain: integer
    bounds: {lower: 0}
  CVaR_a:
    description: '`CVaR-a` — how far a scenario''s operating cost exceeds the tail''s start; nothing where
      it does not'
    dims: [scenario]
    bounds: {lower: 0}
  CVaR_theta:
    description: '`CVaR-theta` — where the tail starts, the value at risk'
    dims: []
  CVaR:
    description: '`CVaR` — the tail''s average cost, what the objective prices at `omega`'
    dims: []
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
  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_committable AND not Generator_p_nom_extendable AND Generator_active
    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_committable AND not Generator_p_nom_extendable AND Generator_active
    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_committable AND Generator_active
    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_committable AND Generator_active
    expression: Generator_shut_down >= Generator_previous_status - 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_committable AND NOT (Generator_p_nom_extendable AND Generator_p_nom_mod > 0) AND
      Generator_active
    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_committable AND NOT (Generator_p_nom_extendable AND Generator_p_nom_mod > 0) AND
      Generator_active
    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_committable AND NOT (Generator_p_nom_extendable AND Generator_p_nom_mod > 0) AND
      Generator_active
    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:1428-1429`, `:1538`), 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 — 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)
  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
  Bus_injection:
    dims: [scenario, snapshot, bus]
    expression: Generator_injection + Load_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
  risk_weighted_opex: {expression: '(1 - CVaR_omega) * sum(scenario_weight * scenario_opex, over=scenario)
      + CVaR_omega * CVaR'}
  Generator_injection: {expression: 'sum(Generator_sign * Generator_p, by=Generator_bus, over=generator,
      into=bus)'}
  Load_injection: {expression: 'sum(Load_demand, by=Load_bus, over=load, into=bus)'}
  scenario_opex:
    dims: [scenario]
    expression: Generator_opex + Generator_commitment_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:414-429`)
  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:1537-1538`)
    dims: [scenario, snapshot, load]
    cases:
      active: {when: Load_active, expression: Load_sign * Load_p_set}
    otherwise: 0
  Generator_opex: {expression: 'sum(sum(((Generator_p * Generator_marginal_cost) * snapshot_weightings_objective)
      * at(period_weight_objective, by=snapshot_period, over=period, into=snapshot), 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=period, into=snapshot), 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=period, into=snapshot), 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)'}
objective: {sense: minimize, expression: total_cost}

from differential.pypsa.prep import relation, 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),
        **carriers(n, multi),
    'Generator_bus': relation(n, 'Generator', 'bus'),
    'Load_bus': relation(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_48_unweighted_start_up.yaml', sources) as solution:
    solution.objective  # 7325.0

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

"""Rung 48: a start and a stop cost what they cost — no snapshot weight and no period weight on them, over two weighted periods."""

from __future__ import annotations

from datetime import datetime

import pandas as pd

OPTIMIZE = {'multi_investment_periods': True}


def build():
    """A whole network, not the spine: a committable peaker that starts and stops once in each period."""
    import pypsa

    n = pypsa.Network()
    n.snapshots = pd.MultiIndex.from_tuples(
        [(2020, datetime(2020, 1, 1, t)) for t in range(3)] + [(2030, datetime(2030, 1, 1, t)) for t in range(3)]
    )
    n.investment_periods = [2020, 2030]
    n.investment_period_weightings['objective'] = [1.0, 0.5]
    n.investment_period_weightings['years'] = [10.0, 10.0]
    n.snapshot_weightings['objective'] = [2.0, 1.5, 2.5, 2.0, 1.5, 2.5]
    n.add('Bus', 'grid')
    n.add('Generator', 'base48', bus='grid', p_nom=60, marginal_cost=10)
    n.add('Generator', 'dear48', bus='grid', p_nom=100, marginal_cost=90)
    n.add(
        'Generator',
        'peak48',
        bus='grid',
        p_nom=50,
        marginal_cost=20,
        committable=True,
        p_min_pu=0.4,
        start_up_cost=300,
        shut_down_cost=100,
        up_time_before=0,
    )
    n.add('Load', 'town48', bus='grid', p_set=[50, 100, 50, 50, 100, 50])
    return n

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