eflips-depot 4.0.1__tar.gz → 4.1.0__tar.gz

{eflips_depot-4.0.1 → eflips_depot-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eflips-depot
-Version: 4.0.1
+Version: 4.1.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 (>=4.0.0a2,<5.0.0)
+Requires-Dist: eflips-model (>=4.0.0,<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-4.0.1 → eflips_depot-4.1.0}/eflips/depot/api/__init__.py

@@ -27,12 +27,12 @@ The following steps are recommended for using the API:
 import copy
 import datetime
 import itertools
+import logging
 import os
 import warnings
+from collections import OrderedDict
 from datetime import timedelta
 from enum import Enum
-from math import ceil
-from collections import OrderedDict
 from typing import Any, Dict, Optional, Union, List
 
 import numpy as np
@@ -47,6 +47,7 @@ from eflips.model import (
     Trip,
     Vehicle,
 )
+from math import ceil
 from sqlalchemy.orm import Session
 from sqlalchemy.sql import select
 
@@ -132,6 +133,8 @@ def simple_consumption_simulation(
 
     :return: Nothing. The results are added to the database.
     """
+    logger = logging.getLogger(__name__)
+
     with create_session(scenario, database_url) as (session, scenario):
         rotations = (
             session.query(Rotation)
@@ -218,6 +221,7 @@ def simple_consumption_simulation(
         session.flush()
 
         for rotation in rotations:
+            rotation: Rotation
             with session.no_autoflush:
                 vehicle_type = rotation.vehicle_type
                 vehicle = rotation.vehicle
@@ -286,6 +290,59 @@ def simple_consumption_simulation(
                 )
                 session.add(current_event)
 
+                # If the vehicle is
+                #  - Capable of opportunity charging
+                #  - On a Rotation which allows opportunity charging
+                #  - Currently at a station which allows opportunity charging
+                #  - which is not the last trip of the rotation
+                #  We add a charging event
+
+                if (
+                    rotation.vehicle_type.opportunity_charging_capable
+                    and rotation.allow_opportunity_charging
+                    and trip.route.arrival_station.is_electrified
+                    and trip != rotation.trips[-1]
+                ):
+                    logger.debug(
+                        f"Adding opportunity charging event for trip {trip.id}"
+                    )
+                    # Identify the break time between trips
+                    trip_index = rotation.trips.index(trip)
+                    next_trip = rotation.trips[trip_index + 1]
+                    break_time = next_trip.departure_time - trip.arrival_time
+
+                    # How much energy can be charged in this time?
+                    energy_charged = (
+                        max([v[1] for v in vehicle_type.charging_curve])
+                        * break_time.total_seconds()
+                        / 3600
+                    )
+
+                    if energy_charged > 0:
+                        # Calculate the end SoC
+                        post_charge_soc = min(
+                            current_soc
+                            + energy_charged / vehicle_type.battery_capacity,
+                            1,
+                        )
+
+                        # Create the charging event
+                        current_event = Event(
+                            scenario_id=scenario.id,
+                            vehicle_type_id=rotation.vehicle_type_id,
+                            vehicle=vehicle,
+                            station_id=trip.route.arrival_station_id,
+                            time_start=trip.arrival_time,
+                            time_end=next_trip.departure_time,
+                            soc_start=current_soc,
+                            soc_end=post_charge_soc,
+                            event_type=EventType.CHARGING_OPPORTUNITY,
+                            description=f"Opportunity charging event for trip {trip.id}.",
+                            timeseries=None,
+                        )
+                        current_soc = post_charge_soc
+                        session.add(current_event)
+
 
 def generate_depot_layout(
     scenario: Union[Scenario, int, Any],
@@ -915,6 +972,7 @@ def _get_finished_schedules_per_vehicle(
 ):
     """
     This function completes the following tasks:
+
     1. It gets the finished non-copy schedules of the current vehicle,
     which will be used in :func:`_update_vehicle_in_rotation()`.
 
@@ -986,7 +1044,9 @@ def _generate_vehicle_events(
     latest_time: datetime.datetime,
 ) -> None:
     """
-    This function generates and ordered dictionary storing the data related to an event. It returns a dictionary. The keys are the start times of the
+    This function generates and ordered dictionary storing the data related to an event.
+
+    It returns a dictionary. The keys are the start times of the
     events. The values are also dictionaries containing:
     - type: The type of the event.
     - end: The end time of the event.
@@ -998,7 +1058,6 @@ def _generate_vehicle_events(
 
     For waiting events, the slot is not stored for now.
 
-
     :param current_vehicle: a :class:`eflips.depot.simple_vehicle.SimpleVehicle` object.
 
     :param virtual_waiting_area_id: the id of the virtual waiting area. Vehicles waiting for the first process will park here.
@@ -1222,7 +1281,8 @@ def _add_events_into_database(
     db_vehicle, dict_of_events, session, scenario, simulation_start_time
 ) -> None:
     """
-    This function generates :class:`eflips.model.Event` objects from the dictionary of events and adds them into the
+    This function generates :class:`eflips.model.Event` objects from the dictionary of events and adds them into the.
+
     database.
 
     :param db_vehicle: vehicle object in the database
@@ -1344,6 +1404,7 @@ def _add_events_into_database(
 def _update_vehicle_in_rotation(session, scenario, list_of_assigned_schedules) -> None:
     """
     This function updates the vehicle id assigned to the rotations and deletes the events that are not depot events.
+
     :param session: a :class:`sqlalchemy.orm.Session` object for database connection.
     :param scenario: the current simulated scenario
     :param list_of_assigned_schedules: a list of tuples containing the rotation id and the vehicle id.
@@ -1381,7 +1442,8 @@ def _update_vehicle_in_rotation(session, scenario, list_of_assigned_schedules) -
 
 def _update_waiting_events(session, scenario, waiting_area_id) -> None:
     """
-    This function evaluates the capacity of waiting area and assigns the waiting events to corresponding slots in the
+    This function evaluates the capacity of waiting area and assigns the waiting events to corresponding slots in the.
+
     waiting area.
 
     :param session: a :class:`sqlalchemy.orm.Session` object for database connection.

{eflips_depot-4.0.1 → eflips_depot-4.1.0}/eflips/depot/api/private/smart_charging.py

@@ -253,13 +253,16 @@ def optimize_charging_events_even(charging_events: List[Event]) -> None:
         socs[socs < event.soc_start] = event.soc_start
         socs[socs > event.soc_end] = event.soc_end
 
-        # Add a timeseries to the event
+        # Add a timeseries to the event, removing the first and last index, since they will be the same as the start and
+        # end SoC
         event.timeseries = {
             "time": [
                 datetime.fromtimestamp(t).astimezone().isoformat()
                 for t in total_time[start_index:end_index]
-            ],
-            "soc": socs.tolist(),
+            ][
+                1:-1
+            ],  # Remove the first and last index
+            "soc": socs.tolist()[1:-1],
         }
         if event.timeseries["time"][0] < event.time_start.isoformat():
             event.timeseries["time"][0] = event.time_start.isoformat()

{eflips_depot-4.0.1 → eflips_depot-4.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "eflips-depot"
-version = "4.0.1"
+version = "4.1.0"
 description = "Depot Simulation for eFLIPS"
 authors = ["Enrico Lauth <enrico.lauth@tu-berlin.de>",
     "Ludger Heide <ludger.heide@tu-berlin.de",
@@ -14,7 +14,7 @@ packages = [{ include = "eflips/depot" }]
 [tool.poetry.dependencies]
 python = "^3.10"
 simpy = "^4.0.1"
-eflips-model = "^4.0.0a2"
+eflips-model = "^4.0.0"
 # Legacy dependencies, which are still needed until we refactor the code
 eflips = "^0.1.3"
 xlsxwriter = "^3.1.9"