eflips-depot 3.0.0__py3-none-any.whl → 3.0.2__py3-none-any.whl

eflips/depot/api/__init__.py

@@ -724,11 +724,7 @@ def add_evaluation_to_database(
                 else:
                     for process in process_log:
                         match process.status:
-                            case ProcessStatus.CANCELLED:
-                                raise NotImplementedError(
-                                    f"Cancelled processes {process.ID} are not implemented."
-                                )
-                            case ProcessStatus.COMPLETED:
+                            case ProcessStatus.COMPLETED | ProcessStatus.CANCELLED:
                                 assert (
                                     len(process.starts) == 1 and len(process.ends) == 1
                                 ), (
@@ -754,13 +750,38 @@ def add_evaluation_to_database(
                                     }
                                 else:
                                     # Duration is 0
-
-                                    if start_time in dict_of_events:
-                                        assert current_area.issink is True
+                                    if current_area.issink is True:
                                         # Standby departure
-                                        actual_start_time = dict_of_events[start_time][
-                                            "end"
-                                        ]
+                                        if start_time in dict_of_events:
+                                            # Actual start time should be the end time of the other positive duration
+                                            # process starting at the same time
+                                            actual_start_time = dict_of_events[
+                                                start_time
+                                            ]["end"]
+                                        else:
+                                            for other_process in process_log:
+                                                if (
+                                                    other_process.dur > 0
+                                                    and len(other_process.ends) != 0
+                                                ):
+                                                    actual_start_time = (
+                                                        other_process.ends[0]
+                                                    )
+                                                else:
+                                                    # Invalid standby before a process in progress will be ignored
+                                                    continue
+
+                                        last_standby_departure_start = actual_start_time
+
+                                        # If this standby event lasts actually 0 seconds, it is not a real event
+                                        if (
+                                            actual_start_time in dict_of_events.keys()
+                                            and dict_of_events[actual_start_time][
+                                                "type"
+                                            ]
+                                            == "trip"
+                                        ):
+                                            continue
                                         dict_of_events[actual_start_time] = {
                                             "type": type(process).__name__,
                                             "area": current_area.ID,
@@ -769,11 +790,12 @@ def add_evaluation_to_database(
                                             "id": process.ID,
                                         }
 
-                                        last_standby_departure_start = actual_start_time
-
                                     else:
                                         # Standby arrival
-                                        assert current_area.issink is False
+                                        assert current_area.issink is False, (
+                                            f"A bus cannot go from Area {current_area.ID} to other areas. A Parking Area"
+                                            f" for standby arrival should be added."
+                                        )
                                         dict_of_events[start_time] = {
                                             "type": type(process).__name__,
                                             "area": current_area.ID,
@@ -782,9 +804,30 @@ def add_evaluation_to_database(
                                             "id": process.ID,
                                         }
                             case ProcessStatus.IN_PROGRESS:
-                                raise NotImplementedError(
-                                    f"Current process {process.ID} is in progress. Not implemented yet."
-                                )
+                                assert (
+                                    len(process.starts) == 1 and len(process.ends) == 0
+                                ), f"Current process {process.ID} is marked IN_PROGRESS, but has an end."
+                                current_area = area_log[start_time]
+                                current_slot = slot_log[start_time]
+
+                                if current_area is None or current_slot is None:
+                                    raise ValueError(
+                                        f"For process {process.ID} Area and slot should not be None."
+                                    )
+
+                                if process.dur > 0:
+                                    # Valid duration
+                                    dict_of_events[start_time] = {
+                                        "type": type(process).__name__,
+                                        "end": process.etc,
+                                        "area": current_area.ID,
+                                        "slot": current_slot,
+                                        "id": process.ID,
+                                    }
+                                else:
+                                    raise NotImplementedError(
+                                        "We believe this should never happen. If it happens, handle it here."
+                                    )
                             case ProcessStatus.WAITING:
                                 raise NotImplementedError(
                                     f"Current process {process.ID} is waiting. Not implemented yet."

eflips/depot/api/private/depot.py

@@ -137,7 +137,7 @@ def depot_to_template(depot: Depot) -> Dict[str, str | Dict[str, str | int]]:
             "ismandatory": True,
             "vehicle_filter": {},
             # True if this process can be interrupted by a dispatch. False if it cannot be interrupted
-            "cancellable_for_dispatch": False,
+            "cancellable_for_dispatch": process.dispatchable,
         }
 
         match process_type(process):

eflips/depot/depot.py

@@ -1,11 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-Created on Fri Oct 13 11:12:00 2017
+Created on Fri Oct 13 11:12:00 2017.
 
 @author: P.Mundt, E.Lauth
 
 Core components of the depot simulation model.
-
 """
 
 from collections import Counter
@@ -43,6 +42,7 @@ from warnings import warn
 
 class DepotWorkingData:
     """Data container for communication between vehicle and depot.
+
     Attribute of a SimpleVehicle object.
 
     Parameters:
@@ -87,7 +87,9 @@ class DepotWorkingData:
 
     @property
     def current_slot(self):
-        """Return slot number [int] if on an area, else None. The lowest slot
+        """Return slot number [int] if on an area, else None.
+
+        The lowest slot
         number is 0. Note that slot_no is not the list index.
         """
         if self.current_area is not None:
@@ -97,7 +99,8 @@ class DepotWorkingData:
 
     @property
     def current_charging_interface(self):
-        """Return [ChargingInterface] object of current slot on current area,
+        """Return [ChargingInterface] object of current slot on current area,.
+
         if any, else None.
         """
         if self.current_area is not None and self.current_area.charging_interfaces:
@@ -108,7 +111,8 @@ class DepotWorkingData:
 
     @property
     def etc_processes(self):
-        """Return simulation time estimate [int or EstimateValue] of when all
+        """Return simulation time estimate [int or EstimateValue] of when all.
+
         currently active processes will be completed.
         """
         etcs = [process.etc for process in self.active_processes]
@@ -134,7 +138,8 @@ class DepotWorkingData:
 
     @property
     def etc_processes_uncertain(self):
-        """Return estimate [int or EstimateValue] of when all currently active
+        """Return estimate [int or EstimateValue] of when all currently active.
+
         processes will be completed. Unlike self.etc_processes, get a rough
         estimate if an etc value is EstimateValue.UNKNOWN.
         """
@@ -203,7 +208,8 @@ class BackgroundStoreGet(FilterStoreExtGet):
 
 
 class BackgroundStore(FilterStoreExt):
-    """Virtual area for background tasks that require functionalities such as
+    """Virtual area for background tasks that require functionalities such as.
+
     logging.
     """
 
@@ -216,7 +222,9 @@ class BackgroundStore(FilterStoreExt):
     get = BoundClass(BackgroundStoreGet)
 
     def select(self, ID, print_missing=True):
-        """Return the item with *ID* in self.items. Return None if the ID is
+        """Return the item with *ID* in self.items.
+
+        Return None if the ID is
         not found.
         Relies on *ID* to be unique.
 
@@ -252,7 +260,9 @@ class UnassignedTrips(SortedList):
 
 
 class Depot:
-    """Representation of a depot. Owns all related objects such as areas
+    """Representation of a depot.
+
+    Owns all related objects such as areas
     and the DepotControl as attributes.
     A depot must be created and configured using a DepotConfigurator and may
     be empty upon instantation. Before simulation start, the validity of the
@@ -377,14 +387,16 @@ class Depot:
 
     @property
     def vacant_accessible(self):
-        """Return the sum of slots that are unoccupied and accessible
+        """Return the sum of slots that are unoccupied and accessible.
+
         (not blocked) from the default entrance side on all areas.
         """
         return sum(area.vacant_accessible for area in self.list_areas)
 
     @property
     def count(self):
-        """Return the amount of vehicles in the depot, i.e. the amount of
+        """Return the amount of vehicles in the depot, i.e. the amount of.
+
         occupied slots.
         """
         return self._count
@@ -397,14 +409,16 @@ class Depot:
 
     @property
     def max_count(self):
-        """Return the maximum number of vehicles that were in the depot at the
+        """Return the maximum number of vehicles that were in the depot at the.
+
         same time.
         """
         return self._max_count
 
     @property
     def maxOccupiedSlots(self):
-        """Return the total number of slots that have been occupied up to this
+        """Return the total number of slots that have been occupied up to this.
+
         point of time. Only functional if the simulation is run with the GUI.
         """
         totalUsedSlots = 0
@@ -414,7 +428,8 @@ class Depot:
 
     @property
     def urgent_trips(self):
-        """Return a list of trips that are urgent: due or delayed and no
+        """Return a list of trips that are urgent: due or delayed and no.
+
         vehicle assigned to.
         Relies on self.unassigned_trips to be sorted by std.
         """
@@ -430,7 +445,8 @@ class Depot:
 
     @property
     def overdue_trips(self):
-        """Return a list of trips that are overdue, i.e. have not started yet
+        """Return a list of trips that are overdue, i.e. have not started yet.
+
         although the target departure time has passed. Includes trips that have
         a scheduled vehicle.
         """
@@ -442,12 +458,14 @@ class Depot:
 
     def checkin(self, vehicle):
         """Redirect to checkin() of the depot's depot_control.
+
         Don't add code here.
         """
         self.depot_control.checkin(vehicle)
 
     def checkout(self, vehicle):
         """Redirect to checkout() of the depot's depot_control.
+
         Don't add code here.
         """
         self.depot_control.checkout(vehicle)
@@ -477,7 +495,9 @@ class BaseDispatchStrategy(ABC):
 
     @staticmethod
     def next_trips(depot):
-        """Return depot.urgent_trips, if not empty. Else return a list
+        """Return depot.urgent_trips, if not empty.
+
+        Else return a list
         containing only the unassigned trip with the lowest scheduled time of
         departure (std), if any. Otherwise return an empty list.
         Relies on depot.unassigned_trips to be sorted by std.
@@ -636,7 +656,8 @@ class BaseDispatchStrategy(ABC):
 
     @staticmethod
     def trigger_until_found(depot, trip, interval=60):
-        """Periodically trigger the *depot*'s dispatch until a vehicle is found
+        """Periodically trigger the *depot*'s dispatch until a vehicle is found.
+
         for *trip*. This triggering should be used for special cases only and
         *interval* [s] should be set with care due to a potentially high
         impact on sim time.
@@ -666,6 +687,7 @@ class DSFirst(BaseDispatchStrategy):
     @staticmethod
     def get_pending_vehicles(depot, trip):
         """Return a dict of pending vehicles.
+
         A vehicle is pending if it's at an area in a parking area group and has
         no trip assigned to, or its assigned trip's std is later than
         *trip*.std.
@@ -708,6 +730,7 @@ class DSFirst(BaseDispatchStrategy):
     @staticmethod
     def find_match(depot):
         """Find a matching vehicle for the next trip.
+
         Is called recursively while DSFirst.try_assign is successful.
         """
 
@@ -762,7 +785,9 @@ class DSFirst(BaseDispatchStrategy):
 
     @staticmethod
     def try_assign(vehicle, trip, depot):
-        """Try to match *vehicle* and *trip*. Return True if successful, else
+        """Try to match *vehicle* and *trip*.
+
+        Return True if successful, else
         False.
         """
         urgent = trip.vehicle is None and trip.std <= trip.env.now
@@ -833,6 +858,7 @@ class DSSmart(BaseDispatchStrategy):
     @staticmethod
     def get_suitable_vehicles(depot, trip, vf):
         """Return a list of vehicles that are suitable for *trip*.
+
         A vehicle is suitable if it's at an area in a parking area group and
         has no trip assigned to, or its assigned trip's std is later than
         *trip*.std. Furthermore, a vehicle must pass all criteria of *vf*. For
@@ -882,6 +908,7 @@ class DSSmart(BaseDispatchStrategy):
     @staticmethod
     def find_match(depot):
         """Find a matching vehicle for the next trip.
+
         Is called recursively while successful.
         """
         next_trips = DSSmart.next_trips(depot)
@@ -963,7 +990,8 @@ class DSSmart(BaseDispatchStrategy):
 
     @staticmethod
     def scheduling_delay(env, trip):
-        """Return the interval [int] from now until *lead_time_match* before
+        """Return the interval [int] from now until *lead_time_match* before.
+
         departure time of *trip*. Return 0 if the departure time is in less
         than *lead_time_match*.
         """
@@ -977,6 +1005,7 @@ class DSSmart(BaseDispatchStrategy):
 
 class DepotControl:
     """Control of vehicle movement and actions in the depot.
+
     Instantiated as attribute of the corresponding depot.
 
     Attributes:
@@ -990,8 +1019,10 @@ class DepotControl:
     dispatch_strategies = {DSFirst.name: DSFirst, DSSmart.name: DSSmart}
 
     parking_congestion_event_cls = None
-    """Event that succeeds if parking congestion occurs because no slot can be 
-    found at a parking area upon request."""
+    """Event that succeeds if parking congestion occurs because no slot can be.
+
+    found at a parking area upon request.
+    """
 
     def __init__(self, env, depot, dispatch_strategy_name="FIRST"):
         self.depot = depot
@@ -1004,7 +1035,8 @@ class DepotControl:
         self.departure_areas = AreaGroup(self.env, [], "departure_areas")
 
     def _complete(self):
-        """Actions that must take place before simulation start, but may not be
+        """Actions that must take place before simulation start, but may not be.
+
         possible during the depot configuration phase.
         """
         # Set self.process_request based on prioritize_init_store option. Not
@@ -1017,7 +1049,7 @@ class DepotControl:
 
     @property
     def dispatch_strategy_name(self):
-        """'name' attribute of set dispatch strategy"""
+        """'name' attribute of set dispatch strategy."""
         return self._dispatch_strategy_name
 
     @dispatch_strategy_name.setter
@@ -1030,7 +1062,7 @@ class DepotControl:
 
     @property
     def dispatch_strategy(self):
-        """[BaseDispatchStrategy] subclass"""
+        """[BaseDispatchStrategy] subclass."""
         return self._dispatch_strategy
 
     @dispatch_strategy.setter
@@ -1042,7 +1074,8 @@ class DepotControl:
         )
 
     def checkin(self, vehicle):
-        """Reset and set several variables upon arrival of a vehicle and
+        """Reset and set several variables upon arrival of a vehicle and.
+
         trigger follow-up actions.
         """
         # if vehicle.trip_at_departure is not vehicle.trip:
@@ -1088,7 +1121,9 @@ class DepotControl:
             vehicle.dwd.plan = self.depot.default_plan.copy()
 
     def proceed(self, vehicle):
-        """Main function to move a vehicle to the next area. Splits into
+        """Main function to move a vehicle to the next area.
+
+        Splits into
         proceed_area and proceed_group for further actions.
         """
         # an = vehicle.dwd.current_area.ID if vehicle.dwd.current_area is not None else None
@@ -1124,8 +1159,9 @@ class DepotControl:
                 current_area.trigger_get(None)
             self.trigger_dispatch()
 
-            if globalConstants["general"]["LOG_ATTRIBUTES"]:
-                current_area.logger.steplog()
+            # This was removed cause it triggered an Exception after fixing #90
+            # if globalConstants["general"]["LOG_ATTRIBUTES"]:
+            #    current_area.logger.steplog()
 
     def proceed_area(self, vehicle, current_area, next_area):
         """Proceed with *next_area* as a BaseArea subtype."""
@@ -1295,6 +1331,7 @@ class DepotControl:
 
     def get_process_need(self, vehicle, area):
         """Check what processes a vehicle will request at an area.
+
         Return a list of processes by ID to request, which can be empty.
         """
         flexprint(
@@ -1320,7 +1357,8 @@ class DepotControl:
         return process_IDs
 
     def run_processes(self, vehicle, process_IDs):
-        """Initialize and run processes marked in process_IDs for a vehicle at
+        """Initialize and run processes marked in process_IDs for a vehicle at.
+
         an area.
         If more than one process is requested, then all processes will be
         started simultaneously. Call proceed() when all processes have
@@ -1437,7 +1475,8 @@ class DepotControl:
         self.trigger_dispatch()
 
     def trigger_dispatch(self):
-        """Trigger the matching of trips and vehicles of
+        """Trigger the matching of trips and vehicles of.
+
         self.dispatch_strategy.
         """
         self.dispatch_strategy.trigger(self.depot)
@@ -1452,8 +1491,10 @@ class DepotControl:
         self.env.process(self.process_request(trip, filter=filter))
 
     def register_for_dispatch(self, trip):
-        """Prepare processing the vehicle request for *trip* by the regular
-        dispatch."""
+        """Prepare processing the vehicle request for *trip* by the regular.
+
+        dispatch.
+        """
         self.depot.pending_departures.append(trip)
         self.env.process(self.schedule_for_matching(trip))
 
@@ -1473,6 +1514,7 @@ class DepotControl:
 
     def process_request_prio_parking(self, trip, filter=lambda item: True):
         """Return a vehicle from the depot for which *filter* returns True.
+
         If there is no matching vehicle available immediately at
         self.departure_areas, try to get a vehicle from depot.init_store.
         If there is no matching vehicle either, issue requests at
@@ -1546,6 +1588,7 @@ class DepotControl:
 
     def process_request_prio_init(self, trip, filter=lambda item: True):
         """Return a vehicle from the depot for which *filter* returns True.
+
         Try to get a vehicle from depot.init_store first. If there is no
         match available, issue requests at self.departure_areas.
         """
@@ -1597,6 +1640,7 @@ def assert_after_checkout(env, vehicle):
 
 def update_relations(put_event):
     """Updater to be called as callback of a successful put event for an area.
+
     Relies on a corresponding get event to succeed in the same simulation
     time step.
     """
@@ -1612,7 +1656,9 @@ def update_relations(put_event):
 
 
 class BaseArea(ABC):
-    """Abstract base class for an area in a depot. Subclasses must inherit from
+    """Abstract base class for an area in a depot.
+
+    Subclasses must inherit from
     a SimPy Store subclass that has attributes 'capacity', 'items' and
     'vacant'.
 
@@ -1647,7 +1693,6 @@ class BaseArea(ABC):
     slot_orientation: [str] orientation of slots. Used for display purposes
         in the GUI only, has no functional purpose. See
         gui.area_view.DepotAreaView for documentation.
-
     """
 
     @abstractmethod
@@ -1700,7 +1745,8 @@ class BaseArea(ABC):
 
     @property
     def vacant_accessible(self):
-        """Helper function to distinguish between direct and line areas for the
+        """Helper function to distinguish between direct and line areas for the.
+
         determination of vacant accessible slots.
         """
         if isinstance(self, LineArea):
@@ -1714,7 +1760,8 @@ class BaseArea(ABC):
 
     @property
     def charge_proc(self):
-        """Return the type of the Charge or subclass process available at this
+        """Return the type of the Charge or subclass process available at this.
+
         area. Return None if there is None. Relies on the assumption that there
         is only one charging process at an area at max.
         """
@@ -1737,14 +1784,13 @@ class BaseArea(ABC):
 
     @property
     def scheduledVehicles(self):
-        """
-        Returns list of scheduled vehicles (trips assigned).
-        """
+        """Returns list of scheduled vehicles (trips assigned)."""
         return [vehicle for vehicle in self.vehicle if vehicle.trip is not None]
 
     @property
     def count_rfd(self):
-        """Return the number of vehicles that are ready for departure at this
+        """Return the number of vehicles that are ready for departure at this.
+
         area.
         """
         return sum(item.dwd.isrfd for item in self.vehicles)
@@ -1752,12 +1798,14 @@ class BaseArea(ABC):
     @property
     @abstractmethod
     def count_rfd_unblocked(self):
-        """Return the number of vehicles that are ready for departure and not
+        """Return the number of vehicles that are ready for departure and not.
+
         blocked from departure at this area.
         """
 
     def istypestack(self, substitution=True):
-        """Return a tuple (istypestack [bool or None], vehicle_type
+        """Return a tuple (istypestack [bool or None], vehicle_type.
+
         [VehicleType or None]).
 
         istypestack is True if all vehicles are of the same type. vehicle_type
@@ -1779,7 +1827,8 @@ class BaseArea(ABC):
             return None, None
 
     def istypestack_with(self, vehicle, substitution=True):
-        """Return True if current vehicles would be a typestack together with
+        """Return True if current vehicles would be a typestack together with.
+
         *vehicle*. Extenuate the comparison with subsitutable types if
         *substitution* is True. Return None if the area is empty. Otherwise
         return False.
@@ -1795,7 +1844,9 @@ class BaseArea(ABC):
             return all(vi.vehicle_type is vehicle.vehicle_type for vi in self.vehicles)
 
     def select(self, ID, print_missing=True):
-        """Return the item with *ID* in self.items. Return None if the ID is
+        """Return the item with *ID* in self.items.
+
+        Return None if the ID is
         not found.
         Relies on *ID* to be unique.
 
@@ -1840,7 +1891,8 @@ class BaseAreaPut(ABC):
         if globalConstants["general"]["LOG_ATTRIBUTES"]:
 
             def calc_waiting_time(request):
-                """Log the waiting time from init until success of *request*
+                """Log the waiting time from init until success of *request*.
+
                 in the vehicle's data logger.
                 """
                 waiting_time = request.item.env.now - request.init_time
@@ -1893,11 +1945,12 @@ class BaseAreaGet(ABC):
 
 
 class DirectAreaPut(BaseAreaPut, ExclusiveRequest, StorePutExt):
-    """Request to put *item* into the *store*. The request is triggered once
+    """Request to put *item* into the *store*.
+
+    The request is triggered once
     there is space for the item in the store.
 
     Callbacks by BaseAreaPut are added last.
-
     """
 
     def __init__(self, store, item, other_requests=None):
@@ -1907,7 +1960,9 @@ class DirectAreaPut(BaseAreaPut, ExclusiveRequest, StorePutExt):
 
 
 class DirectAreaGet(BaseAreaGet, ExclusiveRequest, FilterStoreExtGet):
-    """Request to get an *item* from the *store* matching the *filter*. The
+    """Request to get an *item* from the *store* matching the *filter*.
+
+    The
     request is triggered once there is such an item available in the store.
 
     *filter* is a function receiving one item. It should return ``True`` for
@@ -1916,7 +1971,6 @@ class DirectAreaGet(BaseAreaGet, ExclusiveRequest, FilterStoreExtGet):
     :class:`StoreGet`.
 
     Callbacks by BaseAreaGet are added last.
-
     """
 
     def __init__(self, store, filter=lambda item: True, other_requests=None, **kwargs):
@@ -1926,11 +1980,11 @@ class DirectAreaGet(BaseAreaGet, ExclusiveRequest, FilterStoreExtGet):
 
 
 class DirectArea(BaseArea, PositionalFilterStore):
-    """Depot area where vehicles don't block each other and therefore direct
+    """Depot area where vehicles don't block each other and therefore direct.
+
     access on all stored vehicles is possible.
 
     See parent class descriptions for more details.
-
     """
 
     def __init__(
@@ -1963,20 +2017,21 @@ class DirectArea(BaseArea, PositionalFilterStore):
 
     @property
     def pendingVehicles(self):
-        """
-        Returns list of pending vehicles (potentially blocking vehicles).
-        """
+        """Returns list of pending vehicles (potentially blocking vehicles)."""
         return []
 
     @property
     def count_rfd_unblocked(self):
-        """Return the number of vehicles that are ready for departure and not
+        """Return the number of vehicles that are ready for departure and not.
+
         blocked from departure at this area.
         """
         return sum(vehicle.dwd.isrfd for vehicle in self.vehicles)
 
     def slot_no(self, item):
-        """Return the slot number of *item*. Return None if item is not in
+        """Return the slot number of *item*.
+
+        Return None if item is not in
         self.items.
         Unlike list indexing, slot number counting starts at 1. Therefore only
         meant for display purposes, otherwise use items.index(vehicle).
@@ -1988,20 +2043,22 @@ class DirectArea(BaseArea, PositionalFilterStore):
 
     @staticmethod
     def index2slot_no(index):
-        """Convert *index* (correct value for indexing list self.items) to slot
-        number (for display purposes)."""
+        """Convert *index* (correct value for indexing list self.items) to slot.
+
+        number (for display purposes).
+        """
         return index + 1
 
 
 class LineAreaPut(BaseAreaPut, ExclusiveRequest, LineStorePut):
-    """Request to put *item* onto deepest accessible slot from *side* in
+    """Request to put *item* onto deepest accessible slot from *side* in.
+
     *store*. The request is triggered once there is accessible space for the
     item in the store.
 
     side: [str] Same as in LineStorePut.
 
     Callbacks by BaseAreaPut are added last.
-
     """
 
     def __init__(self, store, item, side="default", other_requests=None):
@@ -2011,7 +2068,8 @@ class LineAreaPut(BaseAreaPut, ExclusiveRequest, LineStorePut):
 
 
 class LineAreaGet(BaseAreaGet, ExclusiveRequest, LineFilterStoreGet):
-    """Request to get the first accessible *item* from *side* in *store*
+    """Request to get the first accessible *item* from *side* in *store*.
+
     matching *filter*(item). The request is triggered once there is an
     accessible item available in the store.
 
@@ -2024,7 +2082,6 @@ class LineAreaGet(BaseAreaGet, ExclusiveRequest, LineFilterStoreGet):
     interface for customization.
 
     Callbacks by BaseAreaGet are added last.
-
     """
 
     def __init__(
@@ -2036,14 +2093,14 @@ class LineAreaGet(BaseAreaGet, ExclusiveRequest, LineFilterStoreGet):
 
 
 class LineArea(BaseArea, LineFilterStore):
-    """Depot area where vehicles are arranged in a line and can block each
+    """Depot area where vehicles are arranged in a line and can block each.
+
     other (feature of LineFilterStore). Therefore not all stored vehicles may
     be directly accessible.
     See parent class descriptions for more details.
 
     At the moment, only areas where issink is True (e.g. typically False for a
     service area, True for parking areas) can reliably be of this area type.
-
     """
 
     def __init__(
@@ -2086,14 +2143,13 @@ class LineArea(BaseArea, LineFilterStore):
 
     @property
     def pendingVehicles(self):
-        """
-        Returns list of pending vehicles (potentially blocking vehicles).
-        """
+        """Returns list of pending vehicles (potentially blocking vehicles)."""
         return [item for item in self.items if item is not None and item.trip is None]
 
     @property
     def count_rfd_unblocked(self):
-        """Return the number of vehicles that are ready for departure and not
+        """Return the number of vehicles that are ready for departure and not.
+
         blocked from departure at this area.
         """
         return sum(
@@ -2101,7 +2157,9 @@ class LineArea(BaseArea, LineFilterStore):
         )
 
     def slot_no(self, item):
-        """Return the slot number of *item*. Return None if item is not in
+        """Return the slot number of *item*.
+
+        Return None if item is not in
         self.items.
         The slot closest to the front has the lowest number, which is the
         reverse of items.index. Unlike list indexing, slot number counting
@@ -2114,8 +2172,10 @@ class LineArea(BaseArea, LineFilterStore):
             return None
 
     def index2slot_no(self, index):
-        """Convert *index* (correct value for indexing self.items) to slot
-        number (for display purposes)."""
+        """Convert *index* (correct value for indexing self.items) to slot.
+
+        number (for display purposes).
+        """
         return self.capacity - index
 
 
@@ -2135,7 +2195,9 @@ class BaseParkingStrategy(ABC):
     @staticmethod
     @abstractmethod
     def determine_store(*args, **kwargs):
-        """Return the most suitable area for parking a vehicle. A put request
+        """Return the most suitable area for parking a vehicle.
+
+        A put request
         to this area must be immediately successful.
         """
 
@@ -2215,7 +2277,6 @@ class PSSmart(BaseParkingStrategy):
 
     Note: This strategy only makes sense with stores that don't restrict by
     vehicle type, since it wont have any effect on typed stores.
-
     """
 
     name = "SMART"
@@ -2251,7 +2312,8 @@ class PSSmart(BaseParkingStrategy):
     @staticmethod
     def rate_stores(preselected_stores, vehicle):
         """
-        Rate [preselected_stores] by accessibility for [vehicle] and
+        Rate [preselected_stores] by accessibility for [vehicle] and.
+
         return a dict (key: result, value: list of stores having this result).
 
         Called by DSFirst.find_match.
@@ -2271,7 +2333,8 @@ class PSSmart(BaseParkingStrategy):
     @staticmethod
     def rate_store(store, vehicle):
         """
-        Rate [store] by accessibility for [vehicle]: 0 means directly
+        Rate [store] by accessibility for [vehicle]: 0 means directly.
+
         accessible, higher values mean lower accessibility (lower => better).
 
         Called by DSFirst.rate_stores.
@@ -2382,6 +2445,7 @@ class PSSmart2(BaseParkingStrategy):
     @staticmethod
     def log_best(parking_area_group, rating):
         """Add the best value of a rating to parking_area_group.pssmart2_logs.
+
         rating: [ParkRating]
         """
         if globalConstants["general"]["LOG_ATTRIBUTES"]:
@@ -2408,7 +2472,6 @@ class AreaGroup(StoreConnector):
     max_capacity_line: [int] maximum capacity among Line areas in this group
     capacity_direct: [int] total cacpacity of Direct areas in this group
     capacity_line: [int] total cacpacity of Line areas in this group
-
     """
 
     def __init__(self, env, stores, ID):
@@ -2423,13 +2486,16 @@ class AreaGroup(StoreConnector):
         self.ID = ID
 
     def clear(self):
-        """Remove all entries from self.stores and update. self.depot is
+        """Remove all entries from self.stores and update.
+
+        self.depot is
         unaffected.
         """
         super().clear()
 
     def check_entry_filters(self, vehicle):
-        """Return a list of booleans that are the results of entry permission
+        """Return a list of booleans that are the results of entry permission.
+
         checks at areas in self.stores. Has the same length as
         self.stores.
         """
@@ -2437,7 +2503,8 @@ class AreaGroup(StoreConnector):
         return permissions
 
     def update_defaults(self):
-        """Update attributes after relevant changes such as the amount of areas
+        """Update attributes after relevant changes such as the amount of areas.
+
         in the group.
         """
         self.default_selection_put = [True] * len(self.stores)
@@ -2478,7 +2545,9 @@ class AreaGroup(StoreConnector):
 
 
 class ParkingAreaGroup(AreaGroup):
-    """Group specifically for parking areas. Provides various algorithms to
+    """Group specifically for parking areas.
+
+    Provides various algorithms to
     decide in which area to put a vehicle.
 
     Parameters:
@@ -2491,7 +2560,6 @@ class ParkingAreaGroup(AreaGroup):
         simulation start. None if there are no charging interfaces.
     put_queue: [dict] Container for keeping count and time of pending put
         requests to the group. Provisional, may be changed.
-
     """
 
     parking_strategies = {
@@ -2533,7 +2601,7 @@ class ParkingAreaGroup(AreaGroup):
 
     @property
     def parking_strategy_name(self):
-        """'name' attribute of set parking strategy"""
+        """'name' attribute of set parking strategy."""
         return self._parking_strategy_name
 
     @parking_strategy_name.setter
@@ -2545,7 +2613,7 @@ class ParkingAreaGroup(AreaGroup):
 
     @property
     def parking_strategy(self):
-        """[BaseParkingStrategy] subclass"""
+        """[BaseParkingStrategy] subclass."""
         return self._parking_strategy
 
     @parking_strategy.setter
@@ -2576,7 +2644,9 @@ class ParkingAreaGroup(AreaGroup):
             store.parking_area_group = None
 
     def clear(self):
-        """Remove all entries from self.stores and update. self.depot,
+        """Remove all entries from self.stores and update.
+
+        self.depot,
         self.depot.parking_area_groups and self.parking_strategy are
         unaffected.
         """
@@ -2616,7 +2686,9 @@ class ParkingAreaGroup(AreaGroup):
                 max_power = None
 
     def put(self, item, selection=None):
-        """Summarize put_imm and put_wait. A parking strategy is applied here.
+        """Summarize put_imm and put_wait.
+
+        A parking strategy is applied here.
 
         In this method strategies can be determined before calling the actual
         put() methods, e.g. by modifying the *selection* parameter.
@@ -2679,11 +2751,11 @@ class ParkingAreaGroup(AreaGroup):
 
 class BaseActivityPlan(ABC):
     """Base class for the guidance of a vehicle inside a depot.
+
     A copied instance is assigned to a vehicle at check-in.
 
     Parameters:
     locations: [list] of DepotArea or AreaGroup objects
-
     """
 
     def __init__(self, ID, locations=None, vehicle_filter=None):
@@ -2735,9 +2807,10 @@ class BaseActivityPlan(ABC):
 
 
 class DefaultActivityPlan(BaseActivityPlan):
-    """Default plan applicable for every vehicle. One plan is mandatory for a
-    depot configuration.
+    """Default plan applicable for every vehicle.
 
+    One plan is mandatory for a
+    depot configuration.
     """
 
     def __init__(self, locations=None):
@@ -2749,9 +2822,10 @@ class DefaultActivityPlan(BaseActivityPlan):
 
 
 class SpecificActivityPlan(BaseActivityPlan):
-    """Plan that is applicable to vehicles passing vehicle_filter only. A depot
-    configuration may include zero or more specific plans.
+    """Plan that is applicable to vehicles passing vehicle_filter only.
 
+    A depot
+    configuration may include zero or more specific plans.
     """
 
     def __init__(self, ID, locations=None, vehicle_filter=None):

eflips/depot/processes.py

@@ -1,14 +1,16 @@
 # -*- coding: utf-8 -*-
-"""
-Components for processes in a depot.
-
-"""
-from enum import auto, Enum
-import simpy
+"""Components for processes in a depot."""
+import math
+import warnings
 from abc import ABC, abstractmethod
+from enum import auto, Enum
 from warnings import warn
-from eflips.settings import globalConstants
+
+import simpy
 from eflips.helperFunctions import flexprint
+from eflips.settings import globalConstants
+
+import eflips
 from eflips.depot.evaluation import (
     BatteryLog,
     ChargeStart,
@@ -16,8 +18,6 @@ from eflips.depot.evaluation import (
     ProcessFinished,
 )
 from eflips.depot.filters import VehicleFilter
-import eflips
-import math
 
 
 class ProcessStatus(Enum):
@@ -31,9 +31,9 @@ class ProcessStatus(Enum):
 
 
 class EstimateValue(Enum):
-    """Values for process completion time estimates in addition to an int
-    value.
+    """Values for process completion time estimates in addition to an int.
 
+    value.
     """
 
     UNKNOWN = auto()  # process not completed but an estimate is not possible
@@ -41,7 +41,9 @@ class EstimateValue(Enum):
 
 
 class BaseDepotProcess(ABC):
-    """Base class for processes in a depot. Core functionalities are:
+    """Base class for processes in a depot.
+
+    Core functionalities are:
      - wrapping the execution of a simpy process and handling of required
         resources,
      - providing the option to resume the process after interruption.
@@ -87,7 +89,6 @@ class BaseDepotProcess(ABC):
         and won't be resumed, resulting in self.__call__ to proceed.
     etc: [int or EstimateValue] estimated simulation time of completion. See
         method self._estimate_time_of_completion for details.
-
     """
 
     @abstractmethod
@@ -141,7 +142,7 @@ class BaseDepotProcess(ABC):
 
     @property
     def resIDs(self):
-        """Return a list of IDs of self.required_resources"""
+        """Return a list of IDs of self.required_resources."""
         return [res.ID for res in self.required_resources]
 
     @property
@@ -178,7 +179,9 @@ class BaseDepotProcess(ABC):
 
     @abstractmethod
     def _action(self, *args, **kwargs):
-        """Generator function that characterizes the process. Subclasses must
+        """Generator function that characterizes the process.
+
+        Subclasses must
         implement this method. It must catch the exception simpy.Interrupt and
         let it pass or implement custom follow-ups. If this method yields a
         timeout, the duration must be set as self.dur before the yield
@@ -188,7 +191,8 @@ class BaseDepotProcess(ABC):
     @staticmethod
     @abstractmethod
     def estimate_duration(*args, **kwargs):
-        """Return an estimate of the process duration in seconds based on given
+        """Return an estimate of the process duration in seconds based on given.
+
         parameters as as if it could start immediately. Must be int, not float.
         Possible waiting time for resources are not considered. Therefore the
         estimate is reliable only if the process is started immediately. Static
@@ -196,8 +200,10 @@ class BaseDepotProcess(ABC):
         """
 
     def _pre(self, *args, **kwargs):
-        """Space for actions before calling self._pem that may not be possible
-        upon init."""
+        """Space for actions before calling self._pem that may not be possible.
+
+        upon init.
+        """
         pass
 
     def _post(self, *args, **kwargs):
@@ -206,6 +212,7 @@ class BaseDepotProcess(ABC):
 
     def __call__(self, *args, **kwargs):
         """Generator that starts the execution of this process.
+
         Note that all parameters required by self._action() have to be passed
         as keyword arguments.
         """
@@ -225,7 +232,8 @@ class BaseDepotProcess(ABC):
         self._post(*args, **kwargs)
 
     def _pem(self, recall=False, *args, **kwargs):
-        """Process execution method (pem) that wraps waiting for required
+        """Process execution method (pem) that wraps waiting for required.
+
         resources (if any) and self._action in a single generator. Is called
         again for the remaining duration after interruption if self.resume is
         True.
@@ -417,7 +425,9 @@ class BaseDepotProcess(ABC):
             )
 
     def cancel(self):
-        """Immediately stop the current process execution. No restart is
+        """Immediately stop the current process execution.
+
+        No restart is
         scheduled, even if self.resume was set to True before.
         """
         if hasattr(
@@ -457,7 +467,9 @@ class BaseDepotProcess(ABC):
         self.finished.succeed()
 
     def interrupt(self):
-        """Immediately stop the current process execution. If self.resume is
+        """Immediately stop the current process execution.
+
+        If self.resume is
         True, a restart is scheduled and may be successful immediately if
         required resources are available. If self.resume is False, same effect
         as self.cancel.
@@ -482,7 +494,6 @@ class VehicleProcess(BaseDepotProcess, ABC):
     request_immediately: [bool] if True, a vehicle will request this process to
         start immediately after entering the area this process is available at.
         There might still be waiting time due to resource requirements.
-
     """
 
     request_immediately = True
@@ -644,7 +655,6 @@ class ChargeAbstract(VehicleProcess, ABC):
 
     Attributes:
     last_update: [int] time of last call to self.update_battery.
-
     """
 
     @abstractmethod
@@ -723,7 +733,9 @@ class ChargeAbstract(VehicleProcess, ABC):
 
     @classmethod
     def get_chargedata(cls, vehicle):
-        """Get data for charging process of class *cls*. Not robust if there
+        """Get data for charging process of class *cls*.
+
+        Not robust if there
         are multiple data sets using *cls* with different parameters and
         vehicle filters that can return True for the same vehicle.
         """
@@ -738,7 +750,9 @@ class ChargeAbstract(VehicleProcess, ABC):
         )
 
     def update_battery(self, event_name, amount=None):
-        """Update the energy level of self.vehicle.battery. Can be called
+        """Update the energy level of self.vehicle.battery.
+
+        Can be called
         during the execution of the process to provide an interim update.
 
         Parameters:
@@ -780,7 +794,9 @@ class ChargeAbstract(VehicleProcess, ABC):
 
 
 class Charge(ChargeAbstract):
-    """Process of charging a vehicle's battery. Charging is constant during the
+    """Process of charging a vehicle's battery.
+
+    Charging is constant during the
     whole charging process with maximum power provided by the charging
     interface.
 
@@ -788,7 +804,6 @@ class Charge(ChargeAbstract):
     soc_target: [int or float or str] the charging process will stop at this
         soc. Must be 0 < soc_target <= 1 or 'soc_max'. For soc_max,
         vehicle.battery.soc_max will be used as soc_target.
-
     """
 
     def __init__(
@@ -891,7 +906,9 @@ class Charge(ChargeAbstract):
 
         except simpy.Interrupt:
             flexprint("charge interrupted", env=self.env, switch="processes")
-            self.update_battery("charge_interrupt")
+            actual_charging_duration = self.env.now - self.starts[0]
+            actual_charged_energy = (effective_power * actual_charging_duration) / 3600
+            self.update_battery("charge_interrupt", amount=actual_charged_energy)
 
         self.charging_interface.current_power = 0
         self.vehicle.power_logs[self.env.now] = 0
@@ -900,7 +917,8 @@ class Charge(ChargeAbstract):
 
     @staticmethod
     def estimate_duration(vehicle, charging_interface, *args, **kwargs):
-        """Return a duration estimate [int] assuming constant charging at
+        """Return a duration estimate [int] assuming constant charging at.
+
         maximum power until soc_target is reached.
         """
         chargedata = Charge.get_chargedata(vehicle)
@@ -952,7 +970,6 @@ class ChargeSteps(ChargeAbstract):
         from the class ChargeAbstract/Charge.
         Note that the power values must not be higher than the maximum power of
         the charging interface.
-
     """
 
     def __init__(
@@ -1169,7 +1186,8 @@ class ChargeSteps(ChargeAbstract):
 
 
 class ChargeEquationSteps(ChargeAbstract):
-    """Process of charging a vehicle's battery based on a linearized function
+    """Process of charging a vehicle's battery based on a linearized function.
+
     for power.
 
     Parameters:
@@ -1183,7 +1201,6 @@ class ChargeEquationSteps(ChargeAbstract):
         significantly increase simulation runtime. Precision is capped to
         intervals resulting in step durations >= 1 second.
     soc_target: same as for class Charge
-
     """
 
     def __init__(
@@ -1343,6 +1360,10 @@ class ChargeEquationSteps(ChargeAbstract):
         except simpy.Interrupt:
             flexprint("charge interrupted", env=self.env, switch="processes")
             self.update_battery("charge_interrupt")
+            warnings.warn(
+                "It is unclear whether interrupting a charging process of this type returns the desired "
+                "result. Double-check the battery state after the simulation."
+            )
 
         self.charging_interface.current_power = 0
         self.vehicle.power_logs[self.env.now] = 0
@@ -1390,7 +1411,6 @@ def exponential_power(vehicle, charging_interface, peq_params, *args, **kwargs):
     charging_interface: [DepotChargingInterface]
     peq_params: [dict] with parameters for this function in addition to what is
         accessible via vehicle and charging_interface
-
     """
     SoC = vehicle.battery.soc
     P_max = charging_interface.max_power
@@ -1584,7 +1604,6 @@ class Precondition(VehicleProcess):
     Attributes:
     request_immediately: is False for this class because preconditioning is
         scheduled depending on departure time instead of entry time at an area.
-
     """
 
     request_immediately = False

{eflips_depot-3.0.0.dist-info → eflips_depot-3.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eflips-depot
-Version: 3.0.0
+Version: 3.0.2
 Summary: Depot Simulation for eFLIPS
 License: AGPLv3
 Author: Enrico Lauth

{eflips_depot-3.0.0.dist-info → eflips_depot-3.0.2.dist-info}/RECORD

@@ -1,11 +1,12 @@
+eflips/depot/.DS_Store,sha256=KzHp46okh461fSINWUgzRhJ8nGo6jsHoENU0EAwl_pQ,6148
 eflips/depot/__init__.py,sha256=n7jte8R6j_Ad4Mp4hkklKwil5r8u8Q_SbXrCC-nf5jM,1556
-eflips/depot/api/__init__.py,sha256=NPHgcqnX6r0ZvK5Yi3S92dZKVH9e-Bs6uJCWMChLeI0,45403
+eflips/depot/api/__init__.py,sha256=WenYoLrAk94Jc-nD7NOD0AZ_2IR7pjsfkz_dA-Jv644,48272
 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=KIQ_K-UMSwipNYQ_Vl1jsyL6kn2Cmy1dTApZG4Ciluw,16579
+eflips/depot/api/private/depot.py,sha256=3VvSAFnLZtsraD8m685zqqi-pwfOci66pc7FRVSjxP8,16594
 eflips/depot/api/private/util.py,sha256=2qVTGeAtAhoq-h5V7Xlli2aDniuoIZYtaCAHD0n1sl8,15261
 eflips/depot/configuration.py,sha256=Op3hlir-dEN7yHr0kTqbYANoCBKFWK6uKOv3NJl8w_w,35678
-eflips/depot/depot.py,sha256=K--jDwMUHs0dJMBIAKKLqxJjxLef4-zT_iB6_MdPY8M,105284
+eflips/depot/depot.py,sha256=afIlaiX-J-M5-K_oAGMr_soL3_QjIAwrQKDaZzTwle0,105566
 eflips/depot/evaluation.py,sha256=qqXyP4jA1zFcKuWhliQ6n25ZlGl9mJV-vtXf0yu8WN8,140842
 eflips/depot/filters.py,sha256=ZBTiu0UJUp2NYWtvZewfb4Zd4mdmFLkrjIS-ujCgax8,15522
 eflips/depot/input_epex_power_price.py,sha256=VPDC1zy-klQpveGIZ8941hL1P_jeNq3IHoLgFTsANig,5569
@@ -25,7 +26,7 @@ eflips/depot/layout_opt/settings.py,sha256=EUGCp4dAX22j2uF8sKqbi9a5iP8hb6QpP7t2N
 eflips/depot/layout_opt/template_creation.py,sha256=H4LoFjQfbPjTt9rGvapH2tEUWcQ56kPwDucq7t6YahU,9736
 eflips/depot/layout_opt/util.py,sha256=EYh7IN58ZjysmCFdSieQqIQ9goe1a_ZwARRHxOgjEQo,3780
 eflips/depot/plots.py,sha256=85xInZWfJIOVm03onvppgP5yLTgQeMn-1t5aoNdavyY,2509
-eflips/depot/processes.py,sha256=pDc5lYvHsGBIB2O0Q5jnPuUCfdw2lsWaY2B6GtQTLtU,58260
+eflips/depot/processes.py,sha256=vqwtaK5UfG5aJwsQL2Eo9ZOFg1z5khuNPyEC9-3M83Y,58757
 eflips/depot/rating.py,sha256=vBUr3y31DBcA-LjZW8t6wLfpAsuB8DPkrMThtCtN908,16648
 eflips/depot/resources.py,sha256=0SuzN8qgMmCqa7oUEXVC_XE6pCUtxTsqOfCsaM9Oh3o,13568
 eflips/depot/settings_config.py,sha256=z7CqPdjd8QRlgZj0Zis-H13cL7LOiheRT4ctYCYGguc,2527
@@ -34,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.0.0.dist-info/LICENSE.md,sha256=KB4XTk1fPHjtZCYDyPyreu6h1LVJVZXYg-5vePcWZAc,34143
-eflips_depot-3.0.0.dist-info/METADATA,sha256=vFl6gYJzQFa7wxTpT2KNR_AC_dnZrE0RVazRrZrQhRI,5648
-eflips_depot-3.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-eflips_depot-3.0.0.dist-info/RECORD,,
+eflips_depot-3.0.2.dist-info/LICENSE.md,sha256=KB4XTk1fPHjtZCYDyPyreu6h1LVJVZXYg-5vePcWZAc,34143
+eflips_depot-3.0.2.dist-info/METADATA,sha256=nbFn4zt1i10t3WkwSc6da-U5krwSbDFGWIOxhd9yKcM,5648
+eflips_depot-3.0.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+eflips_depot-3.0.2.dist-info/RECORD,,