ChaProEV 1.2.0__tar.gz → 1.2.2__tar.gz

{chaproev-1.2.0/src/ChaProEV.egg-info → chaproev-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ChaProEV
-Version: 1.2.0
+Version: 1.2.2
 Summary: ChaProEV: Charging Profiles of Electric Vehicles
 Author-email: Omar Usmani <Omar.Usmani@TNO.nl>
 Project-URL: Homepage, https://github.com/TNO/ChaProEV

chaproev-1.2.2/docs/scenario.md

@@ -0,0 +1,94 @@
+# Scenario file description
+
+This page describes the elements of the scenario file
+
+## run
+Run parameters give the elements to produce the time tags of the run range.
+### use_day_types_in_charge_computing 
+If set to true, the charging computations will be done per day type rather
+than for all days of the run, which fastens the computations.
+### start
+This part gives the year, month, day, hour, and minute of the start of the
+computations. It is best to set this to a day hour start for consistency
+and then cut off the start for display (see below). For example,
+start on 31/12/2019 at 05:00 if your day start hour is 05:00 and if you want
+to show results starting on 1/1/2020 at 00:00.
+### end
+This part gives the year, month, day, hour, and minute of the end of the
+computations. Note that the end time tag is not included in the run,
+so put 1/1/2021 at 00:00 if you want to compute for 2020.
+### display_start
+This is the first time tag you want to show in your end results.
+### display_end
+This is the first time tag that does not appear in your displayed results.
+### frequency
+The time frequency of the run (size and type).
+For the type, use 'H' for hours, 'min' for minutes,
+'S' for seconds, 'D' for days. For more info and other types, see 
+[here](https://pandas.pydata.org/docs/user_guide/timeseries.html#timeseries-offset-aliases).
+The current model uses  hourly (so 1 and 'h'). Changing that might require
+some adjustments in the code.
+### display frequency
+The frequency of the displayed values can be different than the frequency of the compuatations.
+In the current version, this needs to be the same or less frequent than the computation frequencey above.
+### extra_downloads
+This is to decide if you want to dowload some files (note that this concerns the
+currently inactive weather module).
+## locations
+
+## legs
+
+### mix
+
+## vehicle
+These parameters define the scenario's vehicle. If you want profiles
+for several vehicles, run separate scenarios.
+### vehicle name
+This is the name of the vehicle, which will be checked to see if trips
+and locations are actually declared.
+
+## trips
+
+## mobility_module
+### day_start_hour
+This parameter defines the start of the day for the scenario. It is chosen
+so that there are no movements during that hour number. It represents the
+shift from midnight, so a day start hour of 5 means that the day starts
+at hour 5 (i.e. 05.00). The idea is to choose an hour that is logical
+for the users/matches their patterns. This is connected to the 
+[day types](day_types), as a given day will correspond to a day type.
+For example, the hours between 00:00 and 05:00 on a Saturday belong to
+the Thursday before and are as such on a week day 
+(as opposed to a weekend day).
+
+### day_types
+
+### trips_per_day_type
+For vehicles other than cars, we assume that there is one trip per day type.
+This is where we match the trips to their day type
+
+## transport_factors
+
+### road_types
+
+### weights
+
+## weather
+
+## charging
+
+## plots
+
+## files
+
+## maps
+
+## colors
+
+## color_bars
+
+## unit_conversion
+
+## time
+
+## numbers

{chaproev-1.2.0 → chaproev-1.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'ChaProEV'
-version = '1.2.0'
+version = '1.2.2'
 authors = [
   { name='Omar Usmani', email='Omar.Usmani@TNO.nl' },
 ]

{chaproev-1.2.0 → chaproev-1.2.2}/scenarios/Mopo/XX_bus.toml

@@ -189,8 +189,9 @@ mix = [0.8, 0.2]
 
 [legs.bus_from_route_start_to_route_end]
 vehicle = 'bus'
-distance = 20  # km
-duration = 0.5  # hours
+distance = 13  # km
+duration = 0.66  # hours
+# Bus 28 in The Hague has a 40 minute route that is about 10-15 km (value chosen to be close to 90_000 kilometers per year)
 # This factor adds a correction to the vehicle consumption that depends
 # on the hour in day (the first is for 00:00 to 00:59,
 # the last for 23:00 to 23:59). Note that these are actual hours,
@@ -217,8 +218,9 @@ mix = [0.8, 0.2]
 
 [legs.bus_from_route_end_to_route_start]
 vehicle = 'bus'
-distance = 20  # km
-duration = 0.5  # hours
+distance = 13  # km
+duration = 0.66  # hours
+# Bus 28 in The Hague has a 40 minute route that is about 10-15 km (value chosen to be close to 90_000 kilometers per year)
 # This factor adds a correction to the vehicle consumption that depends
 # on the hour in day (the first is for 00:00 to 00:59,
 # the last for 23:00 to 23:59). Note that these are actual hours,
@@ -244,20 +246,27 @@ mix = [0.8, 0.2]
 
 
 
+
 [vehicle]
 name = 'bus'
 base_location = 'bus_depot' # not relevant for cars
-yearly_kilometrage = 42_000
+yearly_kilometrage = 90_000
+# https://www.ebusco.com/wp-content/uploads/Website_Brochure_NL_V1-4.pdf
 # Not relevant for cars, as it is built bottom-up
 kilometers_column_for_consumption = 'Arrivals'
 use_weighted = false
-battery_capacity = 80  # kWh
+battery_capacity = 500  # kWh
+# https://www.ebusco.com/wp-content/uploads/Website_Brochure_NL_V1-4.pdf
 solar_panel_size_kWp = 0  # kWp
 [vehicle.base_consumption_per_km]
-electricity_kWh = 0.2
-gasoline_litres = 0.075
-diesel_litres = 0.05
-hydrogen_kg = 0.006340
+electricity_kWh = 0.76
+# https://www.ebusco.com/wp-content/uploads/Website_Brochure_NL_V1-4.pdf
+# Others scaled accroding to cars
+gasoline_litres = 0.3399
+diesel_litres = 0.2917
+hydrogen_kg = 0.0398
+CNG_kg = 0.2415
+LNG_kg = 0.2415
 
 [trips]
 
@@ -268,18 +277,14 @@ legs = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start',
     'bus_from_route_start_to_depot',
-    'bus_from_depot_to_route_start',
-    'bus_from_route_start_to_route_end',
-    'bus_from_route_end_to_route_start',
-    'bus_from_route_start_to_depot',
 ]
-time_between_legs = [0, 0.25, 0, 4, 0, 0.25, 0]
+time_between_legs = [0, 0.1, 0]
 
 # This is the time spent at each interim location (same units as used
 # general
 percentage_station_users = 0
 start_probabilities = [
-    0, 0, 0.25, 0.5, 0.25, 0, 0, 0,
+    0, 0.5, 0.5, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0
 ]  # Start at day start hour
@@ -287,8 +292,8 @@ repeated_sequence = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start'
     ]
-repetition_amounts = [3, 3]
-time_between_repetitions = [0.1, 0.22] # hours
+repetition_amounts = [9]
+time_between_repetitions = [0.1] # hours
 
 [trips.bus_weekend_in_workweek]
 vehicle = 'bus'
@@ -297,17 +302,14 @@ legs = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start',
     'bus_from_route_start_to_depot',
-    'bus_from_depot_to_route_start',
-    'bus_from_route_start_to_route_end',
-    'bus_from_route_end_to_route_start',
-    'bus_from_route_start_to_depot',
 ]
-time_between_legs = [0, 0.25, 0, 4, 0, 0.25, 0]
+time_between_legs = [0, 0.1, 0]
+
 # This is the time spent at each interim location (same units as used
 # general
 percentage_station_users = 0
 start_probabilities = [
-    0, 0, 0.25, 0.5, 0.25, 0, 0, 0,
+    0, 0.25, 0.5, 0.25, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0
 ]  # Start at day start hour
@@ -315,8 +317,8 @@ repeated_sequence = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start'
     ]
-repetition_amounts = [2, 2]
-time_between_repetitions = [0.1, 0.22] # hours
+repetition_amounts = [7]
+time_between_repetitions = [0.1] # hours
 
 
 [trips.bus_weekday_in_holiday_week]
@@ -326,18 +328,14 @@ legs = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start',
     'bus_from_route_start_to_depot',
-    'bus_from_depot_to_route_start',
-    'bus_from_route_start_to_route_end',
-    'bus_from_route_end_to_route_start',
-    'bus_from_route_start_to_depot',
 ]
-time_between_legs = [0, 0.25, 0, 4, 0, 0.25, 0]
+time_between_legs = [0, 0.1, 0]
 
 # This is the time spent at each interim location (same units as used
 # general
 percentage_station_users = 0
 start_probabilities = [
-    0, 0, 0.25, 0.5, 0.25, 0, 0, 0,
+    0, 0.25, 0.75, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0
 ]  # Start at day start hour
@@ -345,8 +343,8 @@ repeated_sequence = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start'
     ]
-repetition_amounts = [2, 2]
-time_between_repetitions = [0.2, 0.42] # hours
+repetition_amounts = [8]
+time_between_repetitions = [0.1] # hours
 
 [trips.bus_weekend_in_holiday_week]
 vehicle = 'bus'
@@ -355,17 +353,14 @@ legs = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start',
     'bus_from_route_start_to_depot',
-    'bus_from_depot_to_route_start',
-    'bus_from_route_start_to_route_end',
-    'bus_from_route_end_to_route_start',
-    'bus_from_route_start_to_depot',
 ]
-time_between_legs = [0, 0.25, 0, 4, 0, 0.25, 0]
+time_between_legs = [0, 0.1, 0]
+
 # This is the time spent at each interim location (same units as used
 # general
 percentage_station_users = 0
 start_probabilities = [
-    0, 0, 0.25, 0.5, 0.25, 0, 0, 0,
+    0, 0.25, 0.5, 0.25, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0
 ]  # Start at day start hour
@@ -373,8 +368,8 @@ repeated_sequence = [
     'bus_from_route_start_to_route_end',
     'bus_from_route_end_to_route_start'
     ]
-repetition_amounts = [1, 1]
-time_between_repetitions = [0.1, 0.22] # hours
+repetition_amounts = [7]
+time_between_repetitions = [0.1] # hours
 
 
 # These parameters are used for the ChaProEV mobility module

{chaproev-1.2.0 → chaproev-1.2.2}/scenarios/Mopo/XX_car.toml

@@ -406,10 +406,13 @@ use_weighted = false
 battery_capacity = 80  # kWh
 solar_panel_size_kWp = 0  # kWp
 [vehicle.base_consumption_per_km]
-electricity_kWh = 0.2
-gasoline_litres = 0.075
-diesel_litres = 0.05
-hydrogen_kg = 0.006340
+# https://www.autoweek.nl/verbruiksmonitor/
+electricity_kWh = 0.1451
+gasoline_litres = 0.0649
+diesel_litres = 0.0557
+hydrogen_kg = 0.0076
+LPG_litres = 0.092
+CNG_kg = 0.0461
 
 [trips]
 [trips.commute_to_work]

{chaproev-1.2.0 → chaproev-1.2.2}/scenarios/Mopo/XX_truck.toml

@@ -113,8 +113,8 @@ time_modulation_factors = [
 # etc.
 [legs.truck_to_customer]
 vehicle = 'truck'
-distance = 150  # km
-duration = 2.2  # hours
+distance = 42  # km # To get to about 91_000 km per year
+duration = 1  # hours
 # This factor adds a correction to the vehicle consumption that depends
 # on the hour in day (the first is for 00:00 to 00:59,
 # the last for 23:00 to 23:59). Note that these are actual hours,
@@ -139,8 +139,8 @@ end = 'truck_customer'
 mix = [0.8, 0.2]
 [legs.truck_to_hub]
 vehicle = 'truck'
-distance = 150  # km
-duration = 2.2  # hours
+distance = 42 # km # To get to about 91_000 km per year
+duration = 1  # hours
 # This factor adds a correction to the vehicle consumption that depends
 # on the hour in day (the first is for 00:00 to 00:59,
 # the last for 23:00 to 23:59). Note that these are actual hours,
@@ -164,22 +164,28 @@ end = 'truck_hub'
 # road_types = ['highway', 'city']
 mix = [0.8, 0.2]
 
+
 [vehicle]
 
 name = 'truck'
 base_location = 'truck_hub' # not relevant for cars
-yearly_kilometrage = 42_000
+yearly_kilometrage = 91_250
+# 250 km per day https://www.agendalaadinfrastructuur.nl/ondersteuning+gemeenten/documenten+en+links/documenten+in+bibliotheek/handlerdownloadfiles.ashx?idnv=2547592#:~:text=Op%20dit%20moment%20gebruikt%20een,dieselvrachtwagen%20(Mobilyze%2C%202023).
 # Not relevant for cars, as it is built bottom-up
 kilometers_column_for_consumption = 'Arrivals'
 use_weighted = false
-battery_capacity = 80  # kWh
+battery_capacity = 540  # kWh
+# https://www.volvotrucks.com/en-en/news-stories/press-releases/2022/jan/volvos-heavy-duty-electric-truck-is-put-to-the-test-excels-in-both-range-and-energy-efficiency.html
 solar_panel_size_kWp = 0  # kWp
 [vehicle.base_consumption_per_km]
-electricity_kWh = 0.2
-gasoline_litres = 0.075
-diesel_litres = 0.05
-hydrogen_kg = 0.006340
-
+electricity_kWh = 0.1451
+gasoline_litres = 0.0649
+diesel_litres = 0.0557
+hydrogen_kg = 0.0076
+CNG_kg = 0.0461
+LNG_kg = 0.0461
+
+ 
 [trips]
 
 [trips.truck_weekday]

{chaproev-1.2.0 → chaproev-1.2.2}/scenarios/Mopo/XX_van.toml

@@ -114,7 +114,7 @@ time_modulation_factors = [
 # etc.
 [legs.van_to_customer]
 vehicle = 'van'
-distance = 20  # km
+distance = 2.6  # km # Chosen to match 18_000 km per year
 duration = 0.25  # hours
 # This factor adds a correction to the vehicle consumption that depends
 # on the hour in day (the first is for 00:00 to 00:59,
@@ -140,7 +140,7 @@ end = 'van_customer'
 mix = [0.8, 0.2]
 [legs.van_to_base]
 vehicle = 'van'
-distance = 20  # km
+distance = 2.6  # km # Chosen to match 18_000 km per year
 duration = 0.25  # hours
 # This factor adds a correction to the vehicle consumption that depends
 # on the hour in day (the first is for 00:00 to 00:59,
@@ -165,23 +165,23 @@ end = 'van_base'
 # road_types = ['highway', 'city']
 mix = [0.8, 0.2]
 
-
-
-
 [vehicle]
 name = 'van'
 base_location = 'van_base' # not relevant for cars
-yearly_kilometrage = 42_000
+yearly_kilometrage = 18_000
+# https://www.cbs.nl/nl-nl/visualisaties/verkeer-en-vervoer/verkeer/verkeersprestaties-bestelautos
 # Not relevant for cars, as it is built bottom-up
 kilometers_column_for_consumption = 'Arrivals'
 use_weighted = false
 battery_capacity = 80  # kWh
 solar_panel_size_kWp = 0  # kWp
 [vehicle.base_consumption_per_km]
-electricity_kWh = 0.2
-gasoline_litres = 0.075
-diesel_litres = 0.05
-hydrogen_kg = 0.006340
+electricity_kWh = 0.1451
+gasoline_litres = 0.0649
+diesel_litres = 0.0557
+hydrogen_kg = 0.0076
+LPG_litres = 0.092
+CNG_kg = 0.0461
 
 [trips]
 [trips.van_weekday]
@@ -211,7 +211,7 @@ repeated_sequence = [
     'van_to_customer',
     'van_to_base',
     ]
-repetition_amounts = [4, 2, 2, 1]
+repetition_amounts = [3, 1, 1, 1]
 time_between_repetitions = [0.1, 1, 0.1, 1] # hours
 
 [trips.van_weekend]
@@ -241,7 +241,7 @@ repeated_sequence = [
     'van_to_customer',
     'van_to_base',
     ]
-repetition_amounts = [2, 2, 2, 1]
+repetition_amounts = [1, 1, 1, 1]
 time_between_repetitions = [0.1, 2, 0.1, 2] # hours
 
 

chaproev-1.2.2/src/ChaProEV/ChaProEV.py

@@ -0,0 +1,148 @@
+'''
+Author: Omar Usmani (Omar.Usmani@TNO.nl)
+This is where you run the model
+'''
+
+import typing as ty
+from itertools import repeat
+from multiprocessing import Pool
+
+import tqdm
+from box import Box
+from ETS_CookBook import ETS_CookBook as cook
+
+try:
+    import writing  # type: ignore
+
+    # We need to ignore the type because mypy has its own search path for
+    # imports and does not resolve imports exactly as Python does and it
+    # isn't able to find the module.
+    # https://stackoverflow.com/questions/68695851/mypy-cannot-find-implementation-or-library-stub-for-module
+except ModuleNotFoundError:
+    from ChaProEV import writing  # type: ignore
+# So that it works both as a standalone (1st) and as a package (2nd)
+# We need to add to type: ignore thing to avoid MypY thinking
+# we are importing again
+
+
+try:
+    import make_variants  # type: ignore
+
+    # We need to ignore the type because mypy has its own search path for
+    # imports and does not resolve imports exactly as Python does and it
+    # isn't able to find the module.
+    # https://stackoverflow.com/questions/68695851/mypy-cannot-find-implementation-or-library-stub-for-module
+except ModuleNotFoundError:
+    from ChaProEV import make_variants  # type: ignore
+# So that it works both as a standalone (1st) and as a package (2nd)
+# We need to add to type: ignore thing to avoid MypY thinking
+# we are importing again
+
+
+try:
+    import profiles  # type: ignore
+
+    # We need to ignore the type because mypy has its own search path for
+    # imports and does not resolve imports exactly as Python does and it
+    # isn't able to find the module.
+    # https://stackoverflow.com/questions/68695851/mypy-cannot-find-implementation-or-library-stub-for-module
+except ModuleNotFoundError:
+    from ChaProEV import profiles  # type: ignore
+# So that it works both as a standalone (1st) and as a package (2nd)
+# We need to add to type: ignore thing to avoid MypY thinking
+# we are importing again
+
+try:
+    import scenarios_module  # type: ignore
+
+    # We need to ignore the type because mypy has its own search path for
+    # imports and does not resolve imports exactly as Python does and it
+    # isn't able to find the module.
+    # https://stackoverflow.com/questions/68695851/mypy-cannot-find-implementation-or-library-stub-for-module
+except ModuleNotFoundError:
+    from ChaProEV import scenarios_module  # type: ignore
+# So that it works both as a standalone (1st) and as a package (2nd)
+# We need to add to type: ignore thing to avoid MypY thinking
+# we are importing again
+
+
+@cook.function_timer
+def run_ChaProEV(case_name: str) -> None:
+    general_parameters_file_name: str = 'ChaProEV.toml'
+    general_parameters: Box = Box(
+        cook.parameters_from_TOML(general_parameters_file_name)
+    )
+    output_root: str = general_parameters.files.output_root
+    cook.check_if_folder_exists(f'{output_root}/{case_name}')
+    variant_parameters: Box = general_parameters.variants
+    use_variants: bool = variant_parameters.use_variants
+    if use_variants:
+        csv_version: bool = variant_parameters.csv_version
+        make_variants.make_variants(case_name, csv_version)
+
+    scenarios: ty.List[Box] = scenarios_module.load_scenarios(case_name)
+
+    set_amount_of_processes: bool = (
+        general_parameters.parallel_processing.set_amount_of_processes
+    )
+    if set_amount_of_processes:
+        amount_of_parallel_processes: int | None = None
+    else:
+        amount_of_parallel_processes = (
+            general_parameters.parallel_processing.amount_for_scenarios
+        )
+
+    pool_inputs: ty.Iterator[ty.Tuple[Box, str, Box]] | ty.Any = zip(
+        scenarios, repeat(case_name), repeat(general_parameters)
+    )
+    # the ty.Any alternative is there because transforming it with the
+    # progress bar makes mypy think it change is type
+    progress_bars_parameters: Box = general_parameters.progress_bars
+    display_scenario_run: bool = progress_bars_parameters.display_scenario_run
+    scenario_run_description: str = (
+        progress_bars_parameters.scenario_run_description
+    )
+    if display_scenario_run:
+        pool_inputs = tqdm.tqdm(
+            pool_inputs,
+            desc=scenario_run_description,
+            total=len(scenarios),
+        )
+
+    with Pool(amount_of_parallel_processes) as scenarios_pool:
+        scenarios_pool.starmap(scenarios_module.run_scenario, pool_inputs)
+
+    do_car_home_type_split: bool = (
+        general_parameters.home_type.do_car_home_type_split
+    )
+    if do_car_home_type_split:
+        profiles.car_home_parking(case_name, general_parameters)
+
+    writing.extra_end_outputs(case_name, general_parameters)
+
+
+if __name__ == '__main__':
+    # This is a case name, which is the grouping of all your scenarios.
+    # This is principally used to label your output files.
+    case_name = 'Mopo'
+
+    run_ChaProEV(case_name)
+
+    # print('Add sessions into next day')
+    # print('Iterate through sessions and send remainder to next session')
+    # print('Compute session first pass')
+    # print('Do a second compute with passthrough')
+    # print('Convert session-basec charge to profile')
+    # print('Have parameter that shifts within a session?')
+    # print('Do kilometers/consumption split for sessions?')
+    # print('Do effetive session end andthen a match between the approaches')
+    # print('Make profile DF (with all) from sessions version')
+    # print('Make fleet version')
+    # print('Compare profiles')
+    # Add actual stop time (if using full power)
+    # Then infer profiles
+    # DO this in a sperate DF that will be used to compare
+    # COnnectivity: does the groupneed to be smaller?
+    # Also somehow include legs from before that did not charge because
+    # of connectivity
+    # Base profile is spread according to partial arrivals.

{chaproev-1.2.0 → chaproev-1.2.2}/src/ChaProEV/define.py

@@ -557,7 +557,6 @@ def get_travelling_group_travel_impact(
             percent_in_first_slot = 1 + percent_in_first_slot
 
         if travelling_group_first_slot + 2 >= HOURS_IN_A_DAY:
-
             print('Trip extending beyond day end. Check your entry')
             exit()
 
@@ -583,10 +582,9 @@ def get_travelling_group_travel_impact(
         if percent_in_first_slot <= 0:
             travelling_group_first_slot += 1
             percent_in_first_slot = 1 + percent_in_first_slot
-
         if travelling_group_first_slot + 2 >= HOURS_IN_A_DAY:
-
             print('Trip extending beyond day end. Check your entry')
+            print('dddd')
             exit()
 
     return mobility_matrix
@@ -1069,7 +1067,6 @@ class Trip:
             first_leg: str = trip.legs[0]
             initial_location: str = scenario.legs[first_leg].locations.start
             trip.location_split[initial_location] = 1
-
         trip.location_split, trip.mobility_matrix = (
             get_location_split_and_impact_of_departures_and_arrivals(
                 trip.location_names,