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

openenergyid/__init__.py

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

openenergyid/capacity/main.py

@@ -1,7 +1,9 @@
 """Main module for capacity analysis."""
 
 import datetime as dt
+import typing
 import pandas as pd
+import pandera.typing as pdt
 
 
 class CapacityAnalysis:
@@ -21,7 +23,7 @@ class CapacityAnalysis:
 
     def __init__(
         self,
-        data: pd.Series,
+        data: pdt.Series,
         threshold: float = 2.5,
         window: str = "MS",  # Default to month start
         x_padding: int = 4,
@@ -50,11 +52,12 @@ class CapacityAnalysis:
         """
         # Group by the specified window (default is month start)
         grouped = self.data.groupby(pd.Grouper(freq=self.window))
+
         # Find the index (timestamp) of the maximum value in each group
         peak_indices = grouped.idxmax()
+
         # Get the corresponding peak values
         peaks = self.data.loc[peak_indices][self.data > self.threshold]
-
         return peaks
 
     def find_peaks_with_surroundings(
@@ -69,12 +72,20 @@ class CapacityAnalysis:
         Returns:
             List[tuple[dt.datetime,float,pd.Series]]: A list of tuples containing peak time, peak value, and surrounding data.
         """
-        peaks = self.data.sort_values(ascending=False).head(num_peaks)
+        peaks = self.data.nlargest(num_peaks * 2)
         peaks = peaks[peaks > self.threshold]
         if peaks.empty:
             return []
+
         result = []
+        window_size = dt.timedelta(minutes=15 * (2 * self.x_padding + 1))
+
         for peak_time, peak_value in peaks.items():
+            peak_time = typing.cast(pd.Timestamp, peak_time)
+
+            if any(abs(peak_time - prev_peak[0]) < window_size for prev_peak in result):
+                continue
+
             start_time = peak_time - dt.timedelta(minutes=15 * self.x_padding)
             end_time = peak_time + dt.timedelta(minutes=15 * (self.x_padding + 1))
             surrounding_data = self.data[start_time:end_time]
@@ -86,5 +97,6 @@ class CapacityAnalysis:
                     surrounding_data,
                 ]
             )
-
+            if len(result) == num_peaks:
+                break
         return result

openenergyid/capacity/models.py

@@ -10,6 +10,7 @@ class CapacityInput(BaseModel):
 
     timezone: str = Field(alias="timeZone")
     series: TimeSeries
+    threshold: float = Field(default=2.5, ge=0)
 
 
 class PeakDetail(BaseModel):

openenergyid/models.py

@@ -6,7 +6,7 @@ from typing import overload
 from typing import Self
 
 import pandas as pd
-from pydantic import BaseModel
+from pydantic import BaseModel, field_validator
 
 
 class TimeSeriesBase(BaseModel):
@@ -47,7 +47,7 @@ class TimeSeriesBase(BaseModel):
 
     @overload
     @classmethod
-    def from_json(cls, path: str, **kwargs) -> Self:
+    def from_json(cls, *, path: str, **kwargs) -> Self:
         """Load from a JSON file."""
 
     @classmethod
@@ -63,15 +63,33 @@ class TimeSeriesBase(BaseModel):
 
 
 class TimeSeries(TimeSeriesBase):
-    """Time series data with a single column."""
+    """
+    Represents a time series data.
+    Attributes:
+        name (str | None): The name of the time series.
+        data (list[float | None]): The data points of the time series.
+    Methods:
+        replace_nan_with_none(cls, data: list[float]) -> list[float | None]:
+            Replace NaN values with None.
+        from_pandas(cls, data: pd.Series) -> Self:
+            Create a TimeSeries object from a Pandas Series.
+        to_pandas(self, timezone: str = "UTC") -> pd.Series:
+            Convert the TimeSeries object to a Pandas Series.
+    """
 
     name: str | None = None
-    data: list[float]
+    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]
 
     @classmethod
     def from_pandas(cls, data: pd.Series) -> Self:
         """Create from a Pandas Series."""
-        return cls.model_construct(name=data.name, data=data.tolist(), index=data.index.tolist())
+        return cls(name=str(data.name), data=data.tolist(), index=data.index.tolist())
 
     def to_pandas(self, timezone: str = "UTC") -> pd.Series:
         """Convert to a Pandas Series."""
@@ -84,12 +102,18 @@ class TimeDataFrame(TimeSeriesBase):
     """Time series data with multiple columns."""
 
     columns: list[str]
-    data: list[list[float]]
+    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]
 
     @classmethod
     def from_pandas(cls, data: pd.DataFrame) -> Self:
         """Create from a Pandas DataFrame."""
-        return cls.model_construct(
+        return cls(
             columns=data.columns.tolist(), data=data.values.tolist(), index=data.index.tolist()
         )
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openenergyid
-Version: 0.1.14
+Version: 0.1.16
 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.14.dist-info → openenergyid-0.1.16.dist-info}/RECORD

@@ -1,11 +1,10 @@
-openenergyid/__init__.py,sha256=HRG7FGexmhpqDgPipT6vEZrgrPFzuYyrfGWeliceX58,193
+openenergyid/__init__.py,sha256=FfypAMLDwdX1imytBRjsN21Oifo8HrmhShNxSLKjFXo,193
 openenergyid/const.py,sha256=D-xUnUyVuLmphClkePgxpFP6z0RDhw_6m7rX0BHBgrw,823
 openenergyid/enums.py,sha256=jdw4CB1gkisx0re_SesrTEyh_T-UxYp6uieE7iYlHdA,357
-openenergyid/models.py,sha256=ghH-pAqbEgT13GfnDFC_W7dVr4NjvLz4QqTajqyeUJM,3855
-openenergyid/capacity/PowerAnalysis.py,sha256=V3-CupATVMQ95U-GWVumAbhj4IccHW-aAc4-Gsq7kWk,1136
+openenergyid/models.py,sha256=F-7BOB-UxIcmR0Y02NHWWjoM_yWwkVOeRtIwZl72KgI,4877
 openenergyid/capacity/__init__.py,sha256=1En96HlPV8kd1hOJO9RjRbXNInp5ZSkmjsjp0jfZlcQ,221
-openenergyid/capacity/main.py,sha256=RLTPOopVW11vSAp-FxsalnzrinwQRnc2LzhJt1RpLMk,3335
-openenergyid/capacity/models.py,sha256=rsxp3tP7_Vk9Qy3EypB9XeTKPpeXk2xRU1GuoT1vUwQ,784
+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
@@ -20,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.14.dist-info/METADATA,sha256=OEFjFlga0hHK7snhPa8OnGAzdzcAtqfECmXzLJwY_7k,2477
-openenergyid-0.1.14.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-openenergyid-0.1.14.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
-openenergyid-0.1.14.dist-info/RECORD,,
+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/capacity/PowerAnalysis.py

@@ -1,34 +0,0 @@
-import datetime
-
-from openenergyid.capacity.models import CapacityInput
-
-
-class PowerPeakAnalysis:
-    """analysis
-    This class is used to analyze the power peaks of a given time series.
-    The analysis is based on the following parameters:
-    - min_peak_value: The minimum value of a peak to be considered a peak.
-    - num_peaks: The number of peaks to be returned.
-    - from_date: The start date of the analysis.
-    - to_date: The end date of the analysis.
-    - x_padding: The number of days to be added to the start and end date to
-      ensure that the peaks are not cut off.
-    - capacity_input: The input data for the analysis.
-    """
-
-    def __init__(
-        self,
-        min_peak_value: float,
-        num_peaks: int,
-        from_date: datetime,
-        to_date: datetime,
-        x_padding: int = 2,
-        capacity_input=CapacityInput,
-    ):
-        self.data = input.get_series()
-        self.timezone = capacity_input.timezone
-        self.min_peak_value = min_peak_value
-        self.num_peaks = num_peaks
-        self.from_date = from_date
-        self.to_date = to_date
-        self.x_padding = x_padding