Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calculate CapitalInvestment using discount rate with/without technology index #213

Merged
merged 5 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Changelog
(Development) Version 1.1.3
===========================
- Lock pandas to 2.1.4 or later
- Capital Investment result calculation fixed

Version 1.1.2
=============
Expand Down
54 changes: 36 additions & 18 deletions src/otoole/results/result_package.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,11 @@ def capital_investment(self) -> pd.DataFrame:
capital_cost = self["CapitalCost"]
new_capacity = self["NewCapacity"]
operational_life = self["OperationalLife"]
discount_rate = self["DiscountRate"]
discount_rate_idv = self["DiscountRateIdv"]

if "DiscountRateIdv" in self.keys():
discount_rate = self["DiscountRateIdv"]
else:
discount_rate = self["DiscountRate"]

regions = self["REGION"]["VALUE"].to_list()
technologies = self.get_unique_values_from_index(
Expand All @@ -323,10 +326,9 @@ def capital_investment(self) -> pd.DataFrame:
raise KeyError(self._msg("CapitalInvestment", str(ex)))

crf = capital_recovery_factor(
regions, technologies, discount_rate_idv, operational_life
regions, technologies, discount_rate, operational_life
)
pva = pv_annuity(regions, technologies, discount_rate, operational_life)

capital_investment = capital_cost.mul(new_capacity, fill_value=0.0)
capital_investment = capital_investment.mul(crf, fill_value=0.0).mul(
pva, fill_value=0.0
Expand Down Expand Up @@ -765,22 +767,38 @@ def capital_recovery_factor(
param CapitalRecoveryFactor{r in REGION, t in TECHNOLOGY} :=
(1 - (1 + DiscountRateIdv[r,t])^(-1))/(1 - (1 + DiscountRateIdv[r,t])^(-(OperationalLife[r,t])));
"""
if regions and technologies:
index = pd.MultiIndex.from_product(
[regions, technologies], names=["REGION", "TECHNOLOGY"]
)

def calc_crf(df, operational_life):
willu47 marked this conversation as resolved.
Show resolved Hide resolved
rate = df["VALUE"] + 1
numerator = 1 - rate.pow(-1)
denominator = 1 - rate.pow(-operational_life)

return numerator / denominator

if not regions and not technologies:
return pd.DataFrame(
data=[],
columns=["REGION", "TECHNOLOGY", "VALUE"],
).set_index(["REGION", "TECHNOLOGY"])

index = pd.MultiIndex.from_product(
[regions, technologies], names=["REGION", "TECHNOLOGY"]
)
if "TECHNOLOGY" in discount_rate_idv.index.names:
crf = discount_rate_idv.reindex(index)
crf["RATE"] = crf["VALUE"] + 1
crf["NUMER"] = 1 - crf["RATE"].pow(-1)
crf["DENOM"] = 1 - crf["RATE"].pow(-operational_life["VALUE"])
crf["VALUE"] = (crf["NUMER"] / crf["DENOM"]).round(6)
return crf.reset_index()[["REGION", "TECHNOLOGY", "VALUE"]].set_index(
["REGION", "TECHNOLOGY"]
)
crf["VALUE"] = calc_crf(crf, operational_life["VALUE"])

else:
return pd.DataFrame([], columns=["REGION", "TECHNOLOGY", "VALUE"]).set_index(
["REGION", "TECHNOLOGY"]
)
values = discount_rate_idv["VALUE"].copy()
crf = discount_rate_idv.reindex(index)
# This is a hack to get around the fact that the discount rate is
# indexed by REGION and not REGION, TECHNOLOGY
crf[::1] = values
willu47 marked this conversation as resolved.
Show resolved Hide resolved
crf["VALUE"] = calc_crf(crf, operational_life["VALUE"])

return crf.reset_index()[["REGION", "TECHNOLOGY", "VALUE"]].set_index(
["REGION", "TECHNOLOGY"]
)


def pv_annuity(
Expand Down
18 changes: 18 additions & 0 deletions tests/results/test_results_package.py
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,24 @@ def test_crf_null(self, discount_rate_idv, operational_life):

assert_frame_equal(actual, expected)

def test_crf_no_tech_discount_rate(self, region, discount_rate, operational_life):

technologies = ["GAS_EXTRACTION", "DUMMY"]
regions = region["VALUE"].to_list()
actual = capital_recovery_factor(
regions, technologies, discount_rate, operational_life
)

expected = pd.DataFrame(
data=[
["SIMPLICITY", "GAS_EXTRACTION", 0.5121951219512197],
["SIMPLICITY", "DUMMY", 0.34972244250594786],
],
columns=["REGION", "TECHNOLOGY", "VALUE"],
).set_index(["REGION", "TECHNOLOGY"])

assert_frame_equal(actual, expected)


class TestPvAnnuity:
def test_pva(self, region, discount_rate, operational_life):
Expand Down
Loading