More examples

data/examples/configs/basic.cfg

@@ -0,0 +1,56 @@
+# general info: identifier of scenario, appended to results
+scenario_name = basic_example
+
+##### Paths #####
+### Input and output files and paths ###
+# Input file containing trip information (required)
+schedule_path = data/examples/trips/trips_example.csv
+# Output files are stored here (defaults to: data/sim_outputs)
+# Attention: In Windows the path-length is limited to 256 characters!
+# Deactivate storage of output by setting output_path = null
+output_path = data/sim_outputs/
+# Electrified stations (required)
+electrified_stations_path = data/examples/electrified_stations/electrified_stations.json
+# Vehicle types (defaults to: ./data/examples/vehicle_types.json)
+vehicle_types_path = data/examples/vehicle_types/vehicle_types_constant_mileage.json
+# Cost parameters (needed if cost_calculation flag is set to true, see Flag section below)
+cost_parameters_path = data/examples/costs/cost_params.json
+
+##### Modes #####
+### Specify how you want to simulate the scenario ###
+# Options: sim, neg_depb_to_oppb, neg_oppb_to_depb, service_optimization.
+# sim runs a single simulation with the given inputs.
+# report generates simulation output files, including costs.
+mode = ["sim", "report"]
+
+##### Flags #####
+### Activate optional functions ###
+# Set flag for cost calculation: (default: false)
+cost_calculation = true
+# generate special plots in report mode (default: false)
+extended_output_plots = true
+
+##### Charging strategy #####
+# Preferred charging type. Options: depb, oppb (default: depb)
+preferred_charging_type = depb
+# strategy to use at depot and electrified station
+# refer to https://spice-ev.readthedocs.io/en/latest/charging_strategies_incentives.html
+strategy_deps = balanced
+strategy_opps = greedy
+
+# Cost calculation to use. Remove to use default for strategy.
+# Options: fixed_wo_plw, fixed_w_plw, variable_wo_plw, variable_w_plw, balanced_market, flex_window
+cost_calculation_method_deps = fixed_wo_plw
+cost_calculation_method_opps = fixed_wo_plw
+
+##### Physical setup of environment #####
+### Parametrization of the physical setup ###
+# Default max power [kW] of charging station at depot and opp stations (default at opps: 300)
+# At depot stations opp and depot busses have distinct charging stations (all deps default to: 150)
+# Individual cs_power per gc and cs type can be defined in electrified stations
+cs_power_opps = 300
+cs_power_deps_depb = 150
+cs_power_deps_oppb = 150
+# Set minimum allowed state of charge when leaving depot and opportunity stations (both default: 1)
+desired_soc_deps = 1.0
+desired_soc_opps = 1.0

data/examples/simba.cfg → data/examples/configs/extensive.cfg

@@ -1,31 +1,31 @@
 # general info: identifier of scenario, appended to results
-scenario_name = example
+scenario_name = extensive_example
 
 ##### Paths #####
 ### Input and output files and paths ###
 # Input file containing trip information (required)
-schedule_path = data/examples/trips_example.csv
+schedule_path = data/examples/trips/trips_example.csv
 # Output files are stored here (defaults to: data/sim_outputs)
 # Attention: In Windows the path-length is limited to 256 characters!
 # Deactivate storage of output by setting output_path = null
 output_path = data/sim_outputs/
 # Electrified stations (required)
-electrified_stations_path = data/examples/electrified_stations.json
+electrified_stations_path = data/examples/electrified_stations/electrified_stations.json
 # Vehicle types (defaults to: ./data/examples/vehicle_types.json)
-vehicle_types_path = data/examples/vehicle_types.json
+vehicle_types_path = data/examples/vehicle_types/vehicle_types.json
 # Path to station data with stations heights
 # (Optional: needed if mileage in vehicle types not constant and inclination should be considered)
-station_data_path =  data/examples/all_stations.csv
+station_data_path =  data/examples/consumption/all_stations.csv
 # Path to temperature csv. data with temperatures in deg Celsius over 0-23 hours
 # (Optional: needed if mileage in vehicle types not constant)
-outside_temperature_over_day_path =  data/examples/default_temp_winter.csv
+outside_temperature_over_day_path =  data/examples/consumption/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
+level_of_loading_over_day_path =  data/examples/consumption/default_level_of_loading_over_day.csv
 # Path to configuration file for the station optimization. Only needed for mode "station_optimization"
 optimizer_config_path = data/examples/default_optimizer.cfg
 # Cost parameters (needed if cost_calculation flag is set to true, see Flag section below)
-cost_parameters_path = data/examples/cost_params.json
+cost_parameters_path = data/examples/costs/cost_params.json
 # Path to rotation filter
 rotation_filter_path = data/examples/rotation_filter.csv
 
@@ -73,12 +73,13 @@ create_trips_in_report = false
 # Preferred charging type. Options: depb, oppb (default: depb)
 preferred_charging_type = depb
 # strategy to use at depot and electrified station
+# Options: greedy, balanced, balanced_market, peak_load_window, peak_shaving, flex_window, schedule
 # refer to https://spice-ev.readthedocs.io/en/latest/charging_strategies_incentives.html
 strategy_deps = balanced
 strategy_opps = greedy
 # additional options for depot or station strategies
 # refer to https://spice-ev.readthedocs.io/en/latest/simulating_with_spiceev.html#strategy-options
-strategy_options_deps = {"CONCURRENCY": 1}
+strategy_options_deps = {}
 strategy_options_opps = {}
 
 # Cost calculation to use. Remove to use default for strategy.
@@ -96,7 +97,7 @@ gc_power_deps = 100000
 # Default max power [kW] of charging station at depot and opp stations (default at opps: 300)
 # At depot stations opp and depot busses have distinct charging stations (all deps default to: 150)
 # Individual cs_power per gc and cs type can be defined in electrified stations
-cs_power_opps = 300
+cs_power_opps = 500
 cs_power_deps_depb = 150
 cs_power_deps_oppb = 150
 # Set minimum allowed state of charge when leaving depot and opportunity stations (both default: 1)
@@ -125,11 +126,12 @@ assign_strategy = "adaptive"
 # Default voltage level for charging stations if not set in electrified_stations file
 # Options: HV, HV/MV, MV, MV/LV, LV (default: MV)
 default_voltage_level = "MV"
-# use peak load windows from file to force lower power during times of high grid load
+# peak load time windows: load in these times are reduced either by applying 'peak_load_window'
+# strategy or by defining fixed 'peak_load_window_power' for deps and opps below (with any strategy)
 time_windows = data/examples/time_windows.json
-# reduced power of opp/depot stations during peak load windows
-peak_load_window_power_opps = 1000
+# reduced power of depot/opportunity stations during peak load windows
 peak_load_window_power_deps = 1000
+peak_load_window_power_opps = 1000
 # default values for generating new depot trips in mode split_negative_depb
 # average assumed vehicle speed in km/h
 default_mean_speed = 30
@@ -158,5 +160,5 @@ signal_time_dif = 10
 # Show estimated time to finish simulation after each step. Not recommended for fast computations
 # (default: false)
 eta = false
-# Save time by skipping often not needed flex_report in SpiceEV
-skip_flex_report = true
+# Save time by skipping often not needed flex_report in SpiceEV (default: false)
+create_flex_report = false

data/examples/configs/market_strategy.cfg

@@ -0,0 +1,60 @@
+# general info: identifier of scenario, appended to results
+scenario_name = market_example
+
+##### Paths #####
+### Input and output files and paths ###
+# Input file containing trip information (required)
+schedule_path = data/examples/trips/trips_example.csv
+# Output files are stored here (defaults to: data/sim_outputs)
+# Attention: In Windows the path-length is limited to 256 characters!
+# Deactivate storage of output by setting output_path = null
+output_path = data/sim_outputs/
+# Electrified stations (required)
+electrified_stations_path = data/examples/electrified_stations/electrified_stations_market.json
+# Vehicle types (defaults to: ./data/examples/vehicle_types.json)
+vehicle_types_path = data/examples/vehicle_types/vehicle_types_constant_mileage.json
+# Cost parameters (needed if cost_calculation flag is set to true, see Flag section below)
+cost_parameters_path = data/examples/costs/cost_params.json
+
+##### Modes #####
+### Specify how you want to simulate the scenario ###
+# Options: sim, neg_depb_to_oppb, neg_oppb_to_depb, service_optimization.
+# sim runs a single simulation with the given inputs.
+# report generates simulation output files, including costs.
+mode = ["sim", "report"]
+
+##### Flags #####
+### Activate optional functions ###
+# Set flag for cost calculation: (default: false)
+cost_calculation = true
+# generate special plots in report mode (default: false)
+extended_output_plots = true
+
+##### Charging strategy #####
+# Preferred charging type. Options: depb, oppb (default: depb)
+preferred_charging_type = depb
+# strategy to use at depot and electrified station
+# refer to https://spice-ev.readthedocs.io/en/latest/charging_strategies_incentives.html
+strategy_deps = balanced_market
+strategy_opps = greedy
+# additional options for depot or station strategies
+# refer to https://spice-ev.readthedocs.io/en/latest/simulating_with_spiceev.html#strategy-options
+strategy_options_deps = {"HORIZON":6}
+strategy_options_opps = {"HORIZON":6}
+
+# Cost calculation to use. Remove to use default for strategy.
+# Options: fixed_wo_plw, fixed_w_plw, variable_wo_plw, variable_w_plw, balanced_market, flex_window
+cost_calculation_method_deps = variable_wo_plw
+cost_calculation_method_opps = variable_wo_plw
+
+##### Physical setup of environment #####
+### Parametrization of the physical setup ###
+# Default max power [kW] of charging station at depot and opp stations (default at opps: 300)
+# At depot stations opp and depot busses have distinct charging stations (all deps default to: 150)
+# Individual cs_power per gc and cs type can be defined in electrified stations
+cs_power_opps = 300
+cs_power_deps_depb = 150
+cs_power_deps_oppb = 150
+# Set minimum allowed state of charge when leaving depot and opportunity stations (both default: 1)
+desired_soc_deps = 1.0
+desired_soc_opps = 1.0

data/examples/minimal.cfg → data/examples/configs/minimal.cfg

@@ -1,9 +1,9 @@
 ### Input and output files and paths ###
 # Input file containing trip information
-schedule_path = data/examples/trips_example.csv
+schedule_path = data/examples/trips/trips_example_small.csv
 # Electrified stations
-electrified_stations_path = data/examples/electrified_stations.json
+electrified_stations_path = data/examples/electrified_stations/electrified_stations_minimal.json
 # Vehicle types
 # Not strictly needed (defaults to: ./data/examples/vehicle_types.json),
 # but if vehicle types have constant mileage, no other mileage files are needed
-vehicle_types_path = data/examples/vehicle_types_constant_mileage.json
+vehicle_types_path = data/examples/vehicle_types/vehicle_types_constant_mileage.json

data/examples/minimal_pickle.cfg → data/examples/configs/minimal_pickle.cfg

@@ -1,5 +1,5 @@
 mode = ["load_pickle", "report"]
 # Load this pickle file, expects load_pickle as first mode
-# to try this mode, first create a pickle file with another exmple using
+# to try this mode, first create a pickle file with another example using
 # "create_pickle_in_report = true", then copy link to pickle file here
 load_pickle_path = scenario.pkl

data/examples/configs/neg_depb_to_oppb.cfg

@@ -0,0 +1,49 @@
+# general info: identifier of scenario, appended to results
+scenario_name = neg_depb_to_oppb_example
+
+##### Paths #####
+### Input and output files and paths ###
+# Input file containing trip information (required)
+schedule_path = data/examples/trips/trips_example.csv
+# Output files are stored here (defaults to: data/sim_outputs)
+# Attention: In Windows the path-length is limited to 256 characters!
+# Deactivate storage of output by setting output_path = null
+output_path = data/sim_outputs/
+# Electrified stations (required)
+electrified_stations_path = data/examples/electrified_stations/electrified_stations_minimal.json
+# Vehicle types (defaults to: ./data/examples/vehicle_types.json)
+vehicle_types_path = data/examples/vehicle_types/vehicle_types_constant_mileage.json
+
+##### Modes #####
+### Specify how you want to simulate the scenario ###
+# Options: sim, neg_depb_to_oppb, neg_oppb_to_depb, service_optimization.
+# sim runs a single simulation with the given inputs.
+# report generates simulation output files, including costs.
+mode = ["sim", "report", "neg_depb_to_oppb", "report"]
+#mode = ["sim", "load_pickle", "neg_depb_to_oppb", "service_optimization", "station_optimization", "remove_negative", "split_negative_depb", "report"]
+
+
+##### Charging strategy #####
+# Preferred charging type. Options: depb, oppb (default: depb)
+preferred_charging_type = depb
+# strategy to use at depot and electrified station
+# refer to https://spice-ev.readthedocs.io/en/latest/charging_strategies_incentives.html
+strategy_deps = balanced
+strategy_opps = greedy
+
+# Cost calculation to use. Remove to use default for strategy.
+# Options: fixed_wo_plw, fixed_w_plw, variable_wo_plw, variable_w_plw, balanced_market, flex_window
+cost_calculation_method_deps = fixed_wo_plw
+cost_calculation_method_opps = fixed_wo_plw
+
+##### Physical setup of environment #####
+### Parametrization of the physical setup ###
+# Default max power [kW] of charging station at depot and opp stations (default at opps: 300)
+# At depot stations opp and depot busses have distinct charging stations (all deps default to: 150)
+# Individual cs_power per gc and cs type can be defined in electrified stations
+cs_power_opps = 500
+cs_power_deps_depb = 150
+cs_power_deps_oppb = 150
+# Set minimum allowed state of charge when leaving depot and opportunity stations (both default: 1)
+desired_soc_deps = 1.0
+desired_soc_opps = 1.0

data/examples/configs/plw_market_strategy.cfg

@@ -0,0 +1,67 @@
+# general info: identifier of scenario, appended to results
+scenario_name = plw_market_example
+
+##### Paths #####
+### Input and output files and paths ###
+# Input file containing trip information (required)
+schedule_path = data/examples/trips/trips_example.csv
+# Output files are stored here (defaults to: data/sim_outputs)
+# Attention: In Windows the path-length is limited to 256 characters!
+# Deactivate storage of output by setting output_path = null
+output_path = data/sim_outputs/
+# Electrified stations (required)
+electrified_stations_path = data/examples/electrified_stations/electrified_stations_minimal.json
+# Vehicle types (defaults to: ./data/examples/vehicle_types.json)
+vehicle_types_path = data/examples/vehicle_types/vehicle_types_constant_mileage.json
+# Cost parameters (needed if cost_calculation flag is set to true, see Flag section below)
+cost_parameters_path = data/examples/costs/cost_params.json
+
+##### Modes #####
+### Specify how you want to simulate the scenario ###
+# Options: sim, neg_depb_to_oppb, neg_oppb_to_depb, service_optimization.
+# sim runs a single simulation with the given inputs.
+# report generates simulation output files, including costs.
+mode = ["sim", "report"]
+
+##### Flags #####
+### Activate optional functions ###
+# Set flag for cost calculation: (default: false)
+cost_calculation = true
+# generate special plots in report mode (default: false)
+extended_output_plots = true
+
+##### Charging strategy #####
+# Preferred charging type. Options: depb, oppb (default: depb)
+preferred_charging_type = depb
+# strategy to use at depot and electrified station
+# Options: greedy, balanced, balanced_market, peak_load_window, peak_shaving, flex_window, schedule
+# refer to https://spice-ev.readthedocs.io/en/latest/charging_strategies_incentives.html
+strategy_deps = balanced_market
+strategy_opps = balanced_market
+# additional options for depot or station strategies
+# refer to https://spice-ev.readthedocs.io/en/latest/simulating_with_spiceev.html#strategy-options
+strategy_options_deps = {"HORIZON":6}
+strategy_options_opps = {"HORIZON":6}
+
+# Cost calculation to use. Remove to use default for strategy.
+# Options: fixed_wo_plw, fixed_w_plw, variable_wo_plw, variable_w_plw, balanced_market, flex_window
+cost_calculation_method_deps = variable_w_plw
+cost_calculation_method_opps = variable_w_plw
+
+##### Physical setup of environment #####
+### Parametrization of the physical setup ###
+# Default max power [kW] of charging station at depot and opp stations (default at opps: 300)
+# At depot stations opp and depot busses have distinct charging stations (all deps default to: 150)
+# Individual cs_power per gc and cs type can be defined in electrified stations
+cs_power_opps = 300
+cs_power_deps_depb = 150
+cs_power_deps_oppb = 150
+# Set minimum allowed state of charge when leaving depot and opportunity stations (both default: 1)
+desired_soc_deps = 1.0
+desired_soc_opps = 1.0
+# peak load time windows: load in these times are reduced either by applying 'peak_load_window'
+# strategy or by defining fixed 'peak_load_window_power' for deps and opps below (with any strategy)
+time_windows = data/examples/time_windows.json
+# reduced power of depot/opportunity stations during peak load windows
+peak_load_window_power_deps = 0
+peak_load_window_power_opps = 0