Remove foresight parameter

Author: tsmbland

docs/tutorial-code/modify-timing-data/generate_models.py

@@ -80,7 +80,6 @@ def generate_model_2():
     settings_file = model_path / "settings.toml"
     time_framework = [2020, 2022, 2024, 2026, 2028, 2030, 2032, 2034, 2036, 2038, 2040]
     modify_toml(settings_file, lambda x: x.update({"time_framework": time_framework}))
-    modify_toml(settings_file, lambda x: x.update({"foresight": 2}))
     for sector in get_sectors(model_path):
         modify_toml(
             settings_file,

src/muse/mca.py

@@ -76,7 +76,7 @@ def factory(cls, settings: str | Path | Mapping | Any) -> MCA:
         )
 
         extras = {
-            "foresight",
+            "foresight",  # legacy
             "regions",
             "interest_rate",
             "log_level",

src/muse/readers/toml.py

@@ -394,6 +394,9 @@ def read_settings(
     setup_module(settings)
     settings.pop("timeslices", None)
 
+    # Set up time framework
+    settings["time_framework"] = np.array(sorted(settings["time_framework"]), dtype=int)
+
     # Finally, we run some checks to make sure all makes sense and files exist.
     validate_settings(settings)
 
@@ -554,27 +557,6 @@ def check_budget_parameters(settings: dict) -> None:
         settings["carbon_budget_control"]["budget"] = xr.DataArray([])
 
 
-@register_settings_check(vary_name=False)
-def check_foresight(settings: dict) -> None:
-    """Check that foresight is a multiple of the smaller time_framework difference.
-
-    If so, we update the time framework adding the foresight year to the list and
-    transforming it into an array
-    """
-    tfmin = np.diff(settings["time_framework"]).min()
-    msg = "ERROR - foresight is not a multiple of the smaller time_framework difference"
-    assert settings["foresight"] % tfmin == 0, msg
-
-    settings["time_framework"].sort()
-
-    # This adds to the years list a new year separated from the last one a “foresight”
-    # number of years.
-    settings["time_framework"].append(
-        settings["time_framework"][-1] + settings["foresight"]
-    )
-    settings["time_framework"] = np.array(settings["time_framework"], dtype=int)
-
-
 @register_settings_check(vary_name=False)
 def check_iteration_control(settings: dict) -> None:
     """Checks the variables related to the control of the iterations.

tests/conftest.py

@@ -484,7 +484,6 @@ def drop_optionals(settings):
 
     required = {
         "time_framework": [2010, 2015, 2020],
-        "foresight": 10,
         "regions": ["MEX"],
         "interest_rate": 0.1,
         "equilibrium": False,

tests/test_readers.py

@@ -97,13 +97,6 @@ def test_check_budget_parameters(settings: dict):
     check_budget_parameters(settings)
 
 
-def test_check_foresight(settings: dict):
-    """Tests the check_budget_parameters function."""
-    from muse.readers.toml import check_foresight
-
-    check_foresight(settings)
-
-
 def test_check_global_data_files(settings: dict, user_data_files):
     """Tests the check_global_data_files function."""
     from muse.readers.toml import check_global_data_files