Include review changes

data/examples/default_optimizer.cfg

@@ -8,17 +8,17 @@ debug_level = 1
 console_level = 99
 
 #SCENARIO
-# Use "" for ids and not ''
-# these rotations are excluded from optimization. they will not be simulated
+# Use "" for ids and not ''.
+# These rotations are excluded from optimization. They will not be simulated.
 exclusion_rots = []
 
-# these stations are excluded from optimization. optimization will not electrify them
+# These stations are excluded from optimization. optimization will not electrify them.
 exclusion_stations = []
-# optimization will electrify these stations.
-# if using inclusion stations, scenario should be rebased
+# Optimization will electrify these stations.
+# if using inclusion stations, scenario should be rebased.
 inclusion_stations = []
 standard_opp_station = {"type": "opps", "n_charging_stations": null}
-# rotations which drop below this value are considered not electrified (default value is 0)
+# rotations which drop below this value are considered not electrified (default value is 0).
 min_soc = 0.05
 
 #OPTIMIZER
@@ -31,44 +31,44 @@ solver = quick
 
 # Optimization procedure is developed from the input schedule and scenario. If the scenario is changed
 # through this configuration rebasing should be set to true. This will simulate the scenario again with the
-# given settings
+# given settings.
 rebase_scenario = False
 
-# the rebased scenario can be pickled for analysis or repeated use
+# The rebased scenario can be pickled for analysis or repeated use.
 pickle_rebased = False
-# the name of this pickle file can be defined here
+# The name of this pickle file can be defined here.
 pickle_rebased_name = ""
 # Should all rotations be rebased or can rotations which stay above the soc threshold be skipped?
 run_only_neg = False
-# Should only be opportunity vehicles be rebased, since this optimization is not meant for depot chargers
-# The depot chargers will be added to the returned schedule in any case
+# Should only be opportunity vehicles be rebased, since this optimization is not meant for depot chargers?
+# The optimization will return ALL original rotations of the input in all cases.
 run_only_oppb = True
-# number of stations before optimal solution, where branch is checked for pruning
+# number of stations before optimal solution, where branch is checked for pruning.
 pruning_threshold = 3
 
 # Optimization type greedy runs the optimization a single time as greedy as impossible
-# Deep repeatedly searches for promising nodes but only new nodes which have not
-# been checked before.
-# "greedy" or "deep" without ""
+# Deep repeatedly searches for promising nodes but only new nodes which have not been checked before.
+# "greedy" or "deep" without "".
 opt_type = greedy
 
-# For Deep optimization only
+# For Deep optimization only:
+#############################
 # How should the deep optimization choose the nodes.
-# Brute is only recommended in smaller systems
-# "step-by-step" or "brute" without ""
+# Brute is only recommended in smaller systems.
+# "step-by-step" or "brute" without "".
 node_choice = step-by-step
-# How many combinations is the deep method allowed to check
+# How many combinations is the deep method allowed to check?
 max_brute_loop = 300
 # Factor with which the potential evaluation is multiplied before comparing it to the missing energy. A low estimation
-# threshold will lead to a more conservative approach in dismissing branches
+# threshold will lead to a more conservative approach in dismissing branches.
 estimation_threshold = 0.80
 
 
-# Removing impossible rotations leads to a quick calculation estimating if rotations are impossible.impossible
+# Removing impossible rotations leads to a quick calculation estimating if rotations are impossible.
 # If they are deemed as impossible, they are not optimized but discarded during optimization.
-# They will be added to the returned schedule in any case.
+# The optimization will return ALL original rotations of the input in all cases.
 remove_impossible_rotations = True
-# Check if stations are mandatory for a fully electrified system. If they are, include them
+# Check if stations are mandatory for a fully electrified system. If they are, include them.
 check_for_must_stations = False