Update/simplify example models (#753)

* Remove optional columns from Agents and GlobalCommodities files

* Create Description column in commodities file

* Fix reader tests

* Remove zeros columns from projections files

* Remove cap_exp etc from technodata files

* Remove efficiency and type from technodata files

* Remove zero commodities from presets files

* Remove extra objectives from agents

* Remove price projections for end-use commodities

* Remove projections data from outside the time framework

* Remove zero commodities from CommOut files

* Update tests

* Remove description from global commodities files

* Update test

* Update tutorials

* Update wizard

* Update tutorial models

* Update example model results

* Add back price of environmentals in minimum_service model

* Fix to process_io_technodata to allow test to pass

* Update CommIn files

* Fix mistake in CommIn file

Author: tsmbland

docs/inputs/commodities.rst

@@ -15,13 +15,13 @@ a whole are defined in a csv file with the following structure.
    Coal, Energy, hardcoal, 94.6, 29, PJ
    Agricultural-residues, Energy, agrires, 112, 15.4, PJ
 
-Commodity
-   represents the extended name of a commodity (e.g. "Heating" or "Electricity").
-
 CommodityName
    the internal name used for a commodity inside the model (e.g. "heat" or "elec").
    Any references to commodities in other files must use these names.
 
+Description
+   an extended name/description of a commodity (e.g. "Heating" or "Electricity").
+
 CommodityType
    defines the type of a commodity (i.e. Energy, Service, Material, or Environmental).
 
@@ -36,16 +36,6 @@ CommodityType
    The "environmental" type refers to non-energy commodities whichare used to quantify an impact on the environment,
    such as greenhouse gases or CO2. They can be subjected to different types of environmental fees or taxes.
 
-CommodityEmissionFactor_CO2 (optional)
-   is CO2 emission per unit of commodity flow.
-   This commodity property is not directly used in the MUSE core set of equations, but can be further referred to
-   for any subsequent development of the code.
-
-HeatRate (optional)
-   represents the lower heating value of an energy commodity
-   This commodity property is not directly used in the MUSE core set of equations, but can be further referred to
-   for any subsequent development of the code.
-
 Unit (optional)
    is the unit used to represent quantities of the commodity (e.g "PJ").
    This parameter does not need to be included, as it isn't used in the model, but care should be taken to ensure that units are consistent across all input files.

docs/tutorial-code/add-agent/1-single-objective/Agents.csv

@@ -1,3 +1,3 @@
-AgentShare,Name,RegionName,Objective1,Objective2,Objective3,ObjData1,ObjData2,ObjData3,Objsort1,Objsort2,Objsort3,SearchRule,DecisionMethod,Quantity,MaturityThreshold,SpendLimit,Type
-Agent1,A1,R1,LCOE,,,1,,,True,,,all,singleObj,0.5,-1,inf,New
-Agent2,A2,R1,fuel_consumption_cost,,,1,,,True,,,all,singleObj,0.5,-1,inf,New
+AgentShare,Name,RegionName,Objective1,ObjData1,Objsort1,SearchRule,DecisionMethod,Quantity,Type
+Agent1,A1,R1,LCOE,1,True,all,singleObj,0.5,New
+Agent2,A2,R1,fuel_consumption_cost,1,True,all,singleObj,0.5,New

docs/tutorial-code/add-agent/1-single-objective/GlobalCommodities.csv

@@ -1,6 +1,6 @@
-Commodity,CommodityType,CommodityName,CommodityEmissionFactor_CO2,HeatRate,Unit
-Electricity,Energy,electricity,0,1,PJ
-Gas,Energy,gas,56.1,1,PJ
-Heat,Energy,heat,0,1,PJ
-Wind,Energy,wind,0,1,PJ
-CO2fuelcomsbustion,Environmental,CO2f,0,1,kt
+CommodityName,CommodityType,Unit
+electricity,Energy,PJ
+gas,Energy,PJ
+heat,Energy,PJ
+wind,Energy,PJ
+CO2f,Environmental,kt

docs/tutorial-code/add-agent/1-single-objective/Projections.csv

@@ -1,20 +1,8 @@
-RegionName,Attribute,Time,electricity,gas,heat,CO2f,wind
-R1,CommodityPrice,2010,14.81481472,6.6759,100,0,0
-R1,CommodityPrice,2015,17.89814806,6.914325,100,0.052913851,0
-R1,CommodityPrice,2020,19.5,7.15275,100,0.08314119,0
-R1,CommodityPrice,2025,21.93518528,8.10645,100,0.120069795,0
-R1,CommodityPrice,2030,26.50925917,9.06015,100,0.156998399,0
-R1,CommodityPrice,2035,26.51851861,9.2191,100,0.214877567,0
-R1,CommodityPrice,2040,23.85185194,9.37805,100,0.272756734,0
-R1,CommodityPrice,2045,23.97222222,9.193829337,100,0.35394801,0
-R1,CommodityPrice,2050,24.06481472,9.009608674,100,0.435139285,0
-R1,CommodityPrice,2055,25.3425925,8.832625604,100,0.542365578,0
-R1,CommodityPrice,2060,25.53703694,8.655642534,100,0.649591871,0
-R1,CommodityPrice,2065,25.32407417,8.485612708,100,0.780892624,0
-R1,CommodityPrice,2070,23.36111111,8.315582883,100,0.912193378,0
-R1,CommodityPrice,2075,22.27777778,8.152233126,100,1.078321687,0
-R1,CommodityPrice,2080,22.25925917,7.988883368,100,1.244449995,0
-R1,CommodityPrice,2085,22.17592583,7.831951236,100,1.4253503,0
-R1,CommodityPrice,2090,22.03703694,7.675019103,100,1.606250604,0
-R1,CommodityPrice,2095,21.94444444,7.524252461,100,1.73877515,0
-R1,CommodityPrice,2100,21.39814806,7.373485819,100,1.871299697,0
+RegionName,Attribute,Time,electricity,gas,CO2f
+R1,CommodityPrice,2020,19.5,7.15275,0.08314119
+R1,CommodityPrice,2025,21.93518528,8.10645,0.120069795
+R1,CommodityPrice,2030,26.50925917,9.06015,0.156998399
+R1,CommodityPrice,2035,26.51851861,9.2191,0.214877567
+R1,CommodityPrice,2040,23.85185194,9.37805,0.272756734
+R1,CommodityPrice,2045,23.97222222,9.193829337,0.35394801
+R1,CommodityPrice,2050,24.06481472,9.009608674,0.435139285

docs/tutorial-code/add-agent/1-single-objective/Results/MCAPrices.csv

@@ -1,32 +1,32 @@
 commodity,day,hour,month,prices,region,timeslice,units_prices,year
 electricity,all-week,night,all-year,19.5000,r1,0,MUS$2010/PJ,2020
 gas,all-week,night,all-year,7.1528,r1,0,MUS$2010/PJ,2020
-heat,all-week,night,all-year,100.0000,r1,0,MUS$2010/PJ,2020
+heat,all-week,night,all-year,0.0000,r1,0,MUS$2010/PJ,2020
 wind,all-week,night,all-year,0.0000,r1,0,MUS$2010/PJ,2020
 CO2f,all-week,night,all-year,0.0831,r1,0,MUS$2010/kt,2020
 electricity,all-week,morning,all-year,19.5000,r1,1,MUS$2010/PJ,2020
 gas,all-week,morning,all-year,7.1528,r1,1,MUS$2010/PJ,2020
-heat,all-week,morning,all-year,100.0000,r1,1,MUS$2010/PJ,2020
+heat,all-week,morning,all-year,0.0000,r1,1,MUS$2010/PJ,2020
 wind,all-week,morning,all-year,0.0000,r1,1,MUS$2010/PJ,2020
 CO2f,all-week,morning,all-year,0.0831,r1,1,MUS$2010/kt,2020
 electricity,all-week,afternoon,all-year,19.5000,r1,2,MUS$2010/PJ,2020
 gas,all-week,afternoon,all-year,7.1528,r1,2,MUS$2010/PJ,2020
-heat,all-week,afternoon,all-year,100.0000,r1,2,MUS$2010/PJ,2020
+heat,all-week,afternoon,all-year,0.0000,r1,2,MUS$2010/PJ,2020
 wind,all-week,afternoon,all-year,0.0000,r1,2,MUS$2010/PJ,2020
 CO2f,all-week,afternoon,all-year,0.0831,r1,2,MUS$2010/kt,2020
 electricity,all-week,early-peak,all-year,19.5000,r1,3,MUS$2010/PJ,2020
 gas,all-week,early-peak,all-year,7.1528,r1,3,MUS$2010/PJ,2020
-heat,all-week,early-peak,all-year,100.0000,r1,3,MUS$2010/PJ,2020
+heat,all-week,early-peak,all-year,0.0000,r1,3,MUS$2010/PJ,2020
 wind,all-week,early-peak,all-year,0.0000,r1,3,MUS$2010/PJ,2020
 CO2f,all-week,early-peak,all-year,0.0831,r1,3,MUS$2010/kt,2020
 electricity,all-week,late-peak,all-year,19.5000,r1,4,MUS$2010/PJ,2020
 gas,all-week,late-peak,all-year,7.1528,r1,4,MUS$2010/PJ,2020
-heat,all-week,late-peak,all-year,100.0000,r1,4,MUS$2010/PJ,2020
+heat,all-week,late-peak,all-year,0.0000,r1,4,MUS$2010/PJ,2020
 wind,all-week,late-peak,all-year,0.0000,r1,4,MUS$2010/PJ,2020
 CO2f,all-week,late-peak,all-year,0.0831,r1,4,MUS$2010/kt,2020
 electricity,all-week,evening,all-year,19.5000,r1,5,MUS$2010/PJ,2020
 gas,all-week,evening,all-year,7.1528,r1,5,MUS$2010/PJ,2020
-heat,all-week,evening,all-year,100.0000,r1,5,MUS$2010/PJ,2020
+heat,all-week,evening,all-year,0.0000,r1,5,MUS$2010/PJ,2020
 wind,all-week,evening,all-year,0.0000,r1,5,MUS$2010/PJ,2020
 CO2f,all-week,evening,all-year,0.0831,r1,5,MUS$2010/kt,2020
 electricity,all-week,night,all-year,19.4241,r1,0,MUS$2010/PJ,2025

docs/tutorial-code/add-agent/1-single-objective/gas/CommOut.csv

@@ -1,2 +1,2 @@
-ProcessName,RegionName,Time,electricity,gas,heat,CO2f,wind
-gassupply1,R1,2020,0,1,0,0,0
+ProcessName,RegionName,Time,gas
+gassupply1,R1,2020,1

docs/tutorial-code/add-agent/1-single-objective/gas/Technodata.csv

@@ -1,2 +1,2 @@
-ProcessName,RegionName,Time,cap_par,cap_exp,fix_par,fix_exp,var_par,var_exp,MaxCapacityAddition,MaxCapacityGrowth,TotalCapacityLimit,TechnicalLife,UtilizationFactor,efficiency,InterestRate,Type,Agent1,Agent2
-gassupply1,R1,2020,0,1,0,1,2.55,1,10,0.5,100,35,0.9,86,0.1,energy,0.5,0.5
+ProcessName,RegionName,Time,cap_par,fix_par,var_par,MaxCapacityAddition,MaxCapacityGrowth,TotalCapacityLimit,TechnicalLife,UtilizationFactor,InterestRate,Agent1,Agent2
+gassupply1,R1,2020,0,0,2.55,10,0.5,100,35,0.9,0.1,0.5,0.5

docs/tutorial-code/add-agent/1-single-objective/power/CommIn.csv

@@ -1,3 +1,3 @@
-ProcessName,RegionName,Time,Level,electricity,gas,heat,CO2f,wind
-gasCCGT,R1,2020,fixed,0,1.67,0,0,0
-windturbine,R1,2020,fixed,0,0,0,0,1
+ProcessName,RegionName,Time,Level,gas,wind
+gasCCGT,R1,2020,fixed,1.67,0
+windturbine,R1,2020,fixed,0,1

docs/tutorial-code/add-agent/1-single-objective/power/CommOut.csv

@@ -1,3 +1,3 @@
-ProcessName,RegionName,Time,electricity,gas,heat,CO2f,wind
-gasCCGT,R1,2020,1,0,0,91.67,0
-windturbine,R1,2020,1,0,0,0,0
+ProcessName,RegionName,Time,electricity,CO2f
+gasCCGT,R1,2020,1,91.67
+windturbine,R1,2020,1,0

docs/tutorial-code/add-agent/1-single-objective/power/Technodata.csv

@@ -1,3 +1,3 @@
-ProcessName,RegionName,Time,cap_par,cap_exp,fix_par,fix_exp,var_par,var_exp,MaxCapacityAddition,MaxCapacityGrowth,TotalCapacityLimit,TechnicalLife,UtilizationFactor,efficiency,InterestRate,Type,Agent1,Agent2
-gasCCGT,R1,2020,23.78234399,1,0,1,0,1,10,0.5,100,35,0.9,86,0.1,energy,0.5,0.5
-windturbine,R1,2020,36.30771182,1,0,1,0,1,10,0.5,100,25,0.4,86,0.1,energy,0.5,0.5
+ProcessName,RegionName,Time,cap_par,fix_par,var_par,MaxCapacityAddition,MaxCapacityGrowth,TotalCapacityLimit,TechnicalLife,UtilizationFactor,InterestRate,Agent1,Agent2
+gasCCGT,R1,2020,23.78234399,0,0,10,0.5,100,35,0.9,0.1,0.5,0.5
+windturbine,R1,2020,36.30771182,0,0,10,0.5,100,25,0.4,0.1,0.5,0.5