eflips-depot 4.12.0__tar.gz → 4.12.2__tar.gz

{eflips_depot-4.12.0 → eflips_depot-4.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: eflips-depot
-Version: 4.12.0
+Version: 4.12.2
 Summary: Depot Simulation for eFLIPS
 License: AGPL-3.0-or-later
 Author: Enrico Lauth

{eflips_depot-4.12.0 → eflips_depot-4.12.2}/eflips/depot/api/__init__.py

@@ -1106,7 +1106,7 @@ 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,
@@ -1117,7 +1117,9 @@ def generate_depot_optimal_size(
     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.
@@ -1133,6 +1135,20 @@ def generate_depot_optimal_size(
     logger = logging.getLogger(__name__)
 
     with create_session(scenario, database_url) as (session, scenario):
+        # Delete all depot events
+        session.query(Event).filter(
+            Event.scenario_id == scenario.id, Event.area_id.isnot(None)
+        ).delete()
+
+        if session.query(Depot).filter(Depot.scenario_id == scenario.id).count() != 0:
+            if delete_existing_depot is False:
+                raise ValueError(
+                    "Depot already exists. Set delete_existing_depot to True to delete it."
+                )
+
+            delete_depots(scenario, session)
+
+        outer_savepoint = session.begin_nested()
         # Delete all vehicles and events, also disconnect the vehicles from the rotations
         rotation_q = session.query(Rotation).filter(Rotation.scenario_id == scenario.id)
         rotation_q.update({"vehicle_id": None})
@@ -1140,11 +1156,6 @@ def generate_depot_optimal_size(
         session.query(Vehicle).filter(Vehicle.scenario_id == scenario.id).delete()
 
         # 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.")
-
-            delete_depots(scenario, session)
 
         ##### Step 0: Consumption Simulation #####
         # Run the consumption simulation for all depots
@@ -1185,7 +1196,7 @@ def generate_depot_optimal_size(
                 len(rotations) for vehicle_type, rotations in vehicle_type_dict.items()
             )
 
-            savepoint = session.begin_nested()
+            inner_savepoint = session.begin_nested()
             try:
                 # (Temporarily) Delete all rotations not starting or ending at the station
                 logger.debug(
@@ -1224,11 +1235,11 @@ def generate_depot_optimal_size(
                 depot_capacities_for_scenario[station] = vt_capacities_for_station
                 num_rotations_for_scenario[station] = rotation_count_depot
             finally:
-                savepoint.rollback()
+                inner_savepoint.rollback()
 
-    # create depot with the calculated area sizes
+        outer_savepoint.rollback()
 
-    with create_session(scenario, database_url) as (session, scenario):
+        # Create depot using the calculated capacities
         for depot_station, capacities in depot_capacities_for_scenario.items():
             generate_depot(
                 capacities,
@@ -1240,10 +1251,3 @@ def generate_depot_optimal_size(
                 num_shunting_slots=num_rotations_for_scenario[depot_station] // 10,
                 num_cleaning_slots=num_rotations_for_scenario[depot_station] // 10,
             )
-
-        # Delete all vehicles and events again. Only depot layout is kept
-
-        rotation_q = session.query(Rotation).filter(Rotation.scenario_id == scenario.id)
-        rotation_q.update({"vehicle_id": None})
-        session.query(Event).filter(Event.scenario_id == scenario.id).delete()
-        session.query(Vehicle).filter(Vehicle.scenario_id == scenario.id).delete()

{eflips_depot-4.12.0 → eflips_depot-4.12.2}/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.12.0 → eflips_depot-4.12.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "eflips-depot"
-version = "4.12.0"
+version = "4.12.2"
 description = "Depot Simulation for eFLIPS"
 authors = ["Enrico Lauth <enrico.lauth@tu-berlin.de>",
     "Ludger Heide <ludger.heide@tu-berlin.de",