eflips-depot 4.11.0__py3-none-any.whl → 4.12.1__py3-none-any.whl

eflips/depot/api/__init__.py

@@ -124,7 +124,8 @@ def generate_consumption_result(scenario):
     Generate consumption information for the scenario.
 
     This function retrieves the consumption LUT and vehicle classes from the database and returns a dictionary
-    containing the consumption information for each vehicle type in the scenario.
+    containing the consumption information for each vehicle type in the scenario. If a trip has no corresponding
+    consumption LUT, it won't be included in the results.
 
     :param scenario: A :class:`eflips.model.Scenario` object containing the input data for the simulation.
 
@@ -135,10 +136,18 @@ def generate_consumption_result(scenario):
         trips = session.query(Trip).filter(Trip.scenario_id == scenario.id).all()
         consumption_results = {}
         for trip in trips:
-            consumption_info = extract_trip_information(
-                trip.id,
-                scenario,
-            )
+            try:
+                consumption_info = extract_trip_information(
+                    trip.id,
+                    scenario,
+                )
+            except ValueError as e:
+                # If the trip has no consumption information, skip it
+                logging.warning(
+                    f"Skipping trip {trip.id} due to missing consumption information: {e}"
+                )
+                continue
+
             battery_capacity_current_vt = trip.rotation.vehicle_type.battery_capacity
             consumption_result = consumption_info.generate_consumption_result(
                 battery_capacity_current_vt
@@ -1097,25 +1106,27 @@ def add_evaluation_to_database(
 
 
 def generate_depot_optimal_size(
-    scenario: Scenario,
+    scenario: Union[Scenario, int, Any],
     standard_block_length: int = 6,
     charging_power: float = 90,
     database_url: Optional[str] = None,
     delete_existing_depot: bool = False,
-    consumption_results: Optional[Dict[int, ConsumptionResult]] = None,
+    use_consumption_lut: bool = False,
 ) -> None:
     """
     Generates an optimal depot layout with the smallest possible size for each depot in the scenario. Line charging areas
      with given block length area preferred. The existing depot will be deleted if `delete_existing_depot` is set to True.
 
-    :param scenario: A :class:`eflips.model.Scenario` object containing the input data for the simulation.
+    :param scenario: Either a :class:`eflips.model.Scenario` object containing the input data for the simulation. Or
+        an integer specifying the ID of a scenario in the database. Or any other object that has an attribute "id" containing
+        an integer pointing to a unique scenario id.
     :param standard_block_length: The standard block length for the depot layout in meters. Default is 6.
     :param charging_power: The charging power of the charging area in kW. Default is 90.
     :param database_url: An optional database URL. Used if no database url is given by the environment variable.
     :param delete_existing_depot: If there is already a depot existing in this scenario, set True to delete this
         existing depot. Set to False and a ValueError will be raised if there is a depot in this scenario.
-    :param consumption_results: A dictionary of consumption results for each vehicle type. It is used to simulate the consumption with
-        given look-up tables. If not given, the constant consumption will be used in the simulation.
+    :param using_consumption_lut: If True, the depot layout will be generated based on the consumption lookup table.
+        If False, constant consumption stored in VehicleType table will be used.
 
     :return: None. The depot layout will be added to the database.
 
@@ -1133,15 +1144,26 @@ def generate_depot_optimal_size(
         # Handles existing depot
         if session.query(Depot).filter(Depot.scenario_id == scenario.id).count() != 0:
             if delete_existing_depot is False:
-                raise ValueError("Depot already exists.")
+                raise ValueError(
+                    "Depot already exists. Set delete_existing_depot to True to delete it."
+                )
 
             delete_depots(scenario, session)
 
         ##### Step 0: Consumption Simulation #####
         # Run the consumption simulation for all depots
-        simple_consumption_simulation(
-            scenario, initialize_vehicles=True, consumption_result=consumption_results
-        )
+
+        if use_consumption_lut:
+            # If using the consumption lookup table, we need to calculate the consumption results
+            consumption_results = generate_consumption_result(scenario)
+            simple_consumption_simulation(
+                scenario,
+                initialize_vehicles=True,
+                consumption_result=consumption_results,
+            )
+        else:
+            # If not using the consumption lookup table, we need to initialize the vehicles with the constant consumption
+            simple_consumption_simulation(scenario, initialize_vehicles=True)
 
         ##### Step 1: Find all potential depots #####
         # These are all the spots where a rotation starts and end
@@ -1208,9 +1230,8 @@ def generate_depot_optimal_size(
             finally:
                 savepoint.rollback()
 
-    # create depot with the calculated area sizes
+        # Create depot using the calculated capacities
 
-    with create_session(scenario, database_url) as (session, scenario):
         for depot_station, capacities in depot_capacities_for_scenario.items():
             generate_depot(
                 capacities,

eflips/depot/api/private/depot.py

@@ -28,6 +28,10 @@ from sqlalchemy import or_
 from sqlalchemy.orm import Session
 
 
+class MissingVehicleDimensionError(ValueError):
+    pass
+
+
 def delete_depots(scenario: Scenario, session: Session) -> None:
     """This function deletes all depot-related data from the database for a given scenario.
 
@@ -676,7 +680,10 @@ def area_needed_for_vehicle_parking(
     width = vehicle_type.width
 
     if length is None or width is None:
-        raise ValueError(f"No length or width found for VehicleType {vehicle_type}")
+        raise MissingVehicleDimensionError(
+            f"No length or width found for VehicleType {vehicle_type}. VehicleType dimensions are required to "
+            f"calculate the area needed for parking."
+        )
 
     # This is the angle the vehicles are parked at in direct areas
     # zero is equivalent to the direction they would be parked in a line area
@@ -1070,6 +1077,9 @@ def depot_smallest_possible_size(
                         logger.debug(
                             f"Vehicle count for {vt.name} in {amount_of_line_areas} line areas configuration: {vehicle_count_q}. This is > than the all-direct configuration ({vehicle_counts_all_direct[vt]})."
                         )
+
+                except MissingVehicleDimensionError as e:
+                    raise e
                 except Exception as e:
                     # This change is made after Unstable exception and delay exceptions are introduced
                     if (

{eflips_depot-4.11.0.dist-info → eflips_depot-4.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: eflips-depot
-Version: 4.11.0
+Version: 4.12.1
 Summary: Depot Simulation for eFLIPS
 License: AGPL-3.0-or-later
 Author: Enrico Lauth
@@ -13,8 +13,8 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: eflips (>=0.1.3,<0.2.0)
-Requires-Dist: eflips-model (>=8.1.0,<9.0.0)
-Requires-Dist: eflips-opt (>=0.3.0,<0.4.0)
+Requires-Dist: eflips-model (>8.1.0,<10.0.0)
+Requires-Dist: eflips-opt (>=0.3.3,<0.4.0)
 Requires-Dist: pandas (>=2.2.0,<3.0.0)
 Requires-Dist: scipy (>=1.14.0,<2.0.0)
 Requires-Dist: simpy (>=4.0.1,<5.0.0)

{eflips_depot-4.11.0.dist-info → eflips_depot-4.12.1.dist-info}/RECORD

@@ -1,9 +1,9 @@
 eflips/depot/__init__.py,sha256=06GUem0JIEunIyJ0_P_MLAGfibGEnNqcPPY0OBpO2NQ,1662
-eflips/depot/api/__init__.py,sha256=19lwuX7KlvfKwyvbpxGSo4E9DSasVm8bNnw6k-Pz-_g,54158
+eflips/depot/api/__init__.py,sha256=t5BsJIheFF9B2732j0bbWGo0dUE7gF5cxuIveJDICIU,55170
 eflips/depot/api/defaults/default_settings.json,sha256=0eUDTw_rtLQFvthP8oJL93iRXlmAOravAg-4qqGMQAY,5375
 eflips/depot/api/private/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 eflips/depot/api/private/consumption.py,sha256=nImegyhKrZlEwKTNdmAmDxjTQCvwfPgxA588e0M_F9o,27282
-eflips/depot/api/private/depot.py,sha256=-LpLeEi3ctjsLzWbBGDBTic_aKrb6S35ii5wt-7QTmI,43359
+eflips/depot/api/private/depot.py,sha256=YyC_jMDGkg8yOAiYkKzb5HboFM1P4x-GTJSfD8srdvE,43640
 eflips/depot/api/private/results_to_database.py,sha256=_qXB9046dWHek4ys669J3IojJt4xlZRkW1HxT7OTLFo,25524
 eflips/depot/api/private/util.py,sha256=rDqVuB4sllFZmNvXuDktIsFRoR9l-AWc4QM00e1Quvw,17966
 eflips/depot/configuration.py,sha256=Op3hlir-dEN7yHr0kTqbYANoCBKFWK6uKOv3NJl8w_w,35678
@@ -36,7 +36,7 @@ eflips/depot/simulation.py,sha256=ee0qTzOzG-8ybN36ie_NJallXfC7jUaS9JZvaYFziLs,10
 eflips/depot/smart_charging.py,sha256=C3BYqzn2-OYY4ipXm0ETtavbAM9QXZMYULBpVoChf0E,54311
 eflips/depot/standalone.py,sha256=8O01zEXghFG9zZBu0fUD0sXvbHQ-AXw6RB5M750a_sM,22419
 eflips/depot/validation.py,sha256=TIuY7cQtEJI4H2VVMSuY5IIVkacEEZ67weeMuY3NSAM,7097
-eflips_depot-4.11.0.dist-info/LICENSE.md,sha256=KB4XTk1fPHjtZCYDyPyreu6h1LVJVZXYg-5vePcWZAc,34143
-eflips_depot-4.11.0.dist-info/METADATA,sha256=av_PasTBBigxFeKbjYQ1PT2pXXx3qp6p5HzSpQF1-JA,5985
-eflips_depot-4.11.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-eflips_depot-4.11.0.dist-info/RECORD,,
+eflips_depot-4.12.1.dist-info/LICENSE.md,sha256=KB4XTk1fPHjtZCYDyPyreu6h1LVJVZXYg-5vePcWZAc,34143
+eflips_depot-4.12.1.dist-info/METADATA,sha256=1txE-lc2o62p-gf7CLKUVQ4PWzDfn1-7axYKXeV1gGA,5985
+eflips_depot-4.12.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+eflips_depot-4.12.1.dist-info/RECORD,,