eflips-depot 3.2.7__py3-none-any.whl → 4.0.0__py3-none-any.whl

eflips/depot/api/private/depot.py

@@ -104,6 +104,8 @@ def depot_to_template(depot: Depot) -> Dict[str, str | Dict[str, str | int]]:
             "vehicle_types": [str(area.vehicle_type_id)],
         }
 
+        # TODO for cleaning area etc., enable non-vehicle_type areas
+
         for process in area.processes:
             # Add process into process list
             list_of_processes.append(
@@ -222,7 +224,7 @@ def depot_to_template(depot: Depot) -> Dict[str, str | Dict[str, str | int]]:
     }
     # Groups
     for process in depot.default_plan.processes:
-        group_name = str(process_type(process)) + "_group"
+        group_name = str(process.name) + "_group"
         template["groups"][group_name] = {
             "typename": "AreaGroup",
             "stores": [str(area.id) for area in process.areas],
@@ -295,6 +297,7 @@ def create_simple_depot(
     charging_power: float,
     session: sqlalchemy.orm.session.Session,
     cleaning_duration: timedelta = timedelta(minutes=30),
+    safety_margin: float = 0.0,
 ) -> None:
     """
     Creates a simple depot for a given scenario.
@@ -302,6 +305,7 @@ def create_simple_depot(
     It has one area for each vehicle type and a charging process for each
     area. Also an arrival area for each vehicle type.
 
+    :param safety_margin: a safety margin for the number of charging and cleaning capacities. Default is 0.0
     :param scenario: The scenario to be simulated
     :param station: The station where the depot is located
     :param charging_capacities: A dictionary of vehicle types and the number of vehicles that can be charged at the same time
@@ -328,10 +332,11 @@ def create_simple_depot(
     depot.default_plan = plan
 
     # Create processes
-    standby_arrival = Process(
-        name="Standby Arrival",
+    shunting_1 = Process(
+        name="Shunting 1",
         scenario=scenario,
         dispatchable=False,
+        duration=timedelta(minutes=5),
     )
     clean = Process(
         name="Arrival Cleaning",
@@ -339,6 +344,12 @@ def create_simple_depot(
         dispatchable=False,
         duration=cleaning_duration,
     )
+    shunting_2 = Process(
+        name="Shunting 2",
+        scenario=scenario,
+        dispatchable=False,
+        duration=timedelta(minutes=5),
+    )
     charging = Process(
         name="Charging",
         scenario=scenario,
@@ -350,15 +361,27 @@ def create_simple_depot(
         scenario=scenario,
         dispatchable=True,
     )
-    session.add(standby_arrival)
+
     session.add(clean)
+    session.add(shunting_1)
     session.add(charging)
     session.add(standby_departure)
+    session.add(shunting_2)
+
+    # Create shared waiting area
+    waiting_area = Area(
+        scenario=scenario,
+        name=f"Waiting Area for every type of vehicle",
+        depot=depot,
+        area_type=AreaType.DIRECT_ONESIDE,
+        capacity=100,
+    )
+    session.add(waiting_area)
 
     for vehicle_type in charging_capacities.keys():
         charging_count = charging_capacities[vehicle_type]
-        # Add a safety margin of 100% to the parking capacity
-        charging_count = int(ceil(charging_count * 2))
+
+        charging_count = int(ceil(charging_count * (1 + safety_margin)))
 
         # Create charging area
         charging_area = Area(
@@ -366,15 +389,15 @@ def create_simple_depot(
             name=f"Direct Charging Area for {vehicle_type.name_short}",
             depot=depot,
             area_type=AreaType.DIRECT_ONESIDE,
-            capacity=charging_count,
+            capacity=int(charging_count * 1),
         )
         session.add(charging_area)
         charging_area.vehicle_type = vehicle_type
 
         # Create cleaning area
         cleaning_count = cleaning_capacities[vehicle_type]
-        # Add a safety margin of 100% to the parking capacity
-        cleaning_count = int(ceil(cleaning_count * 2))
+
+        cleaning_count = int(ceil(cleaning_count * (1 + safety_margin)))
 
         cleaning_area = Area(
             scenario=scenario,
@@ -386,31 +409,45 @@ def create_simple_depot(
         session.add(cleaning_area)
         cleaning_area.vehicle_type = vehicle_type
 
-        # Create stand by arrival area
-        arrival_area = Area(
+        shunting_area_1 = Area(
             scenario=scenario,
-            name=f"Arrival for {vehicle_type.name_short}",
+            name=f"Shunting Area 1 for {vehicle_type.name_short}",
             depot=depot,
             area_type=AreaType.DIRECT_ONESIDE,
-            capacity=(charging_count + cleaning_count)
-            * 2,  # SHould be huge, not all of it will be used
+            capacity=10,
         )
-        session.add(arrival_area)
-        arrival_area.vehicle_type = vehicle_type
 
-        arrival_area.processes.append(standby_arrival)
+        session.add(shunting_area_1)
+        shunting_area_1.vehicle_type = vehicle_type
+
+        shunting_area_2 = Area(
+            scenario=scenario,
+            name=f"Shunting Area 2 for {vehicle_type.name_short}",
+            depot=depot,
+            area_type=AreaType.DIRECT_ONESIDE,
+            capacity=10,
+        )
+
+        session.add(shunting_area_2)
+        shunting_area_2.vehicle_type = vehicle_type
+
         cleaning_area.processes.append(clean)
         charging_area.processes.append(charging)
         charging_area.processes.append(standby_departure)
+        shunting_area_1.processes.append(shunting_1)
+        shunting_area_2.processes.append(shunting_2)
 
         assocs = [
             AssocPlanProcess(
-                scenario=scenario, process=standby_arrival, plan=plan, ordinal=0
+                scenario=scenario, process=shunting_1, plan=plan, ordinal=0
             ),
             AssocPlanProcess(scenario=scenario, process=clean, plan=plan, ordinal=1),
-            AssocPlanProcess(scenario=scenario, process=charging, plan=plan, ordinal=2),
             AssocPlanProcess(
-                scenario=scenario, process=standby_departure, plan=plan, ordinal=3
+                scenario=scenario, process=shunting_2, plan=plan, ordinal=2
+            ),
+            AssocPlanProcess(scenario=scenario, process=charging, plan=plan, ordinal=3),
+            AssocPlanProcess(
+                scenario=scenario, process=standby_departure, plan=plan, ordinal=4
             ),
         ]
         session.add_all(assocs)

eflips/depot/api/private/util.py

@@ -7,7 +7,15 @@ from datetime import timedelta, datetime
 from typing import Union, Any, Optional, Tuple, Dict, List
 
 import simpy
-from eflips.model import Scenario, VehicleType, Rotation, Event, EventType, Trip
+from eflips.model import (
+    Scenario,
+    VehicleType,
+    Rotation,
+    Event,
+    EventType,
+    Trip,
+    Depot,
+)
 from sqlalchemy import inspect, create_engine
 from sqlalchemy.orm import Session
 
@@ -164,6 +172,40 @@ def start_and_end_times(vehicle_schedules) -> Tuple[datetime, int]:
     return midnight_of_first_departure_day, total_duration_seconds
 
 
+def check_depot_validity(depot: Depot) -> None:
+    """
+    Check if the depot is valid for the eflips-depot simulation. Raise an AssertionError if it is not.
+    :param depot: a :class:`eflips.model.Depot` object.
+    :return: None
+    """
+    # 1. There must be an area containing no vehicle types
+    has_waiting_area = False
+    areas = depot.areas
+    for area in areas:
+        if area.vehicle_type_id is None:
+            # TODO might change to len(area.vehicle_types) == 0 after a list of vehicle types is allowed
+            has_waiting_area = True
+
+    assert (
+        has_waiting_area
+    ), "There must be an area containing no vehicle types as the waiting area."
+
+    # 2. There must be only one process with no duration and no electric power, and it must be the last process in the plan
+    plan = depot.default_plan
+    processes = plan.processes
+    last_process = processes[-1]
+    assert (
+        last_process.duration is None
+        and last_process.electric_power is None
+        and last_process.dispatchable is True
+    ), "The last process must be dispatchable and have no duration and no electric power."
+
+    for process in processes[:-1]:
+        assert (
+            process.electric_power is not None or process.duration is not None
+        ), "All processes except the last one must have electric power."
+
+
 @dataclass
 class VehicleSchedule:
     """

{eflips_depot-3.2.7.dist-info → eflips_depot-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eflips-depot
-Version: 3.2.7
+Version: 4.0.0
 Summary: Depot Simulation for eFLIPS
 Home-page: https://github.com/mpm-tu-berlin/eflips-depot
 License: AGPL-3.0-or-later
@@ -13,7 +13,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: eflips (>=0.1.3,<0.2.0)
-Requires-Dist: eflips-model (>=3.3.0,<4.0.0)
+Requires-Dist: eflips-model (>=4.0.0a2,<5.0.0)
 Requires-Dist: pandas (>=2.1.4,<3.0.0)
 Requires-Dist: scipy (>=1.13.1,<2.0.0)
 Requires-Dist: simpy (>=4.0.1,<5.0.0)

{eflips_depot-3.2.7.dist-info → eflips_depot-4.0.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 eflips/depot/__init__.py,sha256=n7jte8R6j_Ad4Mp4hkklKwil5r8u8Q_SbXrCC-nf5jM,1556
-eflips/depot/api/__init__.py,sha256=_j2nB0nN2uLMaYyRRhHWkNBEfr4U6BTMHkmF1q9Caak,58416
+eflips/depot/api/__init__.py,sha256=ecO_I4Tdh2vcNtxoYrNXehgKscgl26sMYqhkLoPO2lU,63743
 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/depot.py,sha256=GlIk6vuanbQP3a4e9TYt6xJ-XJTdaFbaxxz_ni17zgo,17136
+eflips/depot/api/private/depot.py,sha256=z17kGwXyt3XmOze8hn0hKpDrAUOd4pFV9ojNDEQmx5A,18112
 eflips/depot/api/private/smart_charging.py,sha256=GpNFaExjvyTCja4Uzx-cRW_Qck3Vv5A3Qt9HUJUfFLU,13510
-eflips/depot/api/private/util.py,sha256=zyU3QtsyrYRgcLWzzUT1hQLDfkwlbvvukmgnrANEzlc,15362
+eflips/depot/api/private/util.py,sha256=BFdhyaCSClLJo8DjlIQCV_db-Cc-qqNuGnNa50GzaLs,16741
 eflips/depot/configuration.py,sha256=Op3hlir-dEN7yHr0kTqbYANoCBKFWK6uKOv3NJl8w_w,35678
 eflips/depot/depot.py,sha256=afIlaiX-J-M5-K_oAGMr_soL3_QjIAwrQKDaZzTwle0,105566
 eflips/depot/evaluation.py,sha256=qqXyP4jA1zFcKuWhliQ6n25ZlGl9mJV-vtXf0yu8WN8,140842
@@ -35,7 +35,7 @@ eflips/depot/simulation.py,sha256=ee0qTzOzG-8ybN36ie_NJallXfC7jUaS9JZvaYFziLs,10
 eflips/depot/smart_charging.py,sha256=C3BYqzn2-OYY4ipXm0ETtavbAM9QXZMYULBpVoChf0E,54311
 eflips/depot/standalone.py,sha256=VxcTzBaB67fNJUMmjPRwKXjhqTy6oQ41Coote2LvAmk,22338
 eflips/depot/validation.py,sha256=TIuY7cQtEJI4H2VVMSuY5IIVkacEEZ67weeMuY3NSAM,7097
-eflips_depot-3.2.7.dist-info/LICENSE.md,sha256=KB4XTk1fPHjtZCYDyPyreu6h1LVJVZXYg-5vePcWZAc,34143
-eflips_depot-3.2.7.dist-info/METADATA,sha256=bkJyYUx0lEcId79_wDtnftrHM7QySf-HPCpUW6tmQe4,5786
-eflips_depot-3.2.7.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-eflips_depot-3.2.7.dist-info/RECORD,,
+eflips_depot-4.0.0.dist-info/LICENSE.md,sha256=KB4XTk1fPHjtZCYDyPyreu6h1LVJVZXYg-5vePcWZAc,34143
+eflips_depot-4.0.0.dist-info/METADATA,sha256=8eRcKemy5vZa_YvcOTbxD69gQ-jcv1o6mgCr_GdwWyE,5788
+eflips_depot-4.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+eflips_depot-4.0.0.dist-info/RECORD,,