ChaProEV 1.1.2__tar.gz → 1.1.4__tar.gz

{chaproev-1.1.2 → chaproev-1.1.4}/.gitignore

@@ -8,3 +8,4 @@ site/
 .venv/
 reference_run/
 reference_run_prev/
+reference_run_previous/

{chaproev-1.1.2 → chaproev-1.1.4}/ChaProEV.toml

@@ -5,10 +5,9 @@ csv_version = true
 use_years_in_profiles =  true
 
 [parallel_processing]
-[parallel_processing.number_of_parallel_processes]
 set_amount_of_processes = false
-for_scenarios = 4
-for_pickle_saves = 4
+amount_for_scenarios = 4
+amount_for_pickle_saves = 4
 
 [interim_files]
 pickle = false

{chaproev-1.1.2/src/ChaProEV.egg-info → chaproev-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ChaProEV
-Version: 1.1.2
+Version: 1.1.4
 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.1.2 → chaproev-1.1.4}/pyproject.toml

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

{chaproev-1.1.2 → chaproev-1.1.4}/scenarios/Mopo/XX_bus.toml

@@ -11,13 +11,25 @@
 [run]
 use_day_types_in_charge_computing = true
 [run.start]
-year = 2020
-month = 1
-day = 1
+year = 2017
+month = 12
+day = 31
 hour = 5
 minute = 0
 [run.end]  # This is is not included in the run time
-year = 2021
+year = 2019
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_start]
+year = 2018
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_end]  # This is is not included in the display time
+year = 2019
 month = 1
 day = 1
 hour = 0
@@ -28,6 +40,12 @@ type = 'h'  # 'min'
 # Put the interval type here, 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
+[run.display_frequency]
+size = 1  # Put the size of the interval here
+type = 'h'  # 'min'
+# Put the interval type here, 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
 [run.get_extra_downloads]
 download_weather_data = false
 # Put true if you want to download the weather data. In principle,
@@ -59,7 +77,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 400 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.bus_route_start]
 vehicle = 'bus'
 connectivity = 1
@@ -74,7 +92,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 0 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.bus_route_end]
 vehicle = 'bus'
 connectivity = 1
@@ -89,7 +107,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 0 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 
 [legs]
 # You can add legs here by copying existing legs,

{chaproev-1.1.2 → chaproev-1.1.4}/scenarios/Mopo/XX_car.toml

@@ -11,13 +11,25 @@
 [run]
 use_day_types_in_charge_computing = true
 [run.start]
-year = 2020
-month = 1
-day = 1
+year = 2017
+month = 12
+day = 31
 hour = 5
 minute = 0
 [run.end]  # This is is not included in the run time
-year = 2021
+year = 2019
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_start]
+year = 2018
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_end]  # This is is not included in the display time
+year = 2019
 month = 1
 day = 1
 hour = 0
@@ -28,6 +40,12 @@ type = 'h'  # 'min'
 # Put the interval type here, 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
+[run.display_frequency]
+size = 1  # Put the size of the interval here
+type = 'h'  # 'min'
+# Put the interval type here, 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
 [run.get_extra_downloads]
 download_weather_data = false
 # Put true if you want to download the weather data. In principle,
@@ -59,7 +77,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 4.2 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.work]
 vehicle = 'car'
 connectivity = 0.25
@@ -74,7 +92,7 @@ percentage_in_location_at_run_start = 0
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 6.6 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.leisure]
 vehicle = 'car'
 connectivity = 0.25
@@ -89,7 +107,7 @@ percentage_in_location_at_run_start = 0
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 0 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.weekend]
 vehicle = 'car'
 connectivity = 0.1
@@ -104,7 +122,7 @@ percentage_in_location_at_run_start = 0
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 0 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.holiday]
 vehicle = 'car'
 connectivity = 1
@@ -119,7 +137,7 @@ percentage_in_location_at_run_start = 0
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 11 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 
 [legs]
 # You can add legs here by copying existing legs,

{chaproev-1.1.2 → chaproev-1.1.4}/scenarios/Mopo/XX_truck.toml

@@ -11,13 +11,25 @@
 [run]
 use_day_types_in_charge_computing = true
 [run.start]
-year = 2020
-month = 1
-day = 1
+year = 2017
+month = 12
+day = 31
 hour = 5
 minute = 0
 [run.end]  # This is is not included in the run time
-year = 2021
+year = 2019
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_start]
+year = 2018
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_end]  # This is is not included in the display time
+year = 2019
 month = 1
 day = 1
 hour = 0
@@ -28,6 +40,12 @@ type = 'h'  # 'min'
 # Put the interval type here, 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
+[run.display_frequency]
+size = 1  # Put the size of the interval here
+type = 'h'  # 'min'
+# Put the interval type here, 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
 [run.get_extra_downloads]
 download_weather_data = false
 # Put true if you want to download the weather data. In principle,
@@ -59,7 +77,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 150 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.truck_customer]
 vehicle = 'truck'
 connectivity = 0.1
@@ -74,7 +92,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 0 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 
 [legs]
 # You can add legs here by copying existing legs,

{chaproev-1.1.2 → chaproev-1.1.4}/scenarios/Mopo/XX_van.toml

@@ -11,13 +11,25 @@
 [run]
 use_day_types_in_charge_computing = true
 [run.start]
-year = 2020
-month = 1
-day = 1
+year = 2017
+month = 12
+day = 31
 hour = 5
 minute = 0
 [run.end]  # This is is not included in the run time
-year = 2021
+year = 2019
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_start]
+year = 2018
+month = 1
+day = 1
+hour = 0
+minute = 0
+[run.display_end]  # This is is not included in the display time
+year = 2019
 month = 1
 day = 1
 hour = 0
@@ -28,6 +40,12 @@ type = 'h'  # 'min'
 # Put the interval type here, 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
+[run.display_frequency]
+size = 1  # Put the size of the interval here
+type = 'h'  # 'min'
+# Put the interval type here, 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
 [run.get_extra_downloads]
 download_weather_data = false
 # Put true if you want to download the weather data. In principle,
@@ -59,7 +77,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 100 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 [locations.van_customer]
 vehicle = 'van'
 connectivity = 0.1
@@ -74,7 +92,7 @@ percentage_in_location_at_run_start = 1
 # If filling it directly instead of computing it (controlled by
 # compute_start_location_split in mobility_module below)
 vehicle_discharge_power = 0 # kW
-proportion_of_discharge_going_to_network = 0.9
+proportion_of_discharge_to_network = 0.9
 
 
 [legs]

{chaproev-1.1.2 → chaproev-1.1.4}/src/ChaProEV/ChaProEV.py

@@ -11,6 +11,7 @@ from multiprocessing import Pool
 
 import numpy as np
 import pandas as pd
+from box import Box
 from ETS_CookBook import ETS_CookBook as cook
 
 try:
@@ -106,29 +107,27 @@ except ModuleNotFoundError:
 # we are importing again
 
 
-def car_home_parking(case_name: str, general_parameters: ty.Dict) -> None:
-    home_type_parameters: ty.Dict = general_parameters['home_type']
-    input_root: str = general_parameters['files']['input_root']
+def car_home_parking(case_name: str, general_parameters: Box) -> None:
+    home_type_parameters: Box = general_parameters.home_type
+    input_root: str = general_parameters.files.input_root
     input_folder: str = f'{input_root}/{case_name}'
-    percentages_file_name: str = home_type_parameters['percentages_file']
+    percentages_file_name: str = home_type_parameters.percentages_file
     car_drivewway_percentages: pd.DataFrame = pd.read_csv(
         f'{input_folder}/{percentages_file_name}'
-    ).set_index(home_type_parameters['index_name'])
+    ).set_index(home_type_parameters.index_name)
 
-    profiles_index: ty.List[str] = home_type_parameters['profiles_index']
-    own_driveway_name: str = home_type_parameters['own_driveway_name']
-    on_street_name: str = home_type_parameters['on_street_name']
+    profiles_index: ty.List[str] = home_type_parameters.profiles_index
+    own_driveway_name: str = home_type_parameters.own_driveway_name
+    on_street_name: str = home_type_parameters.on_street_name
 
-    output_root: ty.Dict = general_parameters['files']['output_root']
+    output_root: str = general_parameters.files.output_root
     output_folder: str = f'{output_root}/{case_name}'
 
-    consumption_parameters: ty.Dict = general_parameters['consumption']
-    consumption_table_name: str = consumption_parameters[
-        'consumption_table_name'
-    ]
-    use_years_in_profiles: bool = general_parameters['variants'][
-        'use_years_in_profiles'
-    ]
+    consumption_parameters: Box = general_parameters.consumption
+    consumption_table_name: str = consumption_parameters.consumption_table_name
+    use_years_in_profiles: bool = (
+        general_parameters.variants.use_years_in_profiles
+    )
 
     variant_names: ty.List[str] = list(car_drivewway_percentages.index)
     for variant_name in variant_names:
@@ -191,47 +190,40 @@ def car_home_parking(case_name: str, general_parameters: ty.Dict) -> None:
             f'{output_folder}/{variant_name}_{consumption_table_name}.pkl'
         )
 
-        do_fleet_tables: float = general_parameters['profile_dataframe'][
-            'do_fleet_tables'
-        ]
+        do_fleet_tables: float = (
+            general_parameters.profile_dataframe.do_fleet_tables
+        )
         if do_fleet_tables:
             fleet_profiles(case_name, variant_name, general_parameters)
 
 
 def fleet_profiles(
-    case_name: str, scenario_name: str, general_parameters: ty.Dict
+    case_name: str, scenario_name: str, general_parameters: Box
 ) -> None:
-    home_type_parameters: ty.Dict = general_parameters['home_type']
-    consumption_parameters: ty.Dict = general_parameters['consumption']
-    consumption_table_name: str = consumption_parameters[
-        'consumption_table_name'
-    ]
+    home_type_parameters: Box = general_parameters.home_type
+    consumption_parameters: Box = general_parameters.consumption
+    consumption_table_name: str = consumption_parameters.consumption_table_name
+
+    distance_header: str = consumption_parameters.distance_header
+    fleet_distance_header: str = consumption_parameters.fleet_distance_header
+
+    energy_carriers_consumption_names: ty.List[str] = (
+        consumption_parameters.energy_carriers_consumption_names
+    )
 
-    distance_header: str = consumption_parameters['distance_header']
-    fleet_distance_header: str = consumption_parameters[
-        'fleet_distance_header'
-    ]
-    energy_carriers_consumption_names: ty.List[str] = consumption_parameters[
-        'energy_carriers_consumption_names'
-    ]
     fleet_energy_carriers_consumption_names: ty.List[str] = (
-        consumption_parameters['fleet_energy_carriers_consumption_names']
+        consumption_parameters.fleet_energy_carriers_consumption_names
     )
-    energy_carriers: ty.List[str] = consumption_parameters['energy_carriers']
-    output_root: ty.Dict = general_parameters['files']['output_root']
+    energy_carriers: ty.List[str] = consumption_parameters.energy_carriers
+    output_root: str = general_parameters.files.output_root
     output_folder: str = f'{output_root}/{case_name}'
-    profiles_index: ty.List[str] = home_type_parameters['profiles_index']
-    profile_headers: ty.List = general_parameters['profile_dataframe'][
-        'headers'
-    ]
-    fleet_headers: ty.List = general_parameters['profile_dataframe'][
-        'fleet_headers'
-    ]
-    input_root: str = general_parameters['files']['input_root']
+    profiles_index: ty.List[str] = home_type_parameters.profiles_index
+    profile_headers: ty.List = general_parameters.profile_dataframe.headers
+    fleet_headers: ty.List = general_parameters.profile_dataframe.fleet_headers
+
+    input_root: str = general_parameters.files.input_root
     input_folder: str = f'{input_root}/{case_name}'
-    fleet_file_name: str = general_parameters['profile_dataframe'][
-        'fleet_file_name'
-    ]
+    fleet_file_name: str = general_parameters.profile_dataframe.fleet_file_name
 
     fleet_split: pd.DataFrame = pd.read_csv(
         f'{input_folder}/{fleet_file_name}'
@@ -241,7 +233,7 @@ def fleet_profiles(
         fleet_split.loc[scenario_name]['Total Fleet (thousands)']
     )
     consumption_table: pd.DataFrame = pd.read_pickle(
-        f'{output_folder}/{scenario_name}_' f'{consumption_table_name}.pkl'
+        f'{output_folder}/{scenario_name}_{consumption_table_name}.pkl'
     )
     fleet_consumption_table: pd.DataFrame = pd.DataFrame(
         index=consumption_table.index
@@ -294,9 +286,9 @@ def fleet_profiles(
 
 
 def run_scenario(
-    scenario: ty.Dict, case_name: str, general_parameters: ty.Dict
+    scenario: Box, case_name: str, general_parameters: Box
 ) -> None:
-    scenario_name: str = scenario['scenario_name']
+    scenario_name: str = scenario.name
     print(scenario_name)
     decla_start: datetime.datetime = datetime.datetime.now()
     location_connections, legs, locations, trips = (
@@ -367,7 +359,7 @@ def run_scenario(
         (datetime.datetime.now() - charge_start).total_seconds(),
     )
 
-    battery_capacity: float = scenario['vehicle']['battery_capacity']
+    battery_capacity: float = scenario.vehicle.battery_capacity
     battery_capacity_dataframe: pd.DataFrame = (
         battery_capacity * location_split
     )
@@ -377,7 +369,7 @@ def run_scenario(
 
     connectivities: np.ndarray = np.array(
         [
-            scenario['locations'][dataframe_location]['connectivity']
+            scenario.locations[dataframe_location].connectivity
             for dataframe_location in battery_capacity_dataframe.columns
         ]
     )
@@ -404,9 +396,9 @@ def run_scenario(
         vehicle_discharge_power_per_location,
         discharge_power_to_network_per_location,
     ]
-    profile_dataframe_headers: ty.List[str] = general_parameters[
-        'profile_dataframe'
-    ]['headers']
+    profile_dataframe_headers: ty.List[str] = (
+        general_parameters.profile_dataframe.headers
+    )
     profile_dataframe: pd.DataFrame = run_time.get_time_stamped_dataframe(
         scenario, general_parameters, locations_as_columns=False
     )
@@ -416,18 +408,24 @@ def run_scenario(
 
         profile_dataframe[dataframe_header] = dataframe_for_profile.sum(axis=1)
 
-    output_root: str = general_parameters['files']['output_root']
+    output_root: str = general_parameters.files.output_root
     output_folder: str = f'{output_root}/{case_name}'
+    display_range: pd.DatetimeIndex = run_time.get_time_range(
+        scenario, general_parameters
+    )[2]
+    profile_dataframe = profile_dataframe.loc[display_range]
+    profile_dataframe.index.name = 'Time Tag'
     profile_dataframe.to_pickle(f'{output_folder}/{scenario_name}_profile.pkl')
 
-    do_fleet_tables: float = general_parameters['profile_dataframe'][
-        'do_fleet_tables'
-    ]
+    do_fleet_tables: float = (
+        general_parameters.profile_dataframe.do_fleet_tables
+    )
+
     if do_fleet_tables:
         fleet_profiles(case_name, scenario_name, general_parameters)
 
 
-def load_scenarios(case_name: str) -> ty.List[ty.Dict]:
+def load_scenarios(case_name: str) -> ty.List[Box]:
     scenario_folder_files: ty.List[str] = os.listdir(f'scenarios/{case_name}')
     scenario_files: ty.List[str] = [
         scenario_folder_file
@@ -438,49 +436,51 @@ def load_scenarios(case_name: str) -> ty.List[ty.Dict]:
         f'scenarios/{case_name}/{scenario_file}'
         for scenario_file in scenario_files
     ]
-    scenarios: ty.List[ty.Dict] = [
-        cook.parameters_from_TOML(scenario_file_path)
+    scenarios: ty.List[Box] = [
+        Box(cook.parameters_from_TOML(scenario_file_path))
         for scenario_file_path in scenario_file_paths
     ]
     for scenario, scenario_file in zip(scenarios, scenario_files):
-        scenario['scenario_name'] = scenario_file.split('.')[0]
+        scenario.name = scenario_file.split('.')[0]
     return scenarios
 
 
 def run_ChaProEV(case_name: str) -> None:
     start_: datetime.datetime = datetime.datetime.now()
     general_parameters_file_name: str = 'ChaProEV.toml'
-    general_parameters: ty.Dict = cook.parameters_from_TOML(
-        general_parameters_file_name
+    general_parameters: Box = Box(
+        cook.parameters_from_TOML(general_parameters_file_name)
     )
-    output_root: str = general_parameters['files']['output_root']
+    output_root: str = general_parameters.files.output_root
     cook.check_if_folder_exists(f'{output_root}/{case_name}')
-    use_variants = general_parameters['variants']['use_variants']
+    variant_parameters: Box = general_parameters.variants
+    use_variants: bool = variant_parameters.use_variants
     if use_variants:
-        csv_version = general_parameters['variants']['csv_version']
+        csv_version: bool = variant_parameters.csv_version
         make_variants.make_variants(case_name, csv_version)
 
-    scenarios: ty.List[ty.Dict] = load_scenarios(case_name)
+    scenarios: ty.List[Box] = load_scenarios(case_name)
 
-    set_amount_of_processes: bool = general_parameters['parallel_processing'][
-        'number_of_parallel_processes'
-    ]['set_amount_of_processes']
+    set_amount_of_processes: bool = (
+        general_parameters.parallel_processing.set_amount_of_processes
+    )
     if set_amount_of_processes:
-        number_of_parallel_processes: int | None = None
+        amount_of_parallel_processes: int | None = None
     else:
-        number_of_parallel_processes = general_parameters[
-            'parallel_processing'
-        ]['number_of_parallel_processes']['for_scenarios']
+        amount_of_parallel_processes = (
+            general_parameters.parallel_processing.amount_for_scenarios
+        )
 
-    with Pool(number_of_parallel_processes) as scenarios_pool:
+    with Pool(amount_of_parallel_processes) as scenarios_pool:
         scenarios_pool.starmap(
             run_scenario,
             zip(scenarios, repeat(case_name), repeat(general_parameters)),
         )
 
-    do_car_home_type_split: bool = general_parameters['home_type'][
-        'do_car_home_type_split'
-    ]
+    do_car_home_type_split: bool = (
+        general_parameters.home_type.do_car_home_type_split
+    )
+
     if do_car_home_type_split:
         car_home_parking(case_name, general_parameters)