Restructure input data for example models

docs/inputs/toml.rst

@@ -155,9 +155,8 @@ explained in the :ref:`toml-primer`.
 .. code-block:: TOML
 
    [global_input_files]
-   projections = '{path}/inputs/Projections.csv'
-   regions = '{path}/inputs/Regions.csv'
-   global_commodities = '{path}/inputs/MUSEGlobalCommodities.csv'
+   projections = '{path}/Projections.csv'
+   global_commodities = '{path}/GlobalCommodities.csv'
 
 *projections*
    Path to a csv file giving initial market projection. See :ref:`inputs-projection`.
@@ -398,21 +397,21 @@ Sectors contain a number of subsections:
     .. code-block:: toml
 
         [sectors.gas.subsectors.all]
-        agents = '{path}/technodata/Agents.csv'
-        existing_capacity = '{path}/technodata/gas/Existing.csv'
+        agents = '{path}/gas/Agents.csv'
+        existing_capacity = '{path}/gas/ExistingCapacity.csv'
 
     A two-subsector could look like:
 
     .. code-block:: toml
 
         [sectors.gas.subsectors.methane_and_ethanol]
-        agents = '{path}/technodata/me_agents.csv'
-        existing_capacity = '{path}/technodata/gas/me_existing.csv'
+        agents = '{path}/gas/me_agents.csv'
+        existing_capacity = '{path}/gas/me_existing.csv'
         commodities = ["methane", "ethanol"]
 
         [sectors.gas.subsectors.natural]
-        agents = '{path}/technodata/nat_agents.csv'
-        existing_capacity = '{path}/technodata/gas/nat_existing.csv'
+        agents = '{path}/gas/nat_agents.csv'
+        existing_capacity = '{path}/gas/nat_existing.csv'
         commodities = ["refined", "crude"]
 
     In the case of multiple subsectors, it is important to specify disjoint sets of
@@ -562,7 +561,7 @@ A common example would be the following, where commodity consumption is defined
     [sectors.commercial_presets]
     type = 'presets'
     priority = 0
-    consumption_path = "{path}/technodata/preset/*Consumption.csv"
+    consumption_path = "{path}/commercial_presets/*Consumption.csv"
 
 Alternatively, you may define consumption as a function of macro-economic data, i.e. population and GDP:
 
@@ -571,9 +570,9 @@ Alternatively, you may define consumption as a function of macro-economic data,
     [sectors.commercial_presets]
     type = 'presets'
     priority = 0
-    timeslice_shares_path = '{path}/technodata/TimesliceShareCommercial.csv'
-    macrodrivers_path = '{path}/technodata/Macrodrivers.csv'
-    regression_path = '{path}/technodata/regressionparameters.csv'
+    timeslice_shares_path = '{path}/commercial_presets/TimesliceShareCommercial.csv'
+    macrodrivers_path = '{path}/commercial_presets/Macrodrivers.csv'
+    regression_path = '{path}/commercial_presets/regressionparameters.csv'
 
 The following attributes are accepted:
 

docs/tutorial-code/add-agent/1-single-objective/settings.toml

@@ -1,96 +1,79 @@
-# Global settings - most REQUIRED
+# MUSE settings file
 
+# Global settings
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
 regions = ["R1"]
 interpolation_mode = 'linear'
 log_level = 'info'
-excluded_commodities = ["wind"]
-# Convergence parameters
 equilibrium_variable = 'demand'
 maximum_iterations = 100
 tolerance = 0.1
 tolerance_unmet_demand = -0.1
+excluded_commodities = ["wind"]
 
-[[outputs]]
-quantity = "capacity"
-sink = "aggregate"
-filename = "{cwd}/{default_output_dir}/MCA{Quantity}.csv"
-
-[[outputs]]
-quantity = "prices"
-sink = "aggregate"
-filename = "{cwd}/{default_output_dir}/MCA{Quantity}.csv"
+# Timeslices
+[timeslices]
+level_names = ["month", "day", "hour"]
 
-[carbon_budget_control]
-budget = []
+[timeslices.all-year.all-week]
+night = 1460
+morning = 1460
+afternoon = 1460
+early-peak = 1460
+late-peak = 1460
+evening = 1460
 
+# Global inputs
 [global_input_files]
-projections = '{path}/input/Projections.csv'
-global_commodities = '{path}/input/GlobalCommodities.csv'
+projections = '{path}/Projections.csv'
+global_commodities = '{path}/GlobalCommodities.csv'
 
+# Sectors
 [sectors.residential]
 type = 'default'
 priority = 1
-dispatch_production = 'share'
-technodata = '{path}/technodata/residential/Technodata.csv'
-commodities_in = '{path}/technodata/residential/CommIn.csv'
-commodities_out = '{path}/technodata/residential/CommOut.csv'
+technodata = '{path}/residential/Technodata.csv'
+commodities_in = '{path}/residential/CommIn.csv'
+commodities_out = '{path}/residential/CommOut.csv'
 
 [sectors.residential.subsectors.all]
-agents = '{path}/technodata/Agents.csv'
-existing_capacity = '{path}/technodata/residential/ExistingCapacity.csv'
-lpsolver = "scipy"  # Optional, defaults to "scipy"
-constraints = [
-    # Optional, defaults to the constraints below
-    "max_production",
-    "max_capacity_expansion",
-    "demand",
-    "search_space",
-    "minimum_service",
-    "demand_limiting_capacity"
-]
-demand_share = "standard_demand"  # Optional, default to standard_demand
+agents = '{path}/Agents.csv'
+existing_capacity = '{path}/residential/ExistingCapacity.csv'
 
 [sectors.power]
 type = 'default'
 priority = 2
-dispatch_production = 'share'
-technodata = '{path}/technodata/power/Technodata.csv'
-commodities_in = '{path}/technodata/power/CommIn.csv'
-commodities_out = '{path}/technodata/power/CommOut.csv'
+technodata = '{path}/power/Technodata.csv'
+commodities_in = '{path}/power/CommIn.csv'
+commodities_out = '{path}/power/CommOut.csv'
 
 [sectors.power.subsectors.all]
-agents = '{path}/technodata/Agents.csv'
-existing_capacity = '{path}/technodata/power/ExistingCapacity.csv'
-lpsolver = "scipy"
-demand_share = "standard_demand"
+agents = '{path}/Agents.csv'
+existing_capacity = '{path}/power/ExistingCapacity.csv'
 
 [sectors.gas]
 type = 'default'
 priority = 3
-dispatch_production = 'share'
-technodata = '{path}/technodata/gas/Technodata.csv'
-commodities_in = '{path}/technodata/gas/CommIn.csv'
-commodities_out = '{path}/technodata/gas/CommOut.csv'
+technodata = '{path}/gas/Technodata.csv'
+commodities_in = '{path}/gas/CommIn.csv'
+commodities_out = '{path}/gas/CommOut.csv'
 
 [sectors.gas.subsectors.all]
-agents = '{path}/technodata/Agents.csv'
-existing_capacity = '{path}/technodata/gas/ExistingCapacity.csv'
-lpsolver = "scipy"
-demand_share = "standard_demand"
+agents = '{path}/Agents.csv'
+existing_capacity = '{path}/gas/ExistingCapacity.csv'
 
 [sectors.residential_presets]
 type = 'presets'
 priority = 0
-consumption_path = "{path}/technodata/preset/*Consumption.csv"
+consumption_path = "{path}/residential_presets/*Consumption.csv"
 
-[timeslices]
-level_names = ["month", "day", "hour"]
+# Global outputs
+[[outputs]]
+quantity = "capacity"
+sink = "aggregate"
+filename = "{cwd}/{default_output_dir}/MCA{Quantity}.csv"
 
-[timeslices.all-year.all-week]
-night = 1460
-morning = 1460
-afternoon = 1460
-early-peak = 1460
-late-peak = 1460
-evening = 1460
+[[outputs]]
+quantity = "prices"
+sink = "aggregate"
+filename = "{cwd}/{default_output_dir}/MCA{Quantity}.csv"