eflips-eval 1.2.0__tar.gz → 1.2.2__tar.gz

{eflips_eval-1.2.0 → eflips_eval-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eflips-eval
-Version: 1.2.0
+Version: 1.2.2
 Summary: 
 Author: Ludger Heide
 Author-email: ludger.heide@lhtechnologies.de

{eflips_eval-1.2.0 → eflips_eval-1.2.2}/eflips/eval/input/prepare.py

@@ -1,26 +1,10 @@
+from collections import Counter
 from datetime import datetime
 from typing import Dict, List
 
 import pandas as pd
 import sqlalchemy
-from eflips.model import Rotation, Trip
-
-
-def rotation_name_for_sorting(rotation_name: str) -> str:
-    """
-    Takes a rotation name, which in the BVG is a string of two numbers separated by a '/' character, and returns a string
-    that can be used for sorting. The first part of the string is returned for BVG rotations.
-
-    Other rotation names are not supported and will return the rotation name itself.
-
-    :param rotation_name: The rotation name
-    :return: a sortable string
-    """
-
-    if rotation_name is not None and "/" in rotation_name:
-        return rotation_name.split("/")[0]
-    else:
-        return rotation_name
+from eflips.model import Rotation, Trip, Route
 
 
 def rotation_info(
@@ -40,6 +24,9 @@ def rotation_info(
     - time_start: the departure of the first trip
     - time_end: the arrival of the last trip
     - line_name: the name of the line, which is the first part of the rotation name. Used for sorting
+    - line_is_unified: True if the rotation only contains one line
+    - start_station: the name of the departure station
+    - end_station: the name of the arrival station
 
     :param scenario_id: The scenario id for which to create the dataframe
     :param session: An sqlalchemy session to an eflips-model database
@@ -49,7 +36,22 @@ def rotation_info(
 
     result: List[Dict[str, int | float | str | datetime]] = []
 
-    rotations = session.query(Rotation).filter(Rotation.scenario_id == scenario_id)
+    rotations = (
+        session.query(Rotation)
+        .filter(Rotation.scenario_id == scenario_id)
+        .options(
+            sqlalchemy.orm.joinedload(Rotation.trips)
+            .joinedload(Trip.route)
+            .joinedload(Route.line),
+            sqlalchemy.orm.joinedload(Rotation.vehicle_type),
+            sqlalchemy.orm.joinedload(Rotation.trips)
+            .joinedload(Trip.route)
+            .joinedload(Route.departure_station),
+            sqlalchemy.orm.joinedload(Rotation.trips)
+            .joinedload(Trip.route)
+            .joinedload(Route.arrival_station),
+        )
+    )
 
     if rotation_ids is not None:
         if isinstance(rotation_ids, int):
@@ -62,6 +64,16 @@ def rotation_info(
         for trip in rotation.trips:
             distance += trip.route.distance / 1000
 
+        # We want to be able to sort and/or group by line. Therefore we need to identify the predominant line name for each
+        # rotation.
+        line_names: Dict[str, int] = {}
+        for trip in rotation.trips:
+            line_name = trip.route.line.name
+            if line_name not in line_names:
+                line_names[line_name] = 0
+            line_names[line_name] += 1
+        line_name = Counter(line_names).most_common(1)[0][0]
+
         result.append(
             {
                 "rotation_id": rotation.id,
@@ -69,16 +81,17 @@ def rotation_info(
                 "vehicle_type_id": rotation.vehicle_type_id,
                 "vehicle_type_name": rotation.vehicle_type.name,
                 "total_distance": distance,
+                "line_name": line_name,
+                "line_is_unified": len(line_names)
+                == 1,  # True if there is only one line in the rotation
                 "time_start": rotation.trips[0].departure_time,
                 "time_end": rotation.trips[-1].arrival_time,
+                "start_station": rotation.trips[0].route.departure_station.name,
+                "end_station": rotation.trips[-1].route.arrival_station.name,
             }
         )
 
-    # We want to properly sort by rotation name, which is a bit intricate, as it's a string of two numbers divided by a
-    # '/' character. We can't just sort by the string, as "10/11" would come after "10/1". We need to split the string
-    # into its components and sort by them.
     df = pd.DataFrame(result)
-    df["line_name"] = df["rotation_name"].apply(rotation_name_for_sorting)
 
     df.sort_values(by=["line_name", "time_start"], inplace=True)
 

{eflips_eval-1.2.0 → eflips_eval-1.2.2}/eflips/eval/input/visualize.py

@@ -19,6 +19,9 @@ def rotation_info(prepared_data: pd.DataFrame) -> go.Figure:
     - time_start: the departure of the first trip
     - time_end: the arrival of the last trip
     - line_name: the name of the line, which is the first part of the rotation name. Used for sorting
+    - line_is_unified: True if the rotation only contains one line
+    - start_station: the name of the departure station
+    - end_station: the name of the arrival station
 
     :return: A plotly figure object
     """
@@ -30,11 +33,22 @@ def rotation_info(prepared_data: pd.DataFrame) -> go.Figure:
         y="rotation_name",
         color="total_distance",
         labels={
+            "time_start": "Departure Time",
+            "time_end": "Arrival Time",
             "rotation_name": "Rotation Name",
             "total_distance": "Total Distance (km)",
             "line_name": "Line Name",
+            "vehicle_type_name": "Vehicle Type Name",
+            "start_station": "Start Station",
+            "end_station": "End Station",
         },
-        hover_data=["vehicle_type_name"],
+        hover_name="rotation_name",
+        hover_data=[
+            "vehicle_type_name",
+            "total_distance",
+            "start_station",
+            "end_station",
+        ],
         pattern_shape="line_name",
     )
     fig.update_layout(legend_orientation="h")

{eflips_eval-1.2.0 → eflips_eval-1.2.2}/eflips/eval/output/prepare.py

@@ -1,6 +1,6 @@
 import zoneinfo
 from datetime import datetime, timedelta
-from typing import Dict, List, Iterable, Tuple
+from typing import Dict, List, Iterable, Tuple, Optional
 
 import numpy as np
 import numpy.typing as npt
@@ -247,8 +247,8 @@ def power_and_occupancy(
         )
         energy += this_event_energy
 
-        # For occupancy, we we create an entry at the beginning and end of the event, then resample to 1-second intervals
-        # with left=0 and right=0
+        # For occupancy, we create an entry at the beginning and end of the event, then resample to 1-second
+        # intervals with left=0 and right=0
         this_event_occupancy = np.interp(
             time_as_unix,
             [event.time_start.timestamp(), event.time_end.timestamp() - 1],
@@ -262,11 +262,16 @@ def power_and_occupancy(
     power = (np.diff(energy) / np.diff(time_as_unix).astype(float)) * 3600  # kW
 
     # Create the dataframe
+    # First, change the time to the local timezone
+
+    tz = datetime.now().astimezone().tzinfo
+    time_as_local_tz = pd.to_datetime(time).tz_localize("UTC").tz_convert(tz)
+
     result = pd.DataFrame(
         {
-            "time": time[1:],
+            "time": time_as_local_tz[:-1],
             "power": power,
-            "occupancy": occupancy[1:],
+            "occupancy": occupancy[:-1],
         }
     )
     return result
@@ -316,7 +321,7 @@ def specific_energy_consumption(scenario_id: int, session: Session) -> pd.DataFr
 def vehicle_soc(
     vehicle_id: int,
     session: Session,
-    timezone: zoneinfo.ZoneInfo = zoneinfo.ZoneInfo("UTC"),
+    timezone: Optional[zoneinfo.ZoneInfo] = zoneinfo.ZoneInfo("Europe/Berlin"),
 ) -> Tuple[pd.DataFrame, Dict[str, List[Tuple[str, datetime, datetime]]]]:
     """
     This function takes in a vehicle id and returns a description what happened to the vehicle over time.
@@ -331,7 +336,7 @@ def vehicle_soc(
     - "rotation": A list of rotation names and the time the rotation started and ended
     - "charging": A list of the location of the charging and the time the charging started and ended
 
-    :param timezone: Explicit timezone information to use for the visualization. Default is UTC
+    :param timezone: Explicit timezone information to use for the visualization. Default is Europe/Berlin
     :param vehicle_id: the unique identifier of the vehicle
     :param session: A :class:`sqlalchemy.orm.session.Session` object to an eflips-model database
     :return: A pandas DataFrame
@@ -395,4 +400,4 @@ def vehicle_soc(
             )
         )
 
-    return (pd.DataFrame({"time": all_times, "soc": all_soc}), descriptions)
+    return pd.DataFrame({"time": all_times, "soc": all_soc}), descriptions

{eflips_eval-1.2.0 → eflips_eval-1.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "eflips-eval"
-version = "1.2.0"
+version = "1.2.2"
 description = ""
 authors = [
     "Ludger Heide <ludger.heide@lhtechnologies.de>",