Update settings and documentation

tsmbland · tsmbland · commit 2cf48b12539a · 2025-02-04T13:29:33.000Z
diff --git a/docs/inputs/toml.rst b/docs/inputs/toml.rst
@@ -24,7 +24,6 @@ a whole.
 .. code-block:: TOML
 
    time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-   foresight = 5
    regions = ["USA"]
    interest_rate = 0.1
    interpolation_mode = 'Active'
@@ -38,10 +37,6 @@ a whole.
 *time_framework*
    Required. List of years for which the simulation will run.
 
-*foresight*
-   Required. Integer defining the number of years at which prices are updated at every iteration.
-   It needs to equal or be a multiple of the interval of years in the *time_framework*. Default to 5 years.
-
 *region*
    Subset of regions to consider. If not given, defaults to all regions found in the
    simulation data.
diff --git a/docs/tutorial-code/add-agent/1-single-objective/settings.toml b/docs/tutorial-code/add-agent/1-single-objective/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/add-agent/2-multiple-objective/settings.toml b/docs/tutorial-code/add-agent/2-multiple-objective/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/add-correlation-demand/1-correlation/settings.toml b/docs/tutorial-code/add-correlation-demand/1-correlation/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/add-new-technology/1-introduction/settings.toml b/docs/tutorial-code/add-new-technology/1-introduction/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/add-new-technology/2-scenario/settings.toml b/docs/tutorial-code/add-new-technology/2-scenario/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/add-region/1-new-region/settings.toml b/docs/tutorial-code/add-region/1-new-region/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1", "R2"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
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
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/carbon-budget/1-carbon-budget/settings.toml b/docs/tutorial-code/carbon-budget/1-carbon-budget/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
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
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
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
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
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
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
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
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2022, 2024, 2026, 2028, 2030, 2032, 2034, 2036, 2038, 2040]
-foresight = 2  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/docs/tutorial-code/new-decision-metric/settings.toml b/docs/tutorial-code/new-decision-metric/settings.toml
@@ -1,7 +1,6 @@
 plugins = "{path}/new_decision.py"
 # Global settings - most REQUIRED
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/src/muse/data/default_settings.toml b/src/muse/data/default_settings.toml
@@ -1,9 +1,6 @@
 # Global settings
 
 time_framework = 'REQUIRED'
-# foresight must  be a multiple of the minimum separation between the years in time
-# framework
-foresight = 'REQUIRED'
 regions = 'REQUIRED'
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/src/muse/data/example/default/settings.toml b/src/muse/data/example/default/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
@@ -68,6 +67,11 @@ existing_capacity = '{path}/technodata/power/ExistingCapacity.csv'
 lpsolver = "scipy"
 demand_share = "standard_demand"
 
+[[sectors.power.outputs]]
+quantity = "supply"
+sink = "aggregate"
+filename = "{cwd}/{default_output_dir}/{Sector}_{Quantity}.csv"
+
 [sectors.gas]
 type = 'default'
 priority = 3
diff --git a/src/muse/data/example/default_retro/settings.toml b/src/muse/data/example/default_retro/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/src/muse/data/example/default_timeslice/settings.toml b/src/muse/data/example/default_timeslice/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035, 2040, 2045, 2050]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/src/muse/data/example/minimum_service/settings.toml b/src/muse/data/example/minimum_service/settings.toml
@@ -1,8 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2010, 2015, 2020, 2025, 2030, 2035, 2040, 2045, 2050]
-# Has to be a multiple of the minimum separation between the years in time framework
-foresight = 5
 regions = ["R1"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
diff --git a/src/muse/data/example/trade/settings.toml b/src/muse/data/example/trade/settings.toml
@@ -1,7 +1,6 @@
 # Global settings - most REQUIRED
 
 time_framework = [2020, 2025, 2030, 2035]
-foresight = 5  # Has to be a multiple of the minimum separation between the years in time framework
 regions = ["R1", "R2"]
 interest_rate = 0.1
 interpolation_mode = 'Active'
