Skip to content

Commit 6fe3ebe

Browse files
committed
Clarify docstrings about forecast year vs investment year
1 parent d0fb46f commit 6fe3ebe

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

src/muse/carbon_budget.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ def fitting(
103103
Returns:
104104
new_price: adjusted carbon price to meet budget
105105
"""
106-
# Calculate the carbon price and emissions threshold in the forecast year
106+
# Calculate the carbon price and emissions threshold in the investment year
107107
future = market.year[-1]
108108
threshold = carbon_budget.sel(year=future).values.item()
109109
price = market.prices.sel(year=future, commodity=commodities).mean().values.item()

src/muse/demand_share.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def new_and_retro(
140140
r"""Splits demand across new and retro agents.
141141
142142
The input demand is split amongst both *new* and *retrofit* agents. *New* agents get
143-
a share of the increase in demand for the forecast year, whereas *retrofit* agents
143+
a share of the increase in demand for the investment year, whereas *retrofit* agents
144144
are assigned a share of the demand that occurs from decommissioned assets.
145145
146146
Args:
@@ -203,7 +203,7 @@ def new_and_retro(
203203
+ R_{c, s}^r
204204
205205
In other words, it is the share of the forecasted consumption that is serviced
206-
neither by the current assets still present in the forecast year, nor by the
206+
neither by the current assets still present in the investment year, nor by the
207207
*new* agent.
208208
209209
#. then each *new* agent gets a share of :math:`N` proportional to it's
@@ -353,7 +353,7 @@ def standard_demand(
353353
r"""Splits demand across new agents.
354354
355355
The input demand is split amongst *new* agents. *New* agents get a
356-
share of the increase in demand for the forecast years, as well as the demand that
356+
share of the increase in demand for the investment year, as well as the demand that
357357
occurs from decommissioned assets.
358358
359359
Args:
@@ -621,7 +621,7 @@ def new_consumption(
621621
future_market = market.sel(year=investment_year, drop=True)
622622
future_capacity = capacity.sel(year=investment_year)
623623

624-
# Calculate the increase in consumption over the forecast period
624+
# Calculate the increase in consumption over the investment period
625625
delta = (future_market.consumption - current_market.consumption).clip(min=0)
626626
missing = unmet_demand(
627627
market=future_market,
@@ -642,7 +642,7 @@ def new_and_retro_demands(
642642
) -> xr.Dataset:
643643
"""Splits demand into *new* and *retrofit* demand.
644644
645-
The demand (.i.e. `market.consumption`) in the forecast year is split three ways:
645+
The demand (.i.e. `market.consumption`) in the investment year is split three ways:
646646
647647
#. the demand that can be serviced by the assets that will still be operational that
648648
year.

0 commit comments

Comments
 (0)