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

openenergyid/__init__.py

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

openenergyid/capacity/PowerAnalysis.py

@@ -0,0 +1,34 @@
+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

openenergyid/capacity/__init__.py

@@ -0,0 +1,6 @@
+"""Power Offtake peak analysis module."""
+
+from .models import CapacityInput, CapacityOutput, PeakDetail
+from .main import CapacityAnalysis
+
+__all__ = ["CapacityInput", "CapacityAnalysis", "CapacityOutput", "PeakDetail"]

openenergyid/capacity/main.py

@@ -0,0 +1,90 @@
+"""Main module for capacity analysis."""
+
+import datetime as dt
+import pandas as pd
+
+
+class CapacityAnalysis:
+    """
+    A class for performing capacity analysis on a given dataset.
+
+    Attributes:
+        data (CapacityInput): The input data for capacity analysis.
+        threshold (float): The value above which a peak is considered significant.
+        window (str): The window size for grouping data before finding peaks. Defaults to "MS" (month start).
+        x_padding (int): The padding to apply on the x-axis for visualization purposes.
+
+    Methods:
+        find_peaks(): Identifies peaks in the data based on the specified threshold and window.
+        find_peaks_with_surroundings(num_peaks=10): Finds peaks along with their surrounding data points.
+    """
+
+    def __init__(
+        self,
+        data: pd.Series,
+        threshold: float = 2.5,
+        window: str = "MS",  # Default to month start
+        x_padding: int = 4,
+    ):
+        """
+        Constructs all the necessary attributes for the CapacityAnalysis object.
+
+        Parameters:
+            data (CapacityInput): Localized Pandas Series containing power measurements.
+            threshold (float): The value above which a peak is considered significant. Defaults to 2.5.
+            window (str): The window size for grouping data before finding peaks. Defaults to "MS" (month start).
+            x_padding (int): The padding to apply on the x-axis for visualization purposes. Defaults to 4.
+        """
+
+        self.data = data
+        self.threshold = threshold
+        self.window = window
+        self.x_padding = x_padding
+
+    def find_peaks(self) -> pd.Series:
+        """
+        Identifies peaks in the data based on the specified threshold and window.
+
+        Returns:
+            pd.Series: A Pandas Series containing the peaks
+        """
+        # 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(
+        self, num_peaks: int = 10
+    ) -> list[tuple[dt.datetime, float, pd.Series]]:
+        """
+        Finds peaks along with their surrounding data points.
+
+        Parameters:
+            num_peaks (int): The number of peaks to find. Defaults to 10.
+
+        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 = peaks[peaks > self.threshold]
+        if peaks.empty:
+            return []
+        result = []
+        for peak_time, peak_value in peaks.items():
+            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]
+
+            result.append(
+                [
+                    peak_time,
+                    peak_value,
+                    surrounding_data,
+                ]
+            )
+
+        return result

openenergyid/capacity/models.py

@@ -0,0 +1,29 @@
+"""Model for Capacity Analysis."""
+
+import datetime as dt
+from pydantic import BaseModel, ConfigDict, Field
+from openenergyid.models import TimeSeries
+
+
+class CapacityInput(BaseModel):
+    """Model for capacity input"""
+
+    timezone: str = Field(alias="timeZone")
+    series: TimeSeries
+
+
+class PeakDetail(BaseModel):
+    """Model for peak detail"""
+
+    peak_time: dt.datetime = Field(alias="peakTime")
+    peak_value: float = Field(alias="peakValue")
+    surrounding_data: TimeSeries = Field(alias="surroundingData")
+    model_config = ConfigDict(populate_by_name=True)
+
+
+class CapacityOutput(BaseModel):
+    """Model for capacity output"""
+
+    peaks: TimeSeries
+    peak_details: list[PeakDetail] = Field(alias="peakDetails")
+    model_config = ConfigDict(populate_by_name=True)

openenergyid/dyntar/main.py

@@ -1,6 +1,5 @@
 """Main module of the DynTar package."""
 
-from typing import Optional
 import pandas as pd
 
 from openenergyid.const import (
@@ -40,7 +39,7 @@ def weigh_by_monthly_profile(series: pd.Series, profile: pd.Series) -> pd.Series
     return pd.concat(results)["weighted"]
 
 
-def extend_dataframe_with_smr2(df: pd.DataFrame, inplace: bool = False) -> Optional[pd.DataFrame]:
+def extend_dataframe_with_smr2(df: pd.DataFrame, inplace: bool = False) -> pd.DataFrame | None:
     """Extend a DataFrame with the SMR2 columns."""
     if not inplace:
         result_df = df.copy()
@@ -67,7 +66,7 @@ def extend_dataframe_with_smr2(df: pd.DataFrame, inplace: bool = False) -> Optio
     return None
 
 
-def extend_dataframe_with_costs(df: pd.DataFrame, inplace: bool = False) -> Optional[pd.DataFrame]:
+def extend_dataframe_with_costs(df: pd.DataFrame, inplace: bool = False) -> pd.DataFrame | None:
     """Extend a DataFrame with the cost columns."""
     if not inplace:
         result_df = df.copy()
@@ -95,7 +94,7 @@ def extend_dataframe_with_costs(df: pd.DataFrame, inplace: bool = False) -> Opti
 
 def extend_dataframe_with_weighted_prices(
     df: pd.DataFrame, inplace: bool = False
-) -> Optional[pd.DataFrame]:
+) -> pd.DataFrame | None:
     """Extend a DataFrame with the weighted price columns."""
     if not inplace:
         df = df.copy()
@@ -118,9 +117,7 @@ def extend_dataframe_with_weighted_prices(
     return None
 
 
-def extend_dataframe_with_heatmap(
-    df: pd.DataFrame, inplace: bool = False
-) -> Optional[pd.DataFrame]:
+def extend_dataframe_with_heatmap(df: pd.DataFrame, inplace: bool = False) -> pd.DataFrame | None:
     """Extend a DataFrame with the heatmap columns."""
     if not inplace:
         df = df.copy()
@@ -154,7 +151,7 @@ def extend_dataframe_with_heatmap(
     return None
 
 
-def calculate_dyntar_columns(df: pd.DataFrame, inplace: bool = False) -> Optional[pd.DataFrame]:
+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:
         df = df.copy()

openenergyid/energysharing/data_formatting.py

@@ -41,7 +41,6 @@ def create_multi_index_output_frame(
 
     df = pd.concat([net_injection, net_offtake, shared_energy], axis=1)
 
-    df = df.round(2)
     return df
 
 

openenergyid/energysharing/main.py

@@ -16,23 +16,24 @@ def _calculate(df: pd.DataFrame, method: CalculationMethod) -> pd.DataFrame:
     injections_to_share = []
     rest = {}
 
-    for participant in df.columns.levels[1]:
+    for participant in df[GROSS_INJECTION].columns:
         injection_to_share = df[GROSS_INJECTION][participant].copy()
 
+        key = df[KEY].copy()
         if method == CalculationMethod.RELATIVE or method == CalculationMethod.OPTIMAL:
             # Set the key of the current participant to 0
             # Re-normalize the keys for the other participants
-            key = df[KEY].copy()
-            key.loc[:, participant] = 0
-            key = key.div(key.sum(axis=1), axis=0)
-        elif method == CalculationMethod.FIXED:
-            key = df[KEY].copy()
+            if participant in df[KEY].columns:
+                key.loc[:, participant] = 0
+                key = key.div(key.sum(axis=1), axis=0)
 
         # Multiply injection_to_share with the key of each participant
         shared_by_participant = (injection_to_share * key.T).T
         shared_by_participant.fillna(0, inplace=True)
+
         # Set the value for the current participant to 0
-        shared_by_participant.loc[:, participant] = 0
+        if participant in shared_by_participant.columns:
+            shared_by_participant.loc[:, participant] = 0
 
         # Put the not shared injection in the rest
         rest[participant] = injection_to_share - shared_by_participant.sum(axis=1)
@@ -51,7 +52,7 @@ def _calculate(df: pd.DataFrame, method: CalculationMethod) -> pd.DataFrame:
     net_offtake = df[GROSS_OFFTAKE] - max_allocated_injection
 
     # Sum all negative values into a column "Not Shared"
-    not_shared_after_assignment = net_offtake.clip(upper=0).sum(axis=1) * -1
+    not_shared_after_assignment = net_offtake.clip(upper=0).sum(axis=1).abs()
 
     # Clip the values to 0
     net_offtake = net_offtake.clip(lower=0)

openenergyid/energysharing/models.py

@@ -34,7 +34,7 @@ class KeyInput(TimeDataFrame):
     def model_post_init(self, __context: Any) -> None:
         """Post-initialization validation."""
         for row in self.data:
-            if round(sum(row), 6) != 1:
+            if round(sum(row), 3) != 1.0:
                 raise ValueError("Each row must sum to 1.")
         return super().model_post_init(__context)
 

openenergyid/models.py

@@ -1,12 +1,9 @@
 """Data models for the Open Energy ID."""
 
 import datetime as dt
-from typing import Optional, overload, Union
+from typing import overload
 
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Self
 
 import pandas as pd
 from pydantic import BaseModel
@@ -18,11 +15,11 @@ class TimeSeriesBase(BaseModel):
     index: list[dt.datetime]
 
     @classmethod
-    def from_pandas(cls, data: Union[pd.Series, pd.DataFrame]) -> Self:
+    def from_pandas(cls, data: pd.Series | pd.DataFrame) -> Self:
         """Create from a Pandas Object."""
         raise NotImplementedError
 
-    def to_pandas(self, timezone: str = "UTC") -> Union[pd.Series, pd.DataFrame]:
+    def to_pandas(self, timezone: str = "UTC") -> pd.Series | pd.DataFrame:
         """Convert to a Pandas Object."""
         raise NotImplementedError
 
@@ -34,7 +31,7 @@ class TimeSeriesBase(BaseModel):
     def to_json(self, path: str, **kwargs) -> None:
         """Dump to a JSON file."""
 
-    def to_json(self, path: Optional[str] = None, **kwargs) -> Optional[str]:
+    def to_json(self, path: str | None = None, **kwargs) -> str | None:
         """Dump to a JSON string or file."""
         if path is None:
             return self.model_dump_json(**kwargs)
@@ -54,13 +51,13 @@ class TimeSeriesBase(BaseModel):
         """Load from a JSON file."""
 
     @classmethod
-    def from_json(cls, string: Optional[str] = None, path: Optional[str] = None, **kwargs) -> Self:
+    def from_json(cls, string: str | None = None, path: str | None = None, **kwargs) -> Self:
         """Load from a JSON file or string."""
         if string:
             return cls.model_validate_json(string, **kwargs)
         if path:
             encoding = kwargs.pop("encoding", "UTF-8")
-            with open(path, "r", encoding=encoding) as file:
+            with open(path, encoding=encoding) as file:
                 return cls.model_validate_json(file.read(), **kwargs)
         raise ValueError("Either string or path must be provided.")
 
@@ -68,7 +65,7 @@ class TimeSeriesBase(BaseModel):
 class TimeSeries(TimeSeriesBase):
     """Time series data with a single column."""
 
-    name: Union[str, None] = None
+    name: str | None = None
     data: list[float]
 
     @classmethod

openenergyid/mvlr/models.py

@@ -1,5 +1,6 @@
 """Models for multivariable linear regression."""
-from typing import Any, List, Optional
+
+from typing import Any
 import pandas as pd
 
 from pydantic import BaseModel, Field, ConfigDict
@@ -45,7 +46,7 @@ class IndependentVariableInput(BaseModel):
         "If the name is `temperatureEquivalent`, "
         "it will be unpacked into columns according to the variants."
     )
-    variants: Optional[list[str]] = Field(
+    variants: list[str] | None = Field(
         default=None,
         description="Variants of the `temperatureEquivalent` independent variable. "
         "Eg. `HDD_16.5` will be Heating Degree Days with a base temperature of 16.5°C, "
@@ -62,7 +63,7 @@ class MultiVariableRegressionInput(BaseModel):
     """Multi-variable regression input."""
 
     timezone: str = Field(alias="timeZone")
-    independent_variables: List[IndependentVariableInput] = Field(
+    independent_variables: list[IndependentVariableInput] = Field(
         alias="independentVariables", min_length=1
     )
     dependent_variable: str = Field(alias="dependentVariable")
@@ -72,7 +73,7 @@ class MultiVariableRegressionInput(BaseModel):
     validation_parameters: ValidationParameters = Field(
         alias="validationParameters", default=ValidationParameters()
     )
-    single_use_exog_prefixes: Optional[List[str]] = Field(
+    single_use_exog_prefixes: list[str] | None = Field(
         # default=["HDD", "CDD", "FDD"],
         default=None,
         alias="singleUseExogPrefixes",
@@ -128,7 +129,7 @@ class MultiVariableRegressionInput(BaseModel):
 
         return frame
 
-    def get_disallowed_negative_coefficients(self) -> List[str]:
+    def get_disallowed_negative_coefficients(self) -> list[str]:
         """Get independent variables that are not allowed to have a negative coefficient."""
         result = []
         for iv in self.independent_variables:  # pylint: disable=not-an-iterable
@@ -158,12 +159,10 @@ class IndependentVariableResult(BaseModel):
 
     name: str
     coef: float
-    t_stat: Optional[float] = Field(default=None, alias="tStat")
-    p_value: Optional[float] = Field(ge=0, le=1, default=None, alias="pValue")
-    std_err: Optional[float] = Field(default=None, alias="stdErr")
-    confidence_interval: Optional[ConfidenceInterval] = Field(
-        default=None, alias="confidenceInterval"
-    )
+    t_stat: float | None = Field(default=None, alias="tStat")
+    p_value: float | None = Field(ge=0, le=1, default=None, alias="pValue")
+    std_err: float | None = Field(default=None, alias="stdErr")
+    confidence_interval: ConfidenceInterval | None = Field(default=None, alias="confidenceInterval")
 
     model_config = ConfigDict(populate_by_name=True)
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openenergyid
-Version: 0.1.13
+Version: 0.1.14
 Summary: Open Source Python library for energy analytics and simulations
 Project-URL: Homepage, https://energyid.eu
 Project-URL: Repository, https://github.com/EnergieID/OpenEnergyID
@@ -44,4 +44,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 
 # OpenEnergyID
+
 Open Source Python library for energy data analytics and simulations
+
+[*more info for developers*](DEVELOPERS.md)

openenergyid-0.1.14.dist-info/RECORD

@@ -0,0 +1,26 @@
+openenergyid/__init__.py,sha256=HRG7FGexmhpqDgPipT6vEZrgrPFzuYyrfGWeliceX58,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/capacity/__init__.py,sha256=1En96HlPV8kd1hOJO9RjRbXNInp5ZSkmjsjp0jfZlcQ,221
+openenergyid/capacity/main.py,sha256=RLTPOopVW11vSAp-FxsalnzrinwQRnc2LzhJt1RpLMk,3335
+openenergyid/capacity/models.py,sha256=rsxp3tP7_Vk9Qy3EypB9XeTKPpeXk2xRU1GuoT1vUwQ,784
+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/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
+openenergyid/energysharing/main.py,sha256=QKrtDyAlmKj0qtlqlUMjTJujQeKBK9U1_W80-RZWt-U,4449
+openenergyid/energysharing/models.py,sha256=-FedTqWqoi7AYrbI4S_pX0bMScrbZxncQ21CXFz2cXM,2526
+openenergyid/mvlr/__init__.py,sha256=Glrc218oqa8tq_Y2G9LXaSoN4Yba-vsjXUi9r9iPzaY,471
+openenergyid/mvlr/helpers.py,sha256=Uzbfrj3IpH26wA206KOl0hNucKE-n9guJNC_EROBVKA,983
+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.13.dist-info/RECORD

@@ -1,22 +0,0 @@
-openenergyid/__init__.py,sha256=rv5QjTRqWXVl6rEiphVaBPrzKnc-Hu1vlVS17R-v0GU,193
-openenergyid/const.py,sha256=D-xUnUyVuLmphClkePgxpFP6z0RDhw_6m7rX0BHBgrw,823
-openenergyid/enums.py,sha256=jdw4CB1gkisx0re_SesrTEyh_T-UxYp6uieE7iYlHdA,357
-openenergyid/models.py,sha256=ANdbdtr6JccSz6zEZj0TQOXISGPdtJPQy4t17uub97E,3975
-openenergyid/dyntar/__init__.py,sha256=iQXQXrEQOiVNeeF6LRmUf3oOhKlGjMNF7o4T04IWTGA,371
-openenergyid/dyntar/const.py,sha256=K7X6nHIl9DNyC6hU8jLtvOy3-IBGuYC449evOpImuJE,773
-openenergyid/dyntar/main.py,sha256=sn2zN5ep8XBgSGR_UDBU6mdp1WKNLzxROwp8HWCDgCM,5316
-openenergyid/dyntar/models.py,sha256=BbGdHj7eUOMepblWJNsNd21xULluv6m7TtdhSggvVbY,1873
-openenergyid/energysharing/__init__.py,sha256=A4JfrUYf-hBCzhUm0qL1GGlNMvpO8OwXJo80dJxFIvw,274
-openenergyid/energysharing/const.py,sha256=X2zEPtTlsmZ66w6RmLS_h8NmdzObAEi5N6-0yrLN5V4,219
-openenergyid/energysharing/data_formatting.py,sha256=RjP6NOyCXS9gI3x2NfQwHTJh9IbZJEExhXMZ4Zc0ImI,2604
-openenergyid/energysharing/main.py,sha256=2AWaTysNVLZEFVs8yRmFWx1_qG-NPeAazWXlFLHfLRM,4409
-openenergyid/energysharing/models.py,sha256=GQs7dsKxiShVKKIjNjvSgn6bafwFNuGZ8q6QnmslCjM,2524
-openenergyid/mvlr/__init__.py,sha256=Glrc218oqa8tq_Y2G9LXaSoN4Yba-vsjXUi9r9iPzaY,471
-openenergyid/mvlr/helpers.py,sha256=Uzbfrj3IpH26wA206KOl0hNucKE-n9guJNC_EROBVKA,983
-openenergyid/mvlr/main.py,sha256=cn7jZ98cHn2eh-0zG9q8Pad0Ft_FuI-u3a-eeHeF8jA,1304
-openenergyid/mvlr/models.py,sha256=qi5NWeQC1KeWEAO8KglgVM1xbHM5QoeK25ugn0W_X6c,8628
-openenergyid/mvlr/mvlr.py,sha256=F7WvWnZQtqUmK1vsguemsn9n8pDDk3tQ1weOlv-bo0c,18626
-openenergyid-0.1.13.dist-info/METADATA,sha256=9r6beVSt2i5VHjwsyEUnnHMR-lopo-S6-29yIq1s05E,2432
-openenergyid-0.1.13.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-openenergyid-0.1.13.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
-openenergyid-0.1.13.dist-info/RECORD,,