openenergyid 0.1.16__py2.py3-none-any.whl → 0.1.18__py2.py3-none-any.whl

openenergyid/__init__.py

@@ -1,6 +1,6 @@
 """Open Energy ID Python SDK."""
 
-__version__ = "0.1.16"
+__version__ = "0.1.18"
 
 from .enums import Granularity
 from .models import TimeDataFrame, TimeSeries

openenergyid/dyntar/const.py

@@ -16,3 +16,7 @@ SPP_WEIGHTED_PRICE_EXPORTED = "spp_weighted_price_exported"
 HEATMAP_DELIVERED = "heatmap_delivered"
 HEATMAP_EXPORTED = "heatmap_exported"
 HEATMAP_TOTAL = "heatmap_total"
+
+HEATMAP_DELIVERED_DESCRIPTION = "heatmap_delivered_description"
+HEATMAP_EXPORTED_DESCRIPTION = "heatmap_exported_description"
+HEATMAP_TOTAL_DESCRIPTION = "heatmap_total_description"

openenergyid/dyntar/main.py

@@ -1,5 +1,6 @@
 """Main module of the DynTar package."""
 
+import numpy as np
 import pandas as pd
 
 from openenergyid.const import (
@@ -25,6 +26,9 @@ from .const import (
     HEATMAP_DELIVERED,
     HEATMAP_EXPORTED,
     HEATMAP_TOTAL,
+    HEATMAP_DELIVERED_DESCRIPTION,
+    HEATMAP_EXPORTED_DESCRIPTION,
+    HEATMAP_TOTAL_DESCRIPTION,
 )
 
 
@@ -122,25 +126,31 @@ def extend_dataframe_with_heatmap(df: pd.DataFrame, inplace: bool = False) -> pd
     if not inplace:
         df = df.copy()
 
-    heatmap_score_delivered = (
-        (df[ELECTRICITY_DELIVERED_SMR2] - df[ELECTRICITY_DELIVERED_SMR3])
-        / df[ELECTRICITY_DELIVERED_SMR2]
-        * (df[RLP_WEIGHTED_PRICE_DELIVERED] - df[PRICE_ELECTRICITY_DELIVERED])
-        / df[RLP_WEIGHTED_PRICE_DELIVERED]
-    )
-    heatmap_score_exported = (
-        (df[ELECTRICITY_EXPORTED_SMR2] - df[ELECTRICITY_EXPORTED_SMR3])
-        / df[ELECTRICITY_EXPORTED_SMR2]
-        * (df[SPP_WEIGHTED_PRICE_EXPORTED] - df[PRICE_ELECTRICITY_EXPORTED])
-        / df[SPP_WEIGHTED_PRICE_EXPORTED]
+    normalized_energy_delta_delivered = (
+        df[ELECTRICITY_DELIVERED_SMR2] - df[ELECTRICITY_DELIVERED_SMR3]
+    ) / df[ELECTRICITY_DELIVERED_SMR2]
+    normalized_price_delta_delivered = (
+        df[RLP_WEIGHTED_PRICE_DELIVERED] - df[PRICE_ELECTRICITY_DELIVERED]
+    ) / df[RLP_WEIGHTED_PRICE_DELIVERED]
+    heatmap_score_delivered = normalized_energy_delta_delivered * normalized_price_delta_delivered
+
+    normalized_energy_delta_exported = (
+        df[ELECTRICITY_EXPORTED_SMR2] - df[ELECTRICITY_EXPORTED_SMR3]
+    ) / df[ELECTRICITY_EXPORTED_SMR2]
+    normalized_energy_delta_exported = normalized_energy_delta_exported.replace(
+        [np.inf, -np.inf], np.nan
     )
+    normalized_price_delta_exported = (
+        df[SPP_WEIGHTED_PRICE_EXPORTED] - df[PRICE_ELECTRICITY_EXPORTED]
+    ) / df[SPP_WEIGHTED_PRICE_EXPORTED]
+    heatmap_score_exported = normalized_energy_delta_exported * normalized_price_delta_exported
+
     heatmap_score_delivered.fillna(0, inplace=True)
     heatmap_score_exported.fillna(0, inplace=True)
 
     # Invert scores so that positive values indicate a positive impact
     heatmap_score_delivered = -heatmap_score_delivered
-    heatmap_score_exported = -heatmap_score_exported
-    heatmap_score_combined = heatmap_score_delivered - heatmap_score_exported
+    heatmap_score_combined = heatmap_score_delivered + heatmap_score_exported
 
     df[HEATMAP_DELIVERED] = heatmap_score_delivered
     df[HEATMAP_EXPORTED] = heatmap_score_exported
@@ -151,6 +161,116 @@ def extend_dataframe_with_heatmap(df: pd.DataFrame, inplace: bool = False) -> pd
     return None
 
 
+def extend_dataframe_with_heatmap_description(
+    df: pd.DataFrame, inplace: bool = False
+) -> pd.DataFrame | None:
+    """Extend a DataFrame with the heatmap description columns."""
+    if not inplace:
+        df = df.copy()
+
+    # Delivered
+
+    # Where Heatmap is 0, we put a desription of 0 (No impact)
+    df[HEATMAP_DELIVERED_DESCRIPTION] = df[HEATMAP_DELIVERED].apply(
+        lambda x: 0 if x == 0 else float("NaN")
+    )
+    # When the energy delta is positive, and the price delta is positive, we put a description of 1 (high consumption, high price)
+    df[HEATMAP_DELIVERED_DESCRIPTION] = df.apply(
+        lambda x: 1
+        if x[PRICE_ELECTRICITY_DELIVERED] > x[RLP_WEIGHTED_PRICE_DELIVERED]
+        and x[ELECTRICITY_DELIVERED_SMR3] > x[ELECTRICITY_DELIVERED_SMR2]
+        else x[HEATMAP_DELIVERED_DESCRIPTION],
+        axis=1,
+    )
+    # When the energy delta is negative, and the price delta is positive, we put a description of 2 (low consumption, high price)
+    df[HEATMAP_DELIVERED_DESCRIPTION] = df.apply(
+        lambda x: 2
+        if x[PRICE_ELECTRICITY_DELIVERED] > x[RLP_WEIGHTED_PRICE_DELIVERED]
+        and x[ELECTRICITY_DELIVERED_SMR3] < x[ELECTRICITY_DELIVERED_SMR2]
+        else x[HEATMAP_DELIVERED_DESCRIPTION],
+        axis=1,
+    )
+    # When the energy delta is positive, and the price delta is negative, we put a description of 3 (high consumption, low price)
+    df[HEATMAP_DELIVERED_DESCRIPTION] = df.apply(
+        lambda x: 3
+        if x[PRICE_ELECTRICITY_DELIVERED] < x[RLP_WEIGHTED_PRICE_DELIVERED]
+        and x[ELECTRICITY_DELIVERED_SMR3] > x[ELECTRICITY_DELIVERED_SMR2]
+        else x[HEATMAP_DELIVERED_DESCRIPTION],
+        axis=1,
+    )
+    # When the energy delta is negative, and the price delta is negative, we put a description of 4 (low consumption, low price)
+    df[HEATMAP_DELIVERED_DESCRIPTION] = df.apply(
+        lambda x: 4
+        if x[PRICE_ELECTRICITY_DELIVERED] < x[RLP_WEIGHTED_PRICE_DELIVERED]
+        and x[ELECTRICITY_DELIVERED_SMR3] < x[ELECTRICITY_DELIVERED_SMR2]
+        else x[HEATMAP_DELIVERED_DESCRIPTION],
+        axis=1,
+    )
+    # All other cases are put as 0
+    df[HEATMAP_DELIVERED_DESCRIPTION] = df[HEATMAP_DELIVERED_DESCRIPTION].replace(np.nan, 0)
+
+    # Exported
+
+    # Where Heatmap is 0, we put a desription of 0 (No impact)
+    df[HEATMAP_EXPORTED_DESCRIPTION] = df[HEATMAP_EXPORTED].apply(
+        lambda x: 0 if x == 0 else float("NaN")
+    )
+    # When the energy delta is positive, and the price delta is positive, we put a description of 5 (high injection, high price)
+    df[HEATMAP_EXPORTED_DESCRIPTION] = df.apply(
+        lambda x: 5
+        if x[PRICE_ELECTRICITY_EXPORTED] > x[SPP_WEIGHTED_PRICE_EXPORTED]
+        and x[ELECTRICITY_EXPORTED_SMR3] > x[ELECTRICITY_EXPORTED_SMR2]
+        else x[HEATMAP_EXPORTED_DESCRIPTION],
+        axis=1,
+    )
+    # When the energy delta is negative, and the price delta is positive, we put a description of 6 (low injection, high price)
+    df[HEATMAP_EXPORTED_DESCRIPTION] = df.apply(
+        lambda x: 6
+        if x[PRICE_ELECTRICITY_EXPORTED] > x[SPP_WEIGHTED_PRICE_EXPORTED]
+        and x[ELECTRICITY_EXPORTED_SMR3] < x[ELECTRICITY_EXPORTED_SMR2]
+        else x[HEATMAP_EXPORTED_DESCRIPTION],
+        axis=1,
+    )
+    # When the energy delta is positive, and the price delta is negative, we put a description of 7 (high injection, low price)
+    df[HEATMAP_EXPORTED_DESCRIPTION] = df.apply(
+        lambda x: 7
+        if x[PRICE_ELECTRICITY_EXPORTED] < x[SPP_WEIGHTED_PRICE_EXPORTED]
+        and x[ELECTRICITY_EXPORTED_SMR3] > x[ELECTRICITY_EXPORTED_SMR2]
+        else x[HEATMAP_EXPORTED_DESCRIPTION],
+        axis=1,
+    )
+    # When the energy delta is negative, and the price delta is negative, we put a description of 8 (low injection, low price)
+    df[HEATMAP_EXPORTED_DESCRIPTION] = df.apply(
+        lambda x: 8
+        if x[PRICE_ELECTRICITY_EXPORTED] < x[SPP_WEIGHTED_PRICE_EXPORTED]
+        and x[ELECTRICITY_EXPORTED_SMR3] < x[ELECTRICITY_EXPORTED_SMR2]
+        else x[HEATMAP_EXPORTED_DESCRIPTION],
+        axis=1,
+    )
+    # All other cases are put as 0
+    df[HEATMAP_EXPORTED_DESCRIPTION] = df[HEATMAP_EXPORTED_DESCRIPTION].replace(np.nan, 0)
+
+    # Total
+
+    # We see which of the individual heatmaps has the highest absolute value
+    # We put the description of the highest absolute value
+    df[HEATMAP_TOTAL_DESCRIPTION] = df.apply(
+        lambda x: x[HEATMAP_DELIVERED_DESCRIPTION]
+        if abs(x[HEATMAP_DELIVERED]) > abs(x[HEATMAP_EXPORTED])
+        else x[HEATMAP_EXPORTED_DESCRIPTION],
+        axis=1,
+    )
+    # Where Heatmap is 0, we put a desription of 0 (No impact)
+    df[HEATMAP_TOTAL_DESCRIPTION] = df.apply(
+        lambda x: 0 if x[HEATMAP_TOTAL] == 0 else x[HEATMAP_TOTAL_DESCRIPTION], axis=1
+    )
+    # All other cases are put as 0
+    df[HEATMAP_TOTAL_DESCRIPTION] = df[HEATMAP_TOTAL_DESCRIPTION].replace(np.nan, 0)
+
+    if not inplace:
+        return df
+
+
 def calculate_dyntar_columns(df: pd.DataFrame, inplace: bool = False) -> pd.DataFrame | None:
     """Calculate all columns required for the dynamic tariff analysis."""
     if not inplace:
@@ -160,6 +280,7 @@ def calculate_dyntar_columns(df: pd.DataFrame, inplace: bool = False) -> pd.Data
     extend_dataframe_with_costs(df, inplace=True)
     extend_dataframe_with_weighted_prices(df, inplace=True)
     extend_dataframe_with_heatmap(df, inplace=True)
+    extend_dataframe_with_heatmap_description(df, inplace=True)
 
     if not inplace:
         return df

openenergyid/dyntar/models.py

@@ -1,7 +1,7 @@
 """Models for dynamic tariff analysis."""
 
 from typing import Literal
-from pydantic import Field, conlist
+from pydantic import Field, conlist, confloat
 
 from openenergyid.models import TimeDataFrame
 
@@ -33,6 +33,9 @@ OutputColumns = Literal[
     "heatmap_delivered",
     "heatmap_exported",
     "heatmap_total",
+    "heatmap_delivered_description",
+    "heatmap_exported_description",
+    "heatmap_total_description",
 ]
 
 
@@ -46,11 +49,11 @@ class DynamicTariffAnalysisInput(TimeDataFrame):
     )
     data: list[
         conlist(
-            item_type=float,
+            item_type=confloat(allow_inf_nan=True),
             min_length=len(RequiredColumns.__args__),
             max_length=len(RequiredColumns.__args__),
         )  # type: ignore
-    ] = Field(examples=[[0.0, 0.0, 0.0, 0.0, 0.0, 0.0]])
+    ] = Field(examples=[[0.0] * len(RequiredColumns.__args__)])
 
 
 class DynamicTariffAnalysisOutput(TimeDataFrame):
@@ -62,5 +65,9 @@ class DynamicTariffAnalysisOutput(TimeDataFrame):
         examples=[OutputColumns.__args__],
     )
     data: list[
-        conlist(item_type=float, min_length=1, max_length=len(OutputColumns.__args__))  # type: ignore
-    ] = Field(examples=[[0.0, 0.0, 0.0, 0.0, 0.0, 0.0]])
+        conlist(
+            item_type=confloat(allow_inf_nan=True),
+            min_length=1,
+            max_length=len(OutputColumns.__args__),
+        )  # type: ignore
+    ] = Field(examples=[[0.0] * len(OutputColumns.__args__)])

openenergyid/models.py

@@ -6,7 +6,7 @@ from typing import overload
 from typing import Self
 
 import pandas as pd
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel
 
 
 class TimeSeriesBase(BaseModel):
@@ -78,13 +78,7 @@ class TimeSeries(TimeSeriesBase):
     """
 
     name: str | None = None
-    data: list[float | None]
-
-    @field_validator("data")
-    @classmethod
-    def replace_nan_with_none(cls, data: list[float]) -> list[float | None]:
-        """Replace NaN values with None."""
-        return [None if pd.isna(value) else value for value in data]
+    data: list[float]
 
     @classmethod
     def from_pandas(cls, data: pd.Series) -> Self:
@@ -102,13 +96,7 @@ class TimeDataFrame(TimeSeriesBase):
     """Time series data with multiple columns."""
 
     columns: list[str]
-    data: list[list[float | None]]
-
-    @field_validator("data")
-    @classmethod
-    def replace_nan_with_none(cls, data: list[list[float]]) -> list[list[float | None]]:
-        """Replace NaN values with None."""
-        return [[None if pd.isna(value) else value for value in row] for row in data]
+    data: list[list[float]]
 
     @classmethod
     def from_pandas(cls, data: pd.DataFrame) -> Self:

{openenergyid-0.1.16.dist-info → openenergyid-0.1.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openenergyid
-Version: 0.1.16
+Version: 0.1.18
 Summary: Open Source Python library for energy analytics and simulations
 Project-URL: Homepage, https://energyid.eu
 Project-URL: Repository, https://github.com/EnergieID/OpenEnergyID

{openenergyid-0.1.16.dist-info → openenergyid-0.1.18.dist-info}/RECORD

@@ -1,14 +1,14 @@
-openenergyid/__init__.py,sha256=FfypAMLDwdX1imytBRjsN21Oifo8HrmhShNxSLKjFXo,193
+openenergyid/__init__.py,sha256=ntL_zbXBUmsAcqrx7QRz8_g3CNWyjWhlg9osouG9a-k,193
 openenergyid/const.py,sha256=D-xUnUyVuLmphClkePgxpFP6z0RDhw_6m7rX0BHBgrw,823
 openenergyid/enums.py,sha256=jdw4CB1gkisx0re_SesrTEyh_T-UxYp6uieE7iYlHdA,357
-openenergyid/models.py,sha256=F-7BOB-UxIcmR0Y02NHWWjoM_yWwkVOeRtIwZl72KgI,4877
+openenergyid/models.py,sha256=CO6VdthCOQ9hNXqVSan_4IOBpiQvOix-ea3U6TR7Vgc,4343
 openenergyid/capacity/__init__.py,sha256=1En96HlPV8kd1hOJO9RjRbXNInp5ZSkmjsjp0jfZlcQ,221
 openenergyid/capacity/main.py,sha256=G6_EtXs1k_W-fxS33pFrCNKajuH81skdI32zp5RX9bI,3674
 openenergyid/capacity/models.py,sha256=qi0IFyF_QOVleSzN8g0U2Fzqcc9ZDfNKt8oteFLY6Q0,832
 openenergyid/dyntar/__init__.py,sha256=iQXQXrEQOiVNeeF6LRmUf3oOhKlGjMNF7o4T04IWTGA,371
-openenergyid/dyntar/const.py,sha256=K7X6nHIl9DNyC6hU8jLtvOy3-IBGuYC449evOpImuJE,773
-openenergyid/dyntar/main.py,sha256=cFfRZuwTVwHhXzR1pjKgQ4uhx4mMTAhjgFHJRMggKF8,5267
-openenergyid/dyntar/models.py,sha256=BbGdHj7eUOMepblWJNsNd21xULluv6m7TtdhSggvVbY,1873
+openenergyid/dyntar/const.py,sha256=17qL0-S0SImsqrDEDrGS2GLyJYcJRw6GmmcTiML7tR0,956
+openenergyid/dyntar/main.py,sha256=z_F520eCsLcSYTo9e0iJBGpzoMo1G_TEECVCNi5rA_M,10732
+openenergyid/dyntar/models.py,sha256=FZq7HI1F-3nVeHwPkuB38-8u32JzdvsZaCzrhirFD2g,2094
 openenergyid/energysharing/__init__.py,sha256=A4JfrUYf-hBCzhUm0qL1GGlNMvpO8OwXJo80dJxFIvw,274
 openenergyid/energysharing/const.py,sha256=X2zEPtTlsmZ66w6RmLS_h8NmdzObAEi5N6-0yrLN5V4,219
 openenergyid/energysharing/data_formatting.py,sha256=Kwuhyn6ao_8Brdm9frlA6VzYOqimNYZsRbYwNXnE7yc,2583
@@ -19,7 +19,7 @@ openenergyid/mvlr/helpers.py,sha256=Uzbfrj3IpH26wA206KOl0hNucKE-n9guJNC_EROBVKA,
 openenergyid/mvlr/main.py,sha256=cn7jZ98cHn2eh-0zG9q8Pad0Ft_FuI-u3a-eeHeF8jA,1304
 openenergyid/mvlr/models.py,sha256=XvkViOLlYqi0ffgF3AD4Jvk3yL05gsoKdKgBAsGJ7L4,8581
 openenergyid/mvlr/mvlr.py,sha256=F7WvWnZQtqUmK1vsguemsn9n8pDDk3tQ1weOlv-bo0c,18626
-openenergyid-0.1.16.dist-info/METADATA,sha256=Mt5G-168EyZ95DV5UCsCE_E3Ns1DOb6TmqA-a4apOmg,2477
-openenergyid-0.1.16.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-openenergyid-0.1.16.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
-openenergyid-0.1.16.dist-info/RECORD,,
+openenergyid-0.1.18.dist-info/METADATA,sha256=d5UuJ8gqzwzSFx7aokbArsVr7RqetZoL8fJ3TwRuGlc,2477
+openenergyid-0.1.18.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
+openenergyid-0.1.18.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
+openenergyid-0.1.18.dist-info/RECORD,,