Skip to content

Commit 27c7eb2

Browse files
committed
More small text changes
1 parent 80e997e commit 27c7eb2

8 files changed

Lines changed: 92 additions & 118 deletions

docs/user-guide/add-agent.ipynb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@
3636
"\n",
3737
"Again, we only show some of the columns due to space constraints, however see [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/blob/main/docs/tutorial-code/2-add-agent/1-single-objective/technodata/Agents.csv) for the full file.\n",
3838
"\n",
39-
"|AgentShare|Name|RegionName|Objective1|Objective2|Objective3|ObjData1|ObjData2|…|DecisionMethod|Quantity|…|Type|\n",
40-
"|-|-|-|-|-|-|-|-|-|-|-|-|-|\n",
41-
"|Agent1|A1|R1|LCOE|||1||…|singleObj|**0.5**|…|New|\n",
42-
"|**Agent2**|**A2**|**R1**|**fuel_consumption_cost**|||**1**||…|**singleObj**|**0.5**|…|**New**|"
39+
"|AgentShare|Name|RegionName|Objective1|…|ObjData1|…|DecisionMethod|Quantity|…|Type|\n",
40+
"|-|-|-|-|-|-|-|-|-|-|-|\n",
41+
"|Agent1|A1|R1|LCOE|…|1|…|singleObj|**0.5**|…|New|\n",
42+
"|**Agent2**|**A2**|**R1**|**fuel_consumption_cost**|…|**1**|…|**singleObj**|**0.5**|…|**New**|"
4343
]
4444
},
4545
{
@@ -140,12 +140,12 @@
140140
"\n",
141141
"We can also use multiple objectives for a single agent, combining objectives by taking a weighted sum. We will try this for agent A2, using both `fuel_consumption_cost` and `LCOE` with relative weights of 0.5 each.\n",
142142
"\n",
143-
"To do this, we need to modify the `Objective2`, `ObjData1`, `ObjData2`, `Objsort2` and `DecisionMethod` columns in the ```Agents.csv``` file, to look like the following:\n",
143+
"To do this, we need to add the new objective in the `Objective2` column, use `Objsort2` to indicate that this objective should be minimised, modify `DecisionMethod` to indicate that a weighted sum should be taken between the two objectives, and specify the weights of the two objectives in `ObjData1` and `ObjData2`:\n",
144144
"\n",
145-
"|AgentShare|Name|RegionName|Objective1|Objective2|Objective3|ObjData1|ObjData2|…|Objsort2|…|DecisionMethod|Quantity|…|Type|\n",
145+
"|AgentShare|Name|RegionName|Objective1|Objective2||ObjData1|ObjData2|…|Objsort2|…|DecisionMethod|Quantity|…|Type|\n",
146146
"|-|-|-|-|-|-|-|-|-|-|-|-|-|-|-|\n",
147-
"|Agent1|A1|R1|LCOE|||1||…||…|singleObj|0.5|…|New|\n",
148-
"|Agent2|A2|R1|fuel_consumption_cost|**LCOE**||**0.5**|**0.5**|…|**True**|**…**|**weighted_sum**|0.5|…|New|"
147+
"|Agent1|A1|R1|LCOE|||1||…||…|singleObj|0.5|…|New|\n",
148+
"|Agent2|A2|R1|fuel_consumption_cost|**LCOE**||**0.5**|**0.5**|…|**True**||**weighted_sum**|0.5|…|New|"
149149
]
150150
},
151151
{

docs/user-guide/add-gdp-correlation-demand.ipynb

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"cell_type": "markdown",
3535
"metadata": {},
3636
"source": [
37-
"Similarly to before, we must amend the `technodata/preset` folder for this. As we are no longer explicitly specifying demand, we can delete the `Residential2020Consumption.csv` and `Residential2050Consumption.csv` files. Instead, we must replace these files with the following:\n",
37+
"Similarly to before, we must amend the `technodata/preset` folder. As we are no longer explicitly specifying demand, we can delete the `Residential2020Consumption.csv` and `Residential2050Consumption.csv` files. Instead, we must replace these files with the following:\n",
3838
"\n",
3939
"- A macrodrivers file. This contains the drivers of the service demand that we want to model. For this example, these will include GDP based on purchasing power parity (GDP PPP) and the population that we expect from 2010 to 2110.\n",
4040
"\n",
@@ -50,11 +50,11 @@
5050
"\n",
5151
"- [TimesliceSharepreset.csv](https://github.com/EnergySystemsModellingLab/MUSE_OS/blob/main/docs/tutorial-code/6-add-correlation-demand/1-correlation/technodata/preset/TimesliceSharepreset.csv)\n",
5252
"\n",
53-
"For a full introduction to these files, see the link [here](../inputs/correlation_files.rst).\n",
53+
"For a full description of these files, see the link [here](../inputs/correlation_files.rst).\n",
5454
"\n",
5555
"Download these files and save them within the `preset` folder.\n",
5656
"\n",
57-
"Next, we must amend our toml file to include our new way of calculating the preset service demand."
57+
"Next, we must amend our toml file to link to these files."
5858
]
5959
},
6060
{
@@ -68,9 +68,7 @@
6868
"cell_type": "markdown",
6969
"metadata": {},
7070
"source": [
71-
"Editing the TOML file to include this can be done relatively quickly if we know the variable names.\n",
72-
"\n",
73-
"In the second bottom section of the toml file, you will see the following section: \n",
71+
"Towards the bottom of the toml file, you will see the following section: \n",
7472
"\n",
7573
"```toml\n",
7674
"[sectors.residential_presets]\n",
@@ -79,7 +77,7 @@
7977
"consumption_path= \"{path}/technodata/preset/*Consumption.csv\"\n",
8078
"```\n",
8179
"\n",
82-
"This enables us to run the model in exogenous mode, but now we would like to run the model from the files previously mentioned. This can be done by linking new variables to the new files, as follows:\n",
80+
"This enables us to run the model in exogenous mode (i.e. explicitly specifying demand), but now we would like to run the model using the new regression files. This can be done by linking new variables to the new files, as follows:\n",
8381
"\n",
8482
"```toml\n",
8583
"[sectors.residential_presets]\n",
@@ -88,9 +86,7 @@
8886
"timeslice_shares_path = '{path}/technodata/preset/TimesliceSharepreset.csv'\n",
8987
"macrodrivers_path = '{path}/technodata/preset/Macrodrivers.csv'\n",
9088
"regression_path = '{path}/technodata/preset/regressionparameters.csv'\n",
91-
"```\n",
92-
"\n",
93-
"We effectively linked the new files to MUSE."
89+
"```"
9490
]
9591
},
9692
{
@@ -158,8 +154,13 @@
158154
"cell_type": "markdown",
159155
"metadata": {},
160156
"source": [
161-
"As expected, we see a different scenario emerge. The demand does not increase linearly, with variations in the total demand in the residential sector. This is due to the new function not being a linear function."
157+
"As expected, we see a different scenario emerge. The demand does not increase linearly, with variations in the total demand in the residential sector, in line with the changing population data."
162158
]
159+
},
160+
{
161+
"cell_type": "markdown",
162+
"metadata": {},
163+
"source": []
163164
}
164165
],
165166
"metadata": {

docs/user-guide/add-region.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
"|Unit|-|Year|…|PJ|…|New|\n",
6868
"|gasboiler|R1|2020|…|100|…|1|\n",
6969
"|heatpump|R1|2020|…|100|…|1|\n",
70-
"|gasboiler|R2|2020|…|100…|1|\n",
70+
"|gasboiler|R2|2020|…|100|…|1|\n",
7171
"|heatpump|R2|2020|…|**20**|…|1|\n",
7272
"\n",
7373
"Now, go ahead and amend all of the other input files for each of the sectors (including the preset sector, which defines the residential commodity demand in each region) by copying and pasting the rows from `R1` and replacing the `RegionName` to `R2` for the new rows. You must also modify the `Projections.csv` file in the `input` folder in a similar way.\n",

docs/user-guide/add-solar.ipynb

Lines changed: 26 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"cell_type": "markdown",
1919
"metadata": {},
2020
"source": [
21-
"MUSE is made up of a number of different [input files](../inputs/index.rst). These, however, can be broadly split into two:\n",
21+
"MUSE is made up of a number of different [input files](../inputs/index.rst). These can be broadly split into two types:\n",
2222
"\n",
2323
"- [Simulation settings](../inputs/toml.rst)\n",
2424
"\n",
@@ -83,11 +83,11 @@
8383
"cell_type": "markdown",
8484
"metadata": {},
8585
"source": [
86-
"Within the default folder there is the ```settings.toml``` file, `input` folder and `technodata` folder. To add a technology within the power sector, we must open the ```technodata``` folder followed by the ```power``` folder.\n",
86+
"Within the default folder you'll find a ```settings.toml``` file, `input` folder and `technodata` folder. To add a technology within the power sector, we must open the ```technodata``` folder followed by the ```power``` folder.\n",
8787
"\n",
8888
"At this point, we must note that we require consistency in input and output units. For example, if capacity is in PJ, the same basis would be needed for the output files `CommIn.csv` and `CommOut.csv`. In addition, across sectors a commodity needs to maintain the same unit. In these examples, we use the unit petajoule (PJ).\n",
8989
"\n",
90-
"Next, we will edit the ```CommIn.csv``` file, which specifies the commodities consumed by solar photovoltaics.\n",
90+
"We will first edit the ```CommIn.csv``` file, which specifies the commodities consumed by solar photovoltaics.\n",
9191
"\n",
9292
"The table below shows the original ```CommIn.csv``` version in normal text, and the added column and row in **bold**.\n",
9393
"\n",
@@ -108,7 +108,7 @@
108108
"- the input type is [fixed](../inputs/commodities_io.rst)\n",
109109
"- solarPV consumes solar\n",
110110
"\n",
111-
"As the solar commodity has not been previously defined, we must define it by adding a column, which we will call solar. We fill out the entries in the solar column, ie. that neither `gasCCGT` nor `windturbine` consume solar.\n"
111+
"As the solar commodity has not been previously defined, we must define it by adding a column, which we will call `solar`. We fill out the entries in the solar column, ie. that neither `gasCCGT` nor `windturbine` consume `solar`.\n"
112112
]
113113
},
114114
{
@@ -133,7 +133,7 @@
133133
"cell_type": "markdown",
134134
"metadata": {},
135135
"source": [
136-
"The next file to modify is the ```ExistingCapacity.csv``` file. This file details the existing capacity of each technology, per benchmark year. For this example, we will set the existing capacity to be 0. Please note, that the model interpolates between years linearly. \n",
136+
"The next file to modify is the `ExistingCapacity.csv` file. This file details the existing capacity of each technology, and a decommissioning profile across the time framework. For this example, we will set the existing capacity to be 0. Please note that the model interpolates linearly between years. \n",
137137
"\n",
138138
"|ProcessName|RegionName|Unit|2020|2025|2030|2035|2040|2045|2050|\n",
139139
"|-|-|-|-|-|-|-|-|-|-|\n",
@@ -146,30 +146,18 @@
146146
"cell_type": "markdown",
147147
"metadata": {},
148148
"source": [
149-
"Finally, the ```Technodata.csv``` contains parametrisation data for the technology, such as the cost, growth constraints, lifetime of the power plant and fuel used. The technodata file is too long for it all to be displayed here, so we will truncate the full version."
150-
]
151-
},
152-
{
153-
"cell_type": "markdown",
154-
"metadata": {},
155-
"source": [
156-
"Here, we will only define the parameters: ```ProcessName```, ```RegionName```, ```Time```, ```Level```,```cap_par```, ```Fuel```,```EndUse``` and ```Agent1```\n",
149+
"Finally, the `Technodata.csv` file contains parametrisation data for the technology, such as the cost, growth constraints, lifetime of the power plant and fuel used. \n",
157150
"\n",
158-
"We shall copy the existing parameters from the ```windturbine``` technology for the remaining parameters that can be seen in the ```Technodata.csv``` file for brevity. You can see the full file [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/blob/main/docs/tutorial-code/1-add-new-technology/1-introduction/technodata/power/Technodata.csv).\n",
151+
"We will only display the some of the parameters, as the table is too large to display in full. The remaining parameters will be copied from the `windturbine` technology. You can see the full file [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/blob/main/docs/tutorial-code/1-add-new-technology/1-introduction/technodata/power/Technodata.csv), and details about each parameter [here](../inputs/technodata.rst).\n",
159152
"\n",
160-
"Again, flat forward extension is used here. Therefore, as in this example we only provide data for the benchmark year 2020. 2025 and the following benchmark years will keep the same characteristics, e.g. costs, for each benchmark year of the simulation."
161-
]
162-
},
163-
{
164-
"cell_type": "markdown",
165-
"metadata": {},
166-
"source": [
167153
"|ProcessName|RegionName|Time|Level|cap_par|cap_exp|…|Fuel|EndUse|Agent1|\n",
168154
"|-|-|-|-|-|-|-|-|-|-|\n",
169155
"|Unit|-|Year|-|MUS$2010/PJ_a|-|…|-|-|New|\n",
170156
"|gasCCGT|R1|2020|fixed|23.78234399|1|…|gas|electricity|1|\n",
171157
"|windturbine|R1|2020|fixed|36.30771182|1|…|wind|electricity|1|\n",
172-
"|**solarPV**|**R1**|**2020**|**fixed**|**30**|**1**|...|**solar**|**electricity**|**1**"
158+
"|**solarPV**|**R1**|**2020**|**fixed**|**30**|**1**|...|**solar**|**electricity**|**1**|\n",
159+
"\n",
160+
"Again, flat forward extension is used. Therefore, as we only provide data for the benchmark year 2020, 2025 and the following benchmark years will keep the same characteristics."
173161
]
174162
},
175163
{
@@ -183,16 +171,16 @@
183171
"cell_type": "markdown",
184172
"metadata": {},
185173
"source": [
186-
"Next, navigate to the ```input``` folder.\n",
174+
"Next, navigate to the `input` folder.\n",
187175
"\n",
188-
"We must now edit each of the files found here to add the new solar commodity. Due to space constraints we will not display all of the entries contained in the input files. The edited files can be viewed in full [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/tree/main/docs/tutorial-code/1-add-new-technology/1-introduction)."
176+
"We must now edit each of the files found here to add the new `solar` commodity. Due to space constraints we will not display all of the entries contained in every input. You can be view the edited files in full [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/tree/main/docs/tutorial-code/1-add-new-technology/1-introduction)."
189177
]
190178
},
191179
{
192180
"cell_type": "markdown",
193181
"metadata": {},
194182
"source": [
195-
"The ```GlobalCommodities.csv``` file is the file which defines the commodities. Here we give the commodities a commodity type, CO2 emissions factor and heat rate. For this file, we will add the solar commodity, with zero CO2 emissions factor and a heat rate of 1.\n",
183+
"Commodities are defined in the `GlobalCommodities.csv` file. Here we give the commodities a commodity type, CO2 emissions factor and heat rate. For this file, we will add the `solar` commodity, with zero CO2 emissions factor and a heat rate of 1.\n",
196184
"\n",
197185
"|Commodity|CommodityType|CommodityName|CommodityEmissionFactor_CO2|HeatRate|Unit|\n",
198186
"|-|-|-|-|-|-|\n",
@@ -208,7 +196,7 @@
208196
"cell_type": "markdown",
209197
"metadata": {},
210198
"source": [
211-
"The ```Projections.csv``` file details the initial market prices for the commodities. The market clearing algorithm will update these throughout the simulation, however, an initial estimate is required to start the simulation. As solar energy is free, we will indicate this by adding a final column.\n",
199+
"The `Projections.csv` file details the initial market prices for the commodities. The market clearing algorithm will update these throughout the simulation, however an initial estimate is required to start the simulation. As solar energy is free, we will indicate this by adding a final column.\n",
212200
"\n",
213201
"Please note that the unit row is not read by MUSE, but used as a reference for the user. The units should be consistent across all input files for MUSE; MUSE does not carry out any unit conversion.\n",
214202
"\n",
@@ -260,8 +248,7 @@
260248
"metadata": {},
261249
"source": [
262250
"Now we are able to run our simulation with the new solar power technology.\n",
263-
"\n",
264-
"To do this we run the same run command as previously in the command line:\n",
251+
"To do this, we run the following command in the command line:\n",
265252
"\n",
266253
"```bash\n",
267254
"python -m muse settings.toml\n",
@@ -289,7 +276,7 @@
289276
"cell_type": "markdown",
290277
"metadata": {},
291278
"source": [
292-
"First, we will import the ```MCACapacity.csv``` file using pandas and print the first 5 lines with the ```head()``` command. (Make sure to change the file path to where the `MCACapacity.csv` is on your computer.)"
279+
"First, we will import the ```MCACapacity.csv``` file using pandas, and print the first 5 lines with the ```head()``` command. (Make sure to change the file path as appropriate.)"
293280
]
294281
},
295282
{
@@ -338,7 +325,7 @@
338325
"cell_type": "markdown",
339326
"metadata": {},
340327
"source": [
341-
"We can now see that there is `solarPV` in the power sector, compared to the example [here](../running-muse-example.ipynb) where `solarPV` is absent! That's great and means it worked! \n",
328+
"We can now see that there is `solarPV` capacity in the power sector, compared to the example [here](../running-muse-example.ipynb) where `solarPV` is absent! That's great and means it worked! \n",
342329
"\n",
343330
"We can see that `solarPV` has a higher uptake than `gasCCGT`, and has entirely replaced `windturbine` in of the sector, which is likely due to the lower `cap_par` (capital cost) which makes it more favourable for investment. We can investigate this by changing the `cap_par` value for `solarPV`, which we will do in the next section."
344331
]
@@ -356,7 +343,7 @@
356343
"source": [
357344
"Now, we will observe what happens if we increase the capital price of solar to be more expensive than wind in the year 2020, but then reduce the price of solar in 2040. By doing this, we should observe an initial investment in wind in the first few benchmark years of the simulation, followed by a transition to solar as we approach the year 2040.\n",
358345
"\n",
359-
"To achieve this we have to modify the `Technodata.csv`, `CommIn.csv` and `CommOut.csv` files in the `power` sector.\n",
346+
"To achieve this, we have to modify the `Technodata.csv`, `CommIn.csv` and `CommOut.csv` files in the `power` sector.\n",
360347
"\n",
361348
"First, we will amend the `Technodata.csv` file as follows:\n",
362349
"\n",
@@ -383,7 +370,7 @@
383370
"source": [
384371
"Next we will modify the `CommIn.csv` file.\n",
385372
"\n",
386-
"For this step, we have to provide the input commodities for each technology, in each of the years defined in the `Technodata.csv` file. So, for this example we are required to provide entries for the years 2020 and 2040 for each of the technologies. For now, we won't change the 2040 values compared to the 2020. Therefore, we just need to copy and paste each of the entries for each of the technologies, as shown below:\n",
373+
"For this step, we have to provide the input commodities for each technology, in each of the years defined in the `Technodata.csv` file. So, for this example, we are required to provide entries for the years 2020 and 2040 for each of the technologies. For now, we won't change the 2040 values compared to the 2020. Therefore, we just need to copy and paste each of the entries for each of the technologies, as shown below:\n",
387374
"\n",
388375
"|ProcessName|RegionName|Time|Level|electricity|gas|heat|CO2f|wind|solar|\n",
389376
"|-|-|-|-|-|-|-|-|-|-|\n",
@@ -397,14 +384,7 @@
397384
"\n",
398385
"We must do the same for the `CommOut.csv` file. For the sake of brevity we won't show you this, but the link to the file can be found [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/blob/main/docs/tutorial-code/1-add-new-technology/2-scenario/technodata/power/CommOut.csv).\n",
399386
"\n",
400-
"We will now rerun the simulation, using the same command as previously and visualise the new results."
401-
]
402-
},
403-
{
404-
"cell_type": "markdown",
405-
"metadata": {},
406-
"source": [
407-
"We must import the new ```MCACapacity.csv``` file again, and then visualise the results."
387+
"We will now rerun the simulation, using the same command as previously, import the new `MCACapacity.csv` file again, and visualise the results:"
408388
]
409389
},
410390
{
@@ -440,8 +420,13 @@
440420
"source": [
441421
"From the results, we can see that `windturbine` now outcompetes `solarPV` in the year 2025. However, between the years 2025 and 2050, as the capital cost of `solarPV` decreases, the share of `solarPV` begins to increase.\n",
442422
"\n",
443-
"For the full example with the completed input files see [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/tree/main/docs/tutorial-code/1-add-new-technology/2-scenario)"
423+
"For the full example with the completed input files see [here](https://github.com/EnergySystemsModellingLab/MUSE_OS/tree/main/docs/tutorial-code/1-add-new-technology/2-scenario)."
444424
]
425+
},
426+
{
427+
"cell_type": "markdown",
428+
"metadata": {},
429+
"source": []
445430
}
446431
],
447432
"metadata": {

0 commit comments

Comments
 (0)