Change default solver to scipy (#587)

tsmbland · web-flow · commit 4dc5f526b35c · 2024-12-03T10:56:16.000Z
* Change default solver to scipy

* Add warning if lpsolver is not specified

* Fix failing test

* Clearer documentation about default solver
diff --git a/docs/inputs/toml.rst b/docs/inputs/toml.rst
@@ -442,12 +442,12 @@ Sectors contain a number of subsections:
         are registered via :py:func:`~muse.investments.register_investment`. At time of
         writing, three are available:
 
+        - "scipy" solver (default from v1.3): Formulates investment as a true LP problem and solves it using
+          the `scipy solver`_.
+
         - an "adhoc" solver: Simple in-house solver that ranks the technologies
           according to cost and service the demand incrementally.
 
-        - "scipy" solver: Formulates investment as a true LP problem and solves it using
-          the `scipy solver`_.
-
         - "cvxopt" solver: Formulates investment as a true LP problem and solves it
           using the python package `cvxopt`_. `cvxopt`_ is *not* installed by default.
           Users can install it with ``pip install cvxopt`` or ``conda install cvxopt``.
diff --git a/docs/tutorial-code/add-agent/1-single-objective/settings.toml b/docs/tutorial-code/add-agent/1-single-objective/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/add-agent/2-multiple-objective/settings.toml b/docs/tutorial-code/add-agent/2-multiple-objective/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/add-correlation-demand/1-correlation/settings.toml b/docs/tutorial-code/add-correlation-demand/1-correlation/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/add-new-technology/1-introduction/settings.toml b/docs/tutorial-code/add-new-technology/1-introduction/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/add-new-technology/2-scenario/settings.toml b/docs/tutorial-code/add-new-technology/2-scenario/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/add-region/1-new-region/settings.toml b/docs/tutorial-code/add-region/1-new-region/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
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
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/carbon-budget/1-carbon-budget/settings.toml b/docs/tutorial-code/carbon-budget/1-carbon-budget/settings.toml
@@ -54,7 +54,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
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
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
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
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
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
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
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
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/docs/tutorial-code/new-decision-metric/settings.toml b/docs/tutorial-code/new-decision-metric/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/src/muse/agents/factories.py b/src/muse/agents/factories.py
@@ -303,7 +303,7 @@ def _standardize_inputs(
 
 def _standardize_investing_inputs(
     search_rules: Optional[Union[str, Sequence[str]]] = None,
-    investment: Union[Callable, str, Mapping] = "adhoc",
+    investment: Union[Callable, str, Mapping] = "scipy",
     constraints: Optional[
         Union[Callable, str, Mapping, Sequence[Union[str, Mapping]]]
     ] = None,
diff --git a/src/muse/data/example/default/settings.toml b/src/muse/data/example/default/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/src/muse/data/example/default_retro/settings.toml b/src/muse/data/example/default_retro/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.retro_and_new]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/src/muse/data/example/default_timeslice/settings.toml b/src/muse/data/example/default_timeslice/settings.toml
@@ -41,7 +41,7 @@ commodities_out = '{path}/technodata/residential/CommOut.csv'
 [sectors.residential.subsectors.all]
 agents = '{path}/technodata/Agents.csv'
 existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "adhoc"
+lpsolver = "scipy"  # Optional, defaults to "scipy"
 constraints = [
     # Optional, defaults to the constraints below
     "max_production",
diff --git a/src/muse/sectors/subsector.py b/src/muse/sectors/subsector.py
@@ -127,6 +127,8 @@ def factory(
         name: str = "subsector",
         timeslice_level: str | None = None,
     ) -> Subsector:
+        from logging import getLogger
+
         from muse import constraints as cs
         from muse import demand_share as ds
         from muse import investments as iv
@@ -139,6 +141,13 @@ def factory(
             msg = "Invalid parameter asset_threshhold. Did you mean asset_threshold?"
             raise ValueError(msg)
 
+        # Raise warning if lpsolver is not specified (PR #587)
+        if not hasattr(settings, "lpsolver"):
+            msg = (
+                f"lpsolver not specified for subsector '{name}'. Defaulting to 'scipy'"
+            )
+            getLogger(__name__).warning(msg)
+
         agents = agents_factory(
             settings.agents,
             settings.existing_capacity,
@@ -147,7 +156,7 @@ def factory(
             year=current_year or int(technologies.year.min()),
             asset_threshold=getattr(settings, "asset_threshold", 1e-12),
             # only used by self-investing agents
-            investment=getattr(settings, "lpsolver", "adhoc"),
+            investment=getattr(settings, "lpsolver", "scipy"),
             forecast=getattr(settings, "forecast", 5),
             constraints=getattr(settings, "constraints", ()),
             timeslice_level=timeslice_level,
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -362,6 +362,7 @@ def newcapa_agent(agent_args, technologies, stock) -> Agent:
 
 @fixture
 def retro_agent(agent_args, technologies, stock) -> Agent:
+    agent_args["investment"] = "adhoc"  # fails with scipy solver, see # 587
     return create_agent(agent_args, technologies, stock.capacity, "retrofit")
 
 
