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.

Sign up for GitHub

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

Add functionality in tools.costs to specify cost reduction scenarios and values #255

Merged
merged 15 commits into from
Dec 3, 2024
Merged

Add functionality in tools.costs to specify cost reduction scenarios and values #255

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f08dfa0
Add functionality to customize cost reduction rates within modules
measrainsey Nov 27, 2024
94684eb
Add test data for customizing cost reductions in materials module
measrainsey Nov 27, 2024
6cc856c
Remove test for get_cost_reduction_data() because function has been r…
measrainsey Nov 27, 2024
0e3ba63
Remove pytest parameterization for test_get_cost_reduction_data()
measrainsey Nov 27, 2024
349c8ee
Edit to pass linting
measrainsey Nov 27, 2024
cce5071
Add `else` statement for non-energy modules without custom files
measrainsey Nov 27, 2024
45381dd
Modify if-else statements for reading in custom files
measrainsey Nov 27, 2024
89f7b3d
Fix check for if files exist
measrainsey Nov 27, 2024
9d33ffc
Add docstrings for new functions
measrainsey Nov 27, 2024
68a1d3b
Add PR #255 to doc/whatsnew
measrainsey Nov 27, 2024
5fe759e
Add type hints
measrainsey Dec 2, 2024
7945323
Add tests for `_get_module_cost_reduction()` and `_get_module_scenari…
measrainsey Dec 2, 2024
80a530d
Remove dummy data for materials module
measrainsey Dec 2, 2024
8ed0523
Change type hint for `module` from string to Literal
measrainsey Dec 2, 2024
5993c55
Add type hints for technology sets
measrainsey Dec 3, 2024
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
3 changes: 2 additions & 1 deletion doc/whatsnew.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Next release
- Expand :doc:`repro` with sections on :ref:`repro-doc` and :ref:`versioning`, including :ref:`a list of external model names and ‘versions’ <model-names>` like “MESSAGEix-GLOBIOM 2.0” (:issue:`224`, :pull:`226`).
- Update :doc:`/transport/index` (:pull:`213`).
- Add "LED", "SSP4", and "SSP5" as values for the :program:`--ssp=…` option in :func:`.common_params` (:pull:`233`).
- Fix and update :doc:`/api/tools-costs` (:pull:`219`, :pull:`206`, :pull:`221`, :pull:`227`, :pull:`222`)
- Fix and update :doc:`/api/tools-costs` (:pull:`219`, :pull:`206`, :pull:`221`, :pull:`227`, :pull:`222`, :pull:`255`)

- Fix naming of GDP and population columns in SSP data aggregation (:pull:`219`).
- Edit inputs for storage, CSP, hydrogen, and industry technologies (:pull:`206`).
Expand All @@ -24,6 +24,7 @@ Next release
- Reconfigure use and implementation of technology variants/modules to be more agnostic (:pull:`221`).
- Change cost decay to reach reduction percentage specified on the year 2100 (:pull:`227`).
- Add `cooling` technology variant/module (:pull:`222`).
- Add functionality to specify cost reduction values and cost reduction scenarios in a module (:pull:`255`).
- Improve and extend :doc:`/material/index` (:pull:`218`, :pull:`253`).

- Release of MESSAGEix-Materials 1.1.0 (:doc:`/material/v1.1.0`).
Expand Down
7 changes: 7 additions & 0 deletions message_ix_models/data/costs/materials/cost_reduction.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Cost reduction in 2100,,,,,,
# ,,,,,,
# Units: % ,,,,,,
message_technology,technology_type,very_low,low,medium,high,very_high
furnace_coal_cement,Materials,0.23,0.24,0.25,0.26,0.27
gas_ct,Gas/Oil,0.99,0.99,0.99,0.99,0.99
bio_hpl,Materials,0.77,0.77,0.77,0.77,0.77
5 changes: 5 additions & 0 deletions message_ix_models/data/costs/materials/scenarios_reduction.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
message_technology,SSP1,SSP2,SSP3,SSP4,SSP5,LED
furnace_coal_cement,low,low,low,low,low,low
manuf_steel,medium,medium,medium,medium,medium,medium
hp_elec_refining,high,high,high,high,high,high
bio_hpl,very_low,very_low,very_low,very_low,very_low,very_low
21 changes: 0 additions & 21 deletions message_ix_models/tests/tools/costs/test_decay.py
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhat strange to remove tests, but we seem to cover all lines touched by the PR even without it. Is there truly no need for this unit test any longer?
Even if this function is only ever called by another function, a unit test runs faster than the whole exterior function and grants confidence when debugging the code that this particular part still works or pinpoints the failure.
If it's not too much work, I think I'd like to see the test adjusted rather than removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the test for get_cost_reduction_data() because the function was completely removed/replaced, but I now added new tests for the two new functions: _get_module_scenarios_reduction() and _get_module_cost_reduction()

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

from message_ix_models.tools.costs import Config
from message_ix_models.tools.costs.decay import (
get_cost_reduction_data,
get_technology_reduction_scenarios_data,
project_ref_region_inv_costs_using_reduction_rates,
)
Expand All @@ -13,26 +12,6 @@
)


@pytest.mark.parametrize(
"module, t_exp",
(
("energy", {"coal_ppl", "gas_ppl", "gas_cc", "solar_res1"}),
("materials", {"biomass_NH3", "MTO_petro", "furnace_foil_steel"}),
("cooling", {"coal_ppl__cl_fresh", "gas_cc__air", "nuc_lc__ot_fresh"}),
),
)
def test_get_cost_reduction_data(module: str, t_exp) -> None:
# The function runs without error
result = get_cost_reduction_data(module)

# Expected MESSAGEix-GLOBIOM technologies are present in the data
assert t_exp <= set(result.message_technology.unique())

# Values of the "cost reduction" columns are between 0 and 1
stats = result.cost_reduction.describe()
assert 0 <= stats["min"] and stats["max"] <= 1


@pytest.mark.parametrize("module", ("energy", "materials", "cooling"))
def test_get_technology_reduction_scenarios_data(module: str) -> None:
config = Config()
Expand Down
Loading
Loading