rl-institut · j-brendel · Jan 18, 2023 · Jan 18, 2023 · Jan 19, 2023 · Jan 30, 2023
diff --git a/.gitignore b/.gitignore
@@ -9,10 +9,11 @@ __pycache__
 docs/_build
 docs/source/temp
 
-data/*
-!data/examples
+data/private_examples
+data/sim_outputs
+data/private_examples
+data/gogs_buffered
 
 src/
 spice_ev/
 *.bak
-/tests/test_output_files/
diff --git a/README.md b/README.md
@@ -10,9 +10,9 @@ To try it out, first clone this repository and then install the required package
 
 `pip install -r requirements.txt` 
 
-Now you can start the eBus Toolbox module with all configurations stored at `data/examples/ebus_toolbox.cfg` via the command
+Now you can start the eBus Toolbox module with all configurations stored at `data/configs/ebus_toolbox.cfg` via the command
 
-``python -m ebus_toolbox --config data/examples/ebus_toolbox.cfg``
+``python -m ebus_toolbox --config data/configs/ebus_toolbox.cfg``
 
 The repo provides an example for each necessary input file, so the example case can be executed without the need for the user to provide any data themselves.
 

diff --git a/data/examples/default_optimizer.cfg b/data/examples/default_optimizer.cfg
diff --git a/data/examples/ebus_toolbox.cfg b/data/examples/ebus_toolbox.cfg
@@ -17,23 +17,19 @@ outside_temperature_over_day_path =  data/examples/default_temp_winter.csv
 # Path to level of loading csv. data with temperatures in deg Celsius over 0-23 hours
 # (Optional: needed if mileage in vehicle types not constant)
 level_of_loading_over_day_path =  data/examples/default_level_of_loading_over_day.csv
-# Path to configuration file for the station optimization. Only needed for mode "station_optimization"
-optimizer_config = data/examples/default_optimizer.cfg
 # Cost parameters (needed if cost_calculation flag is set to true, see Flag section below)
 cost_parameters_file = data/examples/cost_params.json
 
 ##### Modes #####
-### Specify how you want to simulate the scenario ###
+### Specify how you want to simulate the szenario ###
 # Options: sim, neg_depb_to_oppb, neg_oppb_to_depb, service_optimization.
 # sim runs a single simulation with the given inputs.
 # neg_depb_to_oppb changes negative depb-rotations to oppb charging.
 # neg_oppb_to_depb changes negative oppb-rotations to depb charging.
 # service_optimization finds the largest set of electrified rotations, rotations SOC<0 are removed.
-# station_optimization finds the set of fewest stations to electrify all rotations.
-# remove_negative removes all negative rotations.
 # report generates simulation output files, including costs.
 mode = ["sim", "report"]
-#mode = ["sim", "neg_depb_to_oppb", "service_optimization", "station_optimization", "remove_negative", "report"]
+#mode = ["sim", "neg_depb_to_oppb", "service_optimization", "report"]
 
 ##### Flags #####
 ### Activate optional functions ###
@@ -80,10 +76,10 @@ default_buffer_time_opps = 0
 # Options: HV, HV/MV, MV, MV/LV, LV (default: MV)
 default_voltage_level = "MV"
 
-##### SIMULATION PARAMETERS #####
+##### Simulation Parameters #####
 # Maximum number of days to simulate, if not set simulate entire schedule
 #days = 10
-# Set length of time step in minutes (default: 1)
+# Set length of timestep in minutes (default: 1)
 interval = 1
 # Time difference between signal time and actual start time of a vehicle event in min. (default: 10)
 signal_time_dif = 10

diff --git a/data/examples/optimizer.cfg b/data/examples/optimizer.cfg
@@ -0,0 +1,71 @@
+# Configs for the eBus Toolbox Optimizer
+[DEFAULT]
+debug_level=1
+
+[SCENARIO]
+# Use "" for ids and not ''
+exclusion_rots = ["6003_6", "7003_7"]
+exclusion_stations=  []
+# If using inclusion stations, scenario should be rebased
+inclusion_stations= []
+standard_opp_station={"type": "opps", "n_charging_stations": 200,"distance_transformer": 50,
+        "voltage_level": "MV"}
+
+[PICKLE]
+schedule=schedule_neg_dep_to_oppb_buffered_only_depot.pickle
+scenario=scenario_neg_dep_to_oppb_buffered_only_depot.pickle
+args=args_neg_dep_to_oppb_buffered_only_depot.pickle
+# schedule=schedule_buffered_all_oppb.pickle
+# scenario=scenario_buffered_all_oppb.pickle
+# args=args_buffered_all_oppb.pickle
+# schedule=schedule_buffered_depots_utf.pickle
+# scenario=scenario_buffered_depots_utf.pickle
+# args=args_buffered_utf.pickle
+
+
+[VEHICLE]
+charge_eff = 0.95
+# battery_capacity = 400
+# charging_curve = [[0, 450], [0.8, 296], [0.9, 210], [1, 20]]
+# charging_power = 250
+# min_soc=0.05
+
+[OPTIMIZER]
+# Not optional path to outputs of optimizer
+output_path=data/private_examples/332_Buffered/optimization
+save_all_results=True
+# "quick" or "spiceev"
+solver = quick
+rebase_scenario = False
+pickle_rebased= False
+pickle_rebased_name=buffered_rebase_all_electrified
+run_only_neg=False
+pruning_threshold=0
+
+# "greedy" or "deep" without ""
+opt_type = deep
+# "step-by-step" or "brute" without ""
+node_choice=step-by-step
+max_brute_loop=300
+estimation_threshold = 0.90
+
+# Preferring deps leads to a spice_ev simulation with preferred charging type depots
+# Afterwards all negative rotations are swapped to opportunity chargers and optimized
+# prefer_deps=True
+
+# Removing impossible rotations leads to a quick calculation estimating if rotations are impossible.impossible
+# If they are deemed as impossible, they are not optimized but discarded
+remove_impossible_rots=True
+check_for_must_stations=True
+include_must_stations = True
+
+
+
+[SPECIAL]
+decision_tree_path = ""
+save_decision_tree = False
+reduce_rots = False
+# Use "" for ids and not ''
+# Negative Rots in all deps
+rots = ["0310b_3", "0317_3", "0308_3", "0301b_5", "0404b_4", "0301b_2", "0802b_5", "0401b_4", "7401_7", "0702b_3", "0307a_3", "0307a_1", "0404a_3", "0711_3", "0817_2", "6002a_6", "6302_6", "6306b_6", "0302a_1", "0308_2", "0811_4", "0307b_5", "0705_5", "0801a_4", "0711_4", "0303_3", "0705_3", "0402_5", "0304_2", "0304_3", "0801a_1", "0314_4", "0002_1", "7310a_7", "0811_3", "6711_6", "0301a_5", "0301b_1", "0403_4", "0310b_4", "0701a_2", "0303_1", "0311a_3", "0711_1", "0317_1", "0318_5", "0305_2", "0402_4", "0002_4", "0403_5", "0801a_3", "0310a_2", "0803b_2", "0314_5", "0702b_5", "0701a_1", "0401b_5", "0005a_5", "0801b_5", "0310a_4", "0311a_5", "0311a_4", "0404b_1", "0014b_2", "0803b_5", "0306a_4", "0726_5", "0318_1", "0005a_2", "0303_5", "0308_4", "0002_3", "0306a_3", "0307a_4", "0701a_4", "0401a_4", "6403_6", "0404a_2", "6309a_6", "0314_3", "0317_4", "0401a_2", "0705_1", "0310b_1", "0701a_5", "0310a_1", "0404a_1", "0302a_5", "6305a_6", "0817_4", "0312a_1", "0301a_2", "0705_4", "0305_1", "0312a_4", "0702b_2", "0302b_5", "0005a_4", "6001a_6", "0003b_1", "0301b_4", "0310a_3", "6003_6", "0302a_2", "0817_3", "0404b_5", "0403_2", "0317_5", "0817_1", "0401b_3", "0003b_3", "0726_1", "0701a_3", "7005_7", "0311a_2", "0307b_3", "0301b_3", "0314_2", "6310b_6", "0803b_3", "0014b_1", "0401a_3", "0306a_1", "0305_5", "6303a_6", "6401_6", "0303_2", "6301_6", "0005a_3", "0404a_4", "0312a_2", "0302a_4", "7402_7", "0401b_2", "0301a_1", "0402_2", "0014b_3", "0307b_1", "0803b_1", "6002b_6", "0303_4", "6310a_6", "0302a_3", "0318_4", "7811_7", "0306a_2", "0312a_3", "0308_5", "0014b_4", "0310a_5", "0319_1", "0310b_5", "0705_2", "0002_2", "7702b_7", "7711_7", "0811_2", "0403_1", "0319_3", "0317_2", "0726_3", "0404a_5", "0726_4", "0307b_2", "6901_6", "0319_4", "0005b_5", "0305_4", "6702b_6", "7002b_7", "0304_5", "0305_3", "0003b_2", "0401b_1", "0801a_5", "0301a_3", "0402_1", "0005a_1", "0319_5", "6306a_6", "0319_2", "0311a_1", "0401a_5", "0003b_5", "0307a_5", "0307a_2", "0301a_4", "0318_3", "0308_1", "0726_2", "0803b_4", "6001b_6", "0401a_1", "0312a_5", "6703b_6", "0711_2", "0811_1", "0702b_1", "0314_1", "0014b_5", "0310b_2", "0404b_2", "0003b_4", "0307b_4", "0304_1", "0306a_5", "0811_5", "0403_3", "0318_2", "0402_3", "0817_5", "0404b_3", "0702b_4", "0711_5", "7003_7", "0002_5", "0304_4", "0801a_2"]
+
diff --git a/data/examples/vehicle_types.json b/data/examples/vehicle_types.json
@@ -6,8 +6,7 @@
             "charging_curve": [[0, 150], [0.8, 150], [1, 15]],
             "min_charging_power": 0,
             "v2g": false,
-            "mileage": "data/examples/energy_consumption_example.csv",
-            "battery_efficiency": 0.95  // optional. default: 0.95
+            "mileage": "data/examples/energy_consumption_example.csv"
         },
         "oppb": {
             "name": "articulated bus - opportunity charging",
@@ -35,5 +34,25 @@
             "v2g": false,
             "mileage": "data/examples/energy_consumption_example.csv"
         }
+    },
+	"BVG-GE": {
+        "depb": {
+            "name": "articulated bus",
+            "capacity": 400,
+            "charging_curve": [[0, 450], [0.8, 296], [0.9, 210], [1, 20]],
+            "min_charging_power": 0,
+            "v2g": false,
+            "mileage": 3,
+            "hc": "winter"
+        },
+        "oppb": {
+            "name": "articulated bus",
+            "capacity": 400,
+            "charging_curve": [[0, 450], [0.8, 296], [0.9, 210], [1, 20]],
+            "min_charging_power": 0,
+            "v2g": false,
+            "mileage": 3,
+            "hc": "winter"
+        }
     }
-}
+}
diff --git a/docs/_static/style.css b/docs/_static/style.css
@@ -1,3 +1,19 @@
 .wy-nav-content {
     max-width: none;
 }
+
+/* override table width restrictions */
+.wy-table-responsive table td, .wy-table-responsive table th {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+}
+
+.wy-table-responsive {
+    overflow: visible !important;
+}
+
+table {
+  table-layout: auto;
+  width: 800px;
+}
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
-set BUILDDIR=_build
+set SOURCEDIR=source
+set BUILDDIR=build
 
 if "%1" == "" goto help
 

diff --git a/docs/source/_static/PyCharm_Configuration.png b/docs/source/_static/PyCharm_Configuration.png
diff --git a/docs/source/_static/SimBA_logo.png b/docs/source/_static/SimBA_logo.png
diff --git a/docs/source/_static/SimBA_module_overview.png b/docs/source/_static/SimBA_module_overview.png
diff --git a/docs/source/_static/run_overview.png b/docs/source/_static/run_overview.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -9,11 +9,23 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
+# for example
+
+
+#If conf.py is located in this directory,
+#
+#D:\\Projects\MyProject\Docs\source
+#
+#and the project's Python modules are in
 #
+#D:\\Projects\MyProject\SourceCode,
+
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
-
+import pathlib
+sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
+sys.path.insert(0, os.path.abspath('C:/Users/paul.scheer/Python/spiceev'))
 
 # -- Project information -----------------------------------------------------
 
@@ -30,8 +42,8 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary']
-
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary','sphinx.ext.autosectionlabel']
+numfig = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
 
@@ -55,5 +67,5 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['../_static']
 html_css_files = ['style.css']