Add warning about deprecated parameter

Author: tsmbland

docs/user-guide/modify-timing-data.ipynb

@@ -137,7 +137,7 @@
    "source": [
     "For the previous examples, we have run the scenario from 2020 to 2050, in 5 year time steps per benchmark year. However, we may want to run a more detailed scenario, with 2 year time steps, and up until the year 2040.\n",
     "\n",
-    "We will make this change by modifying the current model. Firstly, we need to change the first two lines of the `settings.toml` file, as follows:"
+    "We will make this change by modifying the current model. Firstly, we need to change the time framework defined in `settings.toml` file, as follows:"
    ]
   },
   {
@@ -146,16 +146,13 @@
    "source": [
     "```toml\n",
     "time_framework = [2020, 2022, 2024, 2026, 2028, 2030, 2032, 2034, 2036, 2038, 2040]\n",
-    "foresight = 2\n",
     "```"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The `time_framework` details each benchmark year in which we run the simulation. The ```foresight``` variable details how much foresight an agent has when making investments. \n",
-    "\n",
     "We also have to modity the `forecast` value for each sector. For example, for the power sector the `sectors.power.subsectors.all` section should now look as follows:\n",
     "\n",
     "```toml\n",

src/muse/mca.py

@@ -76,7 +76,6 @@ def factory(cls, settings: str | Path | Mapping | Any) -> MCA:
         )
 
         extras = {
-            "foresight",  # legacy
             "regions",
             "interest_rate",
             "log_level",
@@ -92,8 +91,16 @@ def factory(cls, settings: str | Path | Mapping | Any) -> MCA:
             for k, v in settings._asdict().items()
             if not hasattr(v, "_asdict") and k not in extras
         }
-        if "equilibrium" in global_kw:
-            global_kw["equilibrium"] = global_kw.pop("equilibrium")
+
+        # 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")
+
         carbon_kw = {
             k: v._asdict() if hasattr(v, "_asdict") else v
             for k, v in settings.carbon_budget_control._asdict().items()