Update examples and tutorials to not use retrofit agents

.vscode/launch.json

@@ -11,6 +11,13 @@
             "module": "muse",
             "args": ["--model", "default"]
         },
+        {
+            "name": "Model: default_retro",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "muse",
+            "args": ["--model", "default_retro"]
+        },
         {
             "name": "Model: multiple_agents",
             "type": "debugpy",

docs/advanced-guide/extending-muse.ipynb

@@ -169,7 +169,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Next, we  first copy the default model provided with muse to a local subfolder called \"model\". Then we read the `settings.toml` file and modify it using python. You may prefer to modify the `settings.toml` file using your favorite text editor. However, modifying the file programmatically allows us to\n",
+    "Next, we  first copy the `default_retro` model provided with muse to a local subfolder called \"model\". Then we read the `settings.toml` file and modify it using python. You may prefer to modify the `settings.toml` file using your favorite text editor. However, modifying the file programmatically allows us to\n",
     "routinely run this notebook as part of MUSE's test suite and check that the tutorial it is still up\n",
     "to date."
    ]
@@ -185,7 +185,7 @@
     "from muse import examples\n",
     "from toml import dump, load\n",
     "\n",
-    "model_path = examples.copy_model(overwrite=True)\n",
+    "model_path = examples.copy_model(name=\"default_retro\", overwrite=True)\n",
     "settings = load(model_path / \"settings.toml\")\n",
     "new_output = {\n",
     "    \"quantity\": \"consumption_zero\",\n",
@@ -204,7 +204,7 @@
    "source": [
     "We can now run the simulation. There are two ways to do this. From the command-line, where we can do:\n",
     "\n",
-    "    python3 -m muse data/commercial/modified_settings.toml \n",
+    "    python3 -m muse model/modified_settings.toml \n",
     "\n",
     "(note that slashes may be the other way on Windows). Or directly from the notebook:"
    ]
@@ -366,7 +366,7 @@
     "from muse import examples\n",
     "from toml import dump, load\n",
     "\n",
-    "model_path = examples.copy_model(overwrite=True)\n",
+    "model_path = examples.copy_model(name=\"default_retro\", overwrite=True)\n",
     "settings = load(model_path / \"settings.toml\")\n",
     "new_output = {\n",
     "    \"quantity\": \"capacity\",\n",
@@ -509,7 +509,7 @@
     "from muse import examples\n",
     "from toml import dump, load\n",
     "\n",
-    "model_path = examples.copy_model(overwrite=True)\n",
+    "model_path = examples.copy_model(name=\"default_retro\", overwrite=True)\n",
     "settings = load(model_path / \"settings.toml\")\n",
     "settings[\"sectors\"][\"residential\"][\"outputs\"] = [\n",
     "    {\n",

docs/advanced-guide/further-extending-muse.ipynb

@@ -217,7 +217,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.18"
+   "version": "3.12.3"
   },
   "vscode": {
    "interpreter": {

docs/example-output.ipynb

@@ -33,7 +33,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.18"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

docs/inputs/toml.rst

@@ -70,7 +70,7 @@ a whole.
    whether equilibrium of `demand` or `prices` should be sought. Defaults to `demand`.
 
 *maximum_iterations*
-   Maximum number of iterations when searching for equilibrium. Defaults to 3.
+   Maximum number of iterations when searching for equilibrium. Defaults to 100.
 
 *tolerance*
    Tolerance criteria when checking for equilibrium. Defaults to 0.1. 0.1 signifies that 10% of a deviation is allowed among the iterative value of either demand or price over a year per region.

docs/running-muse-example.ipynb

@@ -212,7 +212,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In this toy example, we can see that the end-use technology of choice in the residential sector becomes a heatpump. The heatpump displaces the gas boiler. Therefore, the supply of gas crashes due to a reduced demand. To account for the increase in demand for electricity, the agent invests heavily in wind turbines.\n",
+    "In this toy example, we can see that the end-use technology of choice in the residential sector becomes a heatpump, which displaces the gas boiler. To account for the increase in demand for electricity, the agent invests heavily in wind turbines.\n",
     "\n",
     "Note, that the units are in petajoules (PJ). MUSE requires consistent units across each of the sectors, and each of the input files (which we will see later). The model does not make any unit conversion internally."
    ]

docs/tutorial-code/0-new-decision-metric/Results/MCACapacity.csv

@@ -1,63 +1,56 @@
 ,agent,capacity,dst_region,index,installed,region,sector,technology,type,year
-2,A1,10.00000000000,R1,0,2020,R1,residential,gasboiler,retrofit,2020
-0,A1,1.00000000000,R1,0,2020,R1,power,gasCCGT,retrofit,2020
-0,A1,15.00000000000,R1,0,2020,R1,gas,gassupply1,retrofit,2020
-2,A1,5.00000000000,R1,0,2020,R1,residential,gasboiler,retrofit,2025
-7,A1,19.00000000000,R1,16,2020,R1,residential,heatpump,retrofit,2025
-2,A1,1.00000000000,R1,0,2020,R1,power,gasCCGT,retrofit,2025
-12,A1,10.00000000000,R1,22,2020,R1,power,solarPV,retrofit,2025
-25,A1,6.75000000000,R1,44,2020,R1,power,windturbine,retrofit,2025
-2,A1,15.00000000000,R1,0,2020,R1,gas,gassupply1,retrofit,2025
-2,A1,4.10000000000,R1,0,2025,R1,residential,gasboiler,retrofit,2030
-6,A1,19.00000000000,R1,8,2020,R1,residential,heatpump,retrofit,2030
-7,A1,6.90000000000,R1,9,2025,R1,residential,heatpump,retrofit,2030
-0,A1,3.00000000000,R1,0,2025,R1,power,gasCCGT,retrofit,2030
-11,A1,10.00000000000,R1,12,2020,R1,power,solarPV,retrofit,2030
-12,A1,2.40000000000,R1,13,2025,R1,power,solarPV,retrofit,2030
-31,A1,6.75000000000,R1,48,2020,R1,power,windturbine,retrofit,2030
-0,A1,7.50000000000,R1,0,2020,R1,gas,gassupply1,retrofit,2030
-1,A1,2.79440000000,R1,1,2025,R1,gas,gassupply1,retrofit,2030
-2,A1,4.10000000000,R1,0,2025,R1,residential,gasboiler,retrofit,2035
-8,A1,6.90000000000,R1,14,2025,R1,residential,heatpump,retrofit,2035
-9,A1,25.00000000000,R1,15,2030,R1,residential,heatpump,retrofit,2035
-0,A1,3.00000000000,R1,0,2025,R1,power,gasCCGT,retrofit,2035
-10,A1,10.00000000000,R1,11,2020,R1,power,solarPV,retrofit,2035
-11,A1,2.40000000000,R1,12,2025,R1,power,solarPV,retrofit,2035
-12,A1,6.00000000000,R1,13,2030,R1,power,solarPV,retrofit,2035
-37,A1,6.75000000000,R1,55,2020,R1,power,windturbine,retrofit,2035
-0,A1,2.79440000000,R1,0,2025,R1,gas,gassupply1,retrofit,2035
-1,A1,7.50000000000,R1,1,2030,R1,gas,gassupply1,retrofit,2035
-2,A1,0.91000000000,R1,0,2035,R1,residential,gasboiler,retrofit,2040
-6,A1,25.00000000000,R1,7,2030,R1,residential,heatpump,retrofit,2040
-7,A1,16.09000000000,R1,8,2035,R1,residential,heatpump,retrofit,2040
-0,A1,3.00000000000,R1,0,2025,R1,power,gasCCGT,retrofit,2040
-9,A1,10.00000000000,R1,12,2020,R1,power,solarPV,retrofit,2040
-10,A1,2.40000000000,R1,13,2025,R1,power,solarPV,retrofit,2040
-11,A1,6.00000000000,R1,14,2030,R1,power,solarPV,retrofit,2040
-12,A1,9.19000000000,R1,15,2035,R1,power,solarPV,retrofit,2040
-43,A1,6.75000000000,R1,72,2020,R1,power,windturbine,retrofit,2040
-0,A1,2.79440000000,R1,0,2025,R1,gas,gassupply1,retrofit,2040
-1,A1,7.50000000000,R1,1,2030,R1,gas,gassupply1,retrofit,2040
-2,A1,0.91000000000,R1,0,2035,R1,residential,gasboiler,retrofit,2045
-4,A1,16.09000000000,R1,7,2035,R1,residential,heatpump,retrofit,2045
-5,A1,31.00000000000,R1,8,2040,R1,residential,heatpump,retrofit,2045
-2,A1,3.00000000000,R1,0,2025,R1,power,gasCCGT,retrofit,2045
-10,A1,10.00000000000,R1,13,2020,R1,power,solarPV,retrofit,2045
-11,A1,2.40000000000,R1,14,2025,R1,power,solarPV,retrofit,2045
-12,A1,6.00000000000,R1,15,2030,R1,power,solarPV,retrofit,2045
-13,A1,9.19000000000,R1,16,2035,R1,power,solarPV,retrofit,2045
-14,A1,6.00000000000,R1,17,2040,R1,power,solarPV,retrofit,2045
-50,A1,6.75000000000,R1,91,2020,R1,power,windturbine,retrofit,2045
-0,A1,2.79440000000,R1,0,2025,R1,gas,gassupply1,retrofit,2045
-1,A1,7.50000000000,R1,1,2030,R1,gas,gassupply1,retrofit,2045
-0,A1,31.00000000000,R1,0,2040,R1,residential,heatpump,retrofit,2050
-1,A1,23.00000000000,R1,1,2045,R1,residential,heatpump,retrofit,2050
-0,A1,3.00000000000,R1,0,2025,R1,power,gasCCGT,retrofit,2050
-6,A1,2.40000000000,R1,13,2025,R1,power,solarPV,retrofit,2050
-7,A1,6.00000000000,R1,14,2030,R1,power,solarPV,retrofit,2050
-8,A1,9.19000000000,R1,15,2035,R1,power,solarPV,retrofit,2050
-9,A1,6.00000000000,R1,16,2040,R1,power,solarPV,retrofit,2050
-10,A1,16.91000000000,R1,17,2045,R1,power,solarPV,retrofit,2050
-46,A1,6.75000000000,R1,91,2045,R1,power,windturbine,retrofit,2050
-0,A1,2.79440000000,R1,0,2025,R1,gas,gassupply1,retrofit,2050
-1,A1,7.50000000000,R1,1,2030,R1,gas,gassupply1,retrofit,2050
+0,A1,10.00000000000,R1,0,2020,R1,residential,gasboiler,newcapa,2020
+0,A1,1.00000000000,R1,0,2020,R1,power,gasCCGT,newcapa,2020
+0,A1,15.00000000000,R1,0,2020,R1,gas,gassupply1,newcapa,2020
+1,A1,5.00000000000,R1,1,2020,R1,residential,gasboiler,newcapa,2025
+2,A1,19.00000000000,R1,11,2020,R1,residential,heatpump,newcapa,2025
+1,A1,1.00000000000,R1,2,2020,R1,power,gasCCGT,newcapa,2025
+11,A1,10.00000000000,R1,26,2020,R1,power,solarPV,newcapa,2025
+24,A1,6.00000000000,R1,49,2020,R1,power,windturbine,newcapa,2025
+1,A1,15.00000000000,R1,1,2020,R1,gas,gassupply1,newcapa,2025
+3,A1,19.00000000000,R1,16,2020,R1,residential,heatpump,newcapa,2030
+4,A1,10.00000000000,R1,17,2025,R1,residential,heatpump,newcapa,2030
+2,A1,2.00000000000,R1,5,2025,R1,power,gasCCGT,newcapa,2030
+14,A1,10.00000000000,R1,34,2020,R1,power,solarPV,newcapa,2030
+15,A1,9.00000000000,R1,35,2025,R1,power,solarPV,newcapa,2030
+35,A1,6.00000000000,R1,72,2020,R1,power,windturbine,newcapa,2030
+2,A1,7.50000000000,R1,4,2020,R1,gas,gassupply1,newcapa,2030
+7,A1,10.00000000000,R1,28,2025,R1,residential,heatpump,newcapa,2035
+8,A1,26.00000000000,R1,29,2030,R1,residential,heatpump,newcapa,2035
+3,A1,2.00000000000,R1,7,2025,R1,power,gasCCGT,newcapa,2035
+16,A1,10.00000000000,R1,40,2020,R1,power,solarPV,newcapa,2035
+17,A1,9.00000000000,R1,41,2025,R1,power,solarPV,newcapa,2035
+18,A1,6.00000000000,R1,42,2030,R1,power,solarPV,newcapa,2035
+45,A1,6.00000000000,R1,87,2020,R1,power,windturbine,newcapa,2035
+3,A1,3.38700000000,R1,7,2030,R1,gas,gassupply1,newcapa,2035
+11,A1,26.00000000000,R1,45,2030,R1,residential,heatpump,newcapa,2040
+12,A1,16.00000000000,R1,46,2035,R1,residential,heatpump,newcapa,2040
+4,A1,2.00000000000,R1,9,2025,R1,power,gasCCGT,newcapa,2040
+19,A1,10.00000000000,R1,52,2020,R1,power,solarPV,newcapa,2040
+20,A1,9.00000000000,R1,53,2025,R1,power,solarPV,newcapa,2040
+21,A1,6.00000000000,R1,54,2030,R1,power,solarPV,newcapa,2040
+22,A1,6.00000000000,R1,55,2035,R1,power,solarPV,newcapa,2040
+56,A1,6.00000000000,R1,116,2020,R1,power,windturbine,newcapa,2040
+4,A1,3.38700000000,R1,9,2030,R1,gas,gassupply1,newcapa,2040
+15,A1,16.00000000000,R1,66,2035,R1,residential,heatpump,newcapa,2045
+16,A1,32.00000000000,R1,67,2040,R1,residential,heatpump,newcapa,2045
+5,A1,2.00000000000,R1,16,2025,R1,power,gasCCGT,newcapa,2045
+35,A1,10.00000000000,R1,90,2020,R1,power,solarPV,newcapa,2045
+36,A1,9.00000000000,R1,91,2025,R1,power,solarPV,newcapa,2045
+37,A1,6.00000000000,R1,92,2030,R1,power,solarPV,newcapa,2045
+38,A1,6.00000000000,R1,93,2035,R1,power,solarPV,newcapa,2045
+39,A1,6.00000000000,R1,94,2040,R1,power,solarPV,newcapa,2045
+79,A1,6.00000000000,R1,190,2020,R1,power,windturbine,newcapa,2045
+5,A1,3.38700000000,R1,16,2030,R1,gas,gassupply1,newcapa,2045
+19,A1,32.00000000000,R1,91,2040,R1,residential,heatpump,newcapa,2050
+20,A1,22.00000000000,R1,92,2045,R1,residential,heatpump,newcapa,2050
+7,A1,2.00000000000,R1,22,2025,R1,power,gasCCGT,newcapa,2050
+8,A1,1.00000000000,R1,23,2045,R1,power,gasCCGT,newcapa,2050
+47,A1,9.00000000000,R1,116,2025,R1,power,solarPV,newcapa,2050
+48,A1,6.00000000000,R1,117,2030,R1,power,solarPV,newcapa,2050
+49,A1,6.00000000000,R1,118,2035,R1,power,solarPV,newcapa,2050
+50,A1,6.00000000000,R1,119,2040,R1,power,solarPV,newcapa,2050
+51,A1,10.00000000000,R1,120,2045,R1,power,solarPV,newcapa,2050
+93,A1,10.00000000000,R1,235,2045,R1,power,windturbine,newcapa,2050
+6,A1,3.38700000000,R1,19,2030,R1,gas,gassupply1,newcapa,2050
+7,A1,1.64630000000,R1,20,2045,R1,gas,gassupply1,newcapa,2050