Merge branch 'main' into test_seed

tsmbland · web-flow · commit bfce36325614 · 2025-03-18T13:04:49.000Z
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,7 +9,7 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.10
+    rev: v0.11.0
     hooks:
       - id: ruff-format
         types_or: [python, pyi, jupyter]
diff --git a/docs/inputs/toml.rst b/docs/inputs/toml.rst
@@ -25,7 +25,6 @@ a whole.
 
    time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
    regions = ["USA"]
-   interest_rate = 0.1
    interpolation_mode = 'linear'
    log_level = 'info'
 
diff --git a/docs/tutorial-code/add-agent/1-single-objective/settings.toml b/docs/tutorial-code/add-agent/1-single-objective/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/add-agent/2-multiple-objective/settings.toml b/docs/tutorial-code/add-agent/2-multiple-objective/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/add-correlation-demand/1-correlation/settings.toml b/docs/tutorial-code/add-correlation-demand/1-correlation/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/add-new-technology/1-introduction/settings.toml b/docs/tutorial-code/add-new-technology/1-introduction/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind", "solar"]
diff --git a/docs/tutorial-code/add-new-technology/2-scenario/settings.toml b/docs/tutorial-code/add-new-technology/2-scenario/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind", "solar"]
diff --git a/docs/tutorial-code/add-region/1-new-region/settings.toml b/docs/tutorial-code/add-region/1-new-region/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1", "R2"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/add-service-demand/1-exogenous-demand/settings.toml b/docs/tutorial-code/add-service-demand/1-exogenous-demand/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/carbon-budget/1-carbon-budget/settings.toml b/docs/tutorial-code/carbon-budget/1-carbon-budget/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/min-max-timeslice-constraints/1-min-constraint/settings.toml b/docs/tutorial-code/min-max-timeslice-constraints/1-min-constraint/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/min-max-timeslice-constraints/2-max-constraint/settings.toml b/docs/tutorial-code/min-max-timeslice-constraints/2-max-constraint/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/modify-timing-data/1-modify-timeslices/settings.toml b/docs/tutorial-code/modify-timing-data/1-modify-timeslices/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/modify-timing-data/2-modify-time-framework/settings.toml b/docs/tutorial-code/modify-timing-data/2-modify-time-framework/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2022, 2024, 2026, 2028, 2030, 2032, 2034, 2036, 2038, 2040]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/docs/tutorial-code/new-decision-metric/settings.toml b/docs/tutorial-code/new-decision-metric/settings.toml
@@ -2,7 +2,6 @@ plugins = "{path}/new_decision.py"
 # Global settings - most REQUIRED
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind", "solar"]
diff --git a/src/muse/costs.py b/src/muse/costs.py
@@ -528,16 +528,23 @@ def capital_recovery_factor(technologies: xr.Dataset) -> xr.DataArray:
     .. _capital recovery factor:
         https://www.homerenergy.com/products/pro/docs/3.15/capital_recovery_factor.html
 
+    If the interest rate is zero, this simplifies to 1 / nyears
+
     Arguments:
         technologies: All the technologies
 
     Return:
         xr.DataArray with the CRF calculated for the relevant technologies
     """
     nyears = technologies.technical_life.astype(int)
-    crf = technologies.interest_rate / (
-        1 - (1 / (1 + technologies.interest_rate) ** nyears)
+    interest_rate = technologies.interest_rate
+
+    crf = xr.where(
+        interest_rate == 0,
+        1 / nyears,
+        interest_rate / (1 - (1 / (1 + interest_rate) ** nyears)),
     )
+
     assert "year" not in crf.dims
     return crf
 
diff --git a/src/muse/data/default_settings.toml b/src/muse/data/default_settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = 'REQUIRED'
 regions = 'REQUIRED'
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 # Convergence parameters
diff --git a/src/muse/data/example/default/settings.toml b/src/muse/data/example/default/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/src/muse/data/example/default_retro/settings.toml b/src/muse/data/example/default_retro/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/src/muse/data/example/default_timeslice/settings.toml b/src/muse/data/example/default_timeslice/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/src/muse/data/example/minimum_service/settings.toml b/src/muse/data/example/minimum_service/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2010, 2015, 2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["fuel1", "fuel2", "fuel3"]
diff --git a/src/muse/data/example/trade/settings.toml b/src/muse/data/example/trade/settings.toml
@@ -2,7 +2,6 @@
 
 time_framework = [2020, 2025, 2030, 2035]
 regions = ["R1", "R2"]
-interest_rate = 0.1
 interpolation_mode = 'linear'
 log_level = 'info'
 excluded_commodities = ["wind"]
diff --git a/src/muse/mca.py b/src/muse/mca.py
@@ -79,7 +79,6 @@ def factory(cls, settings: str | Path | Mapping | Any) -> MCA:
 
         extras = {
             "regions",
-            "interest_rate",
             "log_level",
             "interpolation_mode",
             "timeslices",
@@ -94,14 +93,16 @@ def factory(cls, settings: str | Path | Mapping | Any) -> MCA:
             if not hasattr(v, "_asdict") and k not in extras
         }
 
-        # Legacy: warn user about deprecation of "foresight" parameter (#641)
-        if "foresight" in global_kw:
-            msg = (
-                "The `foresight` parameter has been deprecated. "
-                "Please remove from your settings file."
-            )
-            getLogger(__name__).warning(msg)
-            global_kw.pop("foresight")
+        # Legacy: warn user about deprecated parameters (#641, #679)
+        deprecated_params = ["foresight", "interest_rate"]
+        for param in deprecated_params:
+            if param in global_kw:
+                msg = (
+                    f"The `{param}` parameter has been deprecated. "
+                    "Please remove it from your settings file."
+                )
+                getLogger(__name__).warning(msg)
+                global_kw.pop(param)
 
         carbon_kw = {
             k: v._asdict() if hasattr(v, "_asdict") else v
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -493,7 +493,6 @@ def drop_optionals(settings):
     required = {
         "time_framework": [2010, 2015, 2020],
         "regions": ["MEX"],
-        "interest_rate": 0.1,
         "equilibrium": False,
         "maximum_iterations": 3,
         "tolerance": 0.1,
diff --git a/tests/test_costs.py b/tests/test_costs.py
@@ -1,4 +1,4 @@
-from numpy import isclose
+from numpy import isclose, isfinite
 from pytest import fixture, mark, raises
 
 YEAR = 2030
@@ -187,6 +187,11 @@ def test_capital_recovery_factor(_technologies):
     assert set(result.dims) == set(_technologies.interest_rate.dims)
     # {"region", "technology"}
 
+    # Make sure zero interest rates are supported
+    _technologies["interest_rate"] = 0
+    result = capital_recovery_factor(_technologies)
+    assert isfinite(result).all()
+
 
 def test_annual_to_lifetime(_technologies, _prices, _consumption):
     from muse.costs import annual_to_lifetime, fuel_costs
