domainiac 0.1.3__tar.gz → 0.1.5__tar.gz

{domainiac-0.1.3 → domainiac-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: domainiac
-Version: 0.1.3
+Version: 0.1.5
 Summary: Package for working with Energinet data, but with specialized functions used for Enigma.
 Author: Team Enigma
 Author-email: gridop-enigma@energinet.dk

domainiac-0.1.5/domainiac/managers/resource_manager.py

@@ -0,0 +1,79 @@
+import datamazing.pandas as pdz
+import pandas as pd
+from typeguard import typechecked
+
+
+class ResourceManager:
+    """
+    Manager which simplifies the process of handling resource schedules.
+    Scheduled resources are delivered in a 5 min resolution. If a higher
+    resolution is chosen,
+    the result will be the most conservative value in the time interval,
+    e.i. max of minimum capacity and min of maximum capacity.
+    If no resolution is given, the default is 5 min.
+    If resolution is less than 5 min, the resulting time series will
+    default to 5 min resolution.
+    """
+
+    def __init__(
+        self,
+        db: pdz.Database,
+        time_interval: pdz.TimeInterval,
+        resolution: pd.Timedelta = pd.Timedelta("PT5M"),
+    ) -> None:
+        self.db = db
+        self.time_interval = time_interval
+        self.resolution = resolution
+
+    @typechecked
+    def get_resource_schedules(self, resource_gsrn: str | list[str]) -> pd.DataFrame:
+        """Gets resource schedules for a given list of resource gsrns."""
+        df_resource_schedules = self.db.query(
+            table_name="scheduleResourcePowerPlan",
+            time_interval=self.time_interval,
+            filters={"resource_gsrn": resource_gsrn},
+        )
+
+        if df_resource_schedules.empty:
+            raise ValueError(f"No resource schedules found for gsrn {resource_gsrn}.")
+
+        df_resource_resampled = (
+            pdz.group(
+                df_resource_schedules,
+                by=[
+                    "market_participant",
+                    "created_time_utc",
+                    "price_area",
+                    "resource_gsrn",
+                ],
+            )
+            .resample(on="time_utc", resolution=self.resolution)
+            .agg(
+                {
+                    "schedule_power_MW": "mean",
+                    "schedule_capacity_min_MW": "max",
+                    "schedule_capacity_max_MW": "min",
+                }
+            )
+            .dropna()
+        )
+        return df_resource_resampled
+
+    @typechecked
+    def get_latest_resource_schedules(
+        self,
+        resource_gsrn: str | list[str],
+    ) -> pd.DataFrame:
+        """Gets the lastest resource schedules for a given list of resource gsrns."""
+
+        df_resource_schedules = self.get_resource_schedules(resource_gsrn=resource_gsrn)
+
+        df_latest_created_time = pdz.group(
+            df=df_resource_schedules, by=["resource_gsrn", "time_utc"]
+        ).agg({"created_time_utc": "max"})
+
+        df_resource_latest = df_latest_created_time.merge(
+            df_resource_schedules, on=list(df_latest_created_time.columns)
+        )
+
+        return df_resource_latest

{domainiac-0.1.3 → domainiac-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "domainiac"
-version = "0.1.3"
+version = "0.1.5"
 description = "Package for working with Energinet data, but with specialized functions used for Enigma."
 authors = ["Team Enigma <gridop-enigma@energinet.dk>"]
 packages = [

domainiac-0.1.3/domainiac/managers/resource_manager.py

@@ -1,65 +0,0 @@
-import datamazing.pandas as pdz
-import pandas as pd
-from typeguard import typechecked
-
-
-class ResourceManager:
-    """
-    Manager which simplifies the process of handling resource schedules.
-    """
-
-    def __init__(
-        self,
-        db: pdz.Database,
-        time_interval: pdz.TimeInterval,
-    ) -> None:
-        self.db = db
-        self.time_interval = time_interval
-
-    @typechecked
-    def get_resource_schedules(
-        self,
-        resource_gsrns: list,
-    ) -> pd.DataFrame:
-        """Gets resource schedules for a given list of resource gsrns."""
-        df_resource_schedules = self.db.query(
-            table_name="resourceSchedule",
-            time_interval=self.time_interval,
-            filters={"resource_gsrn": resource_gsrns},
-        )
-        df_resource_schedules = df_resource_schedules.filter(
-            [
-                "market_participant",
-                "created_time_utc",
-                "price_area",
-                "resource_gsrn",
-                "main_fuel_type",
-                "is_sum_plan",
-                "time_utc",
-                "schedule_power_MW",
-                "schedule_capacity_min_MW",
-                "schedule_capacity_max_MW",
-            ]
-        )
-        return df_resource_schedules
-
-    @typechecked
-    def get_latest_resource_plan(
-        self,
-        resource_gsrns: list,
-    ) -> pd.DataFrame:
-        """Gets the lastest resource schedules for a given list of resource gsrns."""
-
-        df_resource_schedules = self.get_resource_schedules(
-            resource_gsrns=resource_gsrns
-        )
-
-        df_latest_created_time = pdz.group(
-            df=df_resource_schedules, by=["resource_gsrn", "time_utc"]
-        ).agg({"created_time_utc": max})
-
-        df_resource_latest = df_latest_created_time.merge(
-            df_resource_schedules, on=list(df_latest_created_time.columns)
-        )
-
-        return df_resource_latest