domainiac 0.1.0__py3-none-any.whl

domainiac/__init__.py

@@ -0,0 +1 @@
+from .managers import MeteringManager, PlantManager, UnitManager

domainiac/managers/__init__.py

@@ -0,0 +1,4 @@
+from .masterdata_manager import MasterdataManager
+from .metering_manager import MeteringManager
+from .plant_manager import PlantManager
+from .unit_manager import UnitManager

domainiac/managers/masterdata_manager.py

@@ -0,0 +1,50 @@
+import datamazing.pandas as pdz
+import pandas as pd
+from typeguard import typechecked
+
+
+class MasterdataManager:
+    """
+    Manager which simplifies the process of getting units from masterdata.
+    """
+
+    def __init__(
+        self,
+        db: pdz.Database,
+        time_interval: pdz.TimeInterval,
+        resolution: pd.Timedelta,
+    ) -> None:
+        self.db = db
+        self.time_interval = time_interval
+        self.resolution = resolution
+
+    @typechecked
+    def get_data(
+        self,
+        table: str,
+        filters: dict = {},
+        columns: list = [],
+    ) -> pd.DataFrame:
+        """Gets the units for a given unit type.
+        Filters for units valid at the end of time interval.
+        Filters by default for units in operation.
+        """
+
+        filters["standing_entity_state"] = "InOperation"
+        df = self.db.query(table, filters=filters)
+
+        for key in filters.keys():
+            if key not in df.columns:
+                raise KeyError(f"Column {key} not found in {table}")
+        for column in columns:
+            if column not in df.columns:
+                raise KeyError(f"Column {column} not found in {table}")
+
+        df = pdz.as_of_time(
+            df=df,
+            period=("valid_from_date_utc", "valid_to_date_utc"),
+            at=self.time_interval.right,
+        )
+        df = df.filter(columns)
+
+        return df

domainiac/managers/metering_manager.py

@@ -0,0 +1,40 @@
+import datamazing.pandas as pdz
+import pandas as pd
+from typeguard import typechecked
+
+
+class MeteringManager:
+    """
+    Manager which simplifies the process of getting metering data from datahub.
+    """
+
+    def __init__(
+        self,
+        db: pdz.Database,
+        time_interval: pdz.TimeInterval,
+        resolution: pd.Timedelta,
+    ) -> None:
+        self.db = db
+        self.time_interval = time_interval
+        self.resolution = resolution
+
+    @typechecked
+    def get_plant_settlement(self, datahub_gsrn: str) -> pd.DataFrame:
+        """
+        Retrieves the settlement data for a given datahub gsrn.
+        """
+        df = self.db.query(
+            "readingSettlement",
+            self.time_interval,
+            filters={"datahub_gsrn_e18": datahub_gsrn},
+        )
+
+        df = df.filter(
+            [
+                "time_utc",
+                "datahub_gsrn_e18",
+                "reading_settlement_production_e18_MW",
+            ]
+        )
+
+        return df

domainiac/managers/plant_manager.py

@@ -0,0 +1,39 @@
+import datamazing.pandas as pdz
+import pandas as pd
+
+from .masterdata_manager import MasterdataManager
+
+
+class PlantManager(MasterdataManager):
+    """
+    Manager which simplifies the process of getting plants from masterdata.
+    """
+
+    def __init__(
+        self,
+        db: pdz.Database,
+        time_interval: pdz.TimeInterval,
+        resolution: pd.Timedelta,
+    ) -> None:
+        self.db = db
+        self.time_interval = time_interval
+        self.resolution = resolution
+
+    def get_plants(
+        self,
+        filters: dict = {},
+        columns: list = [
+            "plant_id",
+            "masterdata_gsrn",
+            "datahub_gsrn_e18",
+            "installed_power_MW",
+            "price_area",
+            "valid_from_date_utc",
+            "valid_to_date_utc",
+        ],
+    ) -> pd.DataFrame:
+        """Gets the plants for a given plant type.
+        Filters for plants valid at the end of time interval.
+        Filters by default for plants in operation.
+        """
+        return self.get_data("masterdataPlant", filters=filters, columns=columns)

domainiac/managers/unit_manager.py

@@ -0,0 +1,39 @@
+import datamazing.pandas as pdz
+import pandas as pd
+
+from .masterdata_manager import MasterdataManager
+
+
+class UnitManager(MasterdataManager):
+    """
+    Manager which simplifies the process of getting units from masterdata.
+    """
+
+    def __init__(
+        self,
+        db: pdz.Database,
+        time_interval: pdz.TimeInterval,
+        resolution: pd.Timedelta,
+    ) -> None:
+        self.db = db
+        self.time_interval = time_interval
+        self.resolution = resolution
+
+    def get_units(
+        self,
+        filters: dict = {},
+        columns: list = [
+            "masterdata_gsrn",
+            "installed_power_MW",
+            "plant_id",
+            "price_area",
+            "valid_from_date_utc",
+            "valid_to_date_utc",
+            "power_system_resource_type",
+        ],
+    ) -> pd.DataFrame:
+        """Gets the units for a given unit type.
+        Filters for units valid at the end of time interval.
+        Filters by default for units in operation.
+        """
+        return self.get_data("masterdataUnit", filters=filters, columns=columns)

domainiac-0.1.0.dist-info/METADATA

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: domainiac
+Version: 0.1.0
+Summary: Package for working with Energinet data, but with specialized functions used for Enigma.
+Author: Team Enigma
+Author-email: gridop-enigma@energinet.dk
+Requires-Python: >=3.10,<3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Dist: datamazing (>=4.3.3,<5.0.0)
+Requires-Dist: pandas (>=2.2.0,<3.0.0)
+Requires-Dist: typeguard (>=4.2.1,<5.0.0)

domainiac-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+domainiac/__init__.py,sha256=ezC_vpooWhMA-M0M2GxZiF0DFc-KoCeVaNhlR4Ysnfg,65
+domainiac/managers/__init__.py,sha256=ZwpdZMaQ7JxVWOlH2wKAxezy_JNni8qaGzfVFtMkIVo,174
+domainiac/managers/masterdata_manager.py,sha256=h_KRtXLRAniPDy94EkWGC5cB93RYXQe3Zt_r_p4mWe0,1388
+domainiac/managers/metering_manager.py,sha256=NXGHuNjWiAUE08fGIPAfvwbzlKESbKaO5uyxLNyZKC0,995
+domainiac/managers/plant_manager.py,sha256=LW9S_HECpR-lljkopY1IcYpU9XgPDqhQxFH-wPAvQIU,1083
+domainiac/managers/unit_manager.py,sha256=PjtLag75PRDlX57lxbYo6hundkQy37jC170R4YKJw7U,1085
+domainiac-0.1.0.dist-info/METADATA,sha256=qmiB4NB9x1CY9zJMnYiNTPbdPXUVa0HWpX2NvJPpMXM,465
+domainiac-0.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+domainiac-0.1.0.dist-info/RECORD,,

domainiac-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any