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

openenergyid/__init__.py

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

openenergyid/energysharing/__init__.py

@@ -1,6 +1,12 @@
 """Energy Sharing package."""
 
 from .main import calculate
-from .models import CalculationMethod, EnergySharingInput, EnergySharingOutput
+from .models import CalculationMethod, EnergySharingInput, EnergySharingOutput, KeyInput
 
-__all__ = ["calculate", "CalculationMethod", "EnergySharingInput", "EnergySharingOutput"]
+__all__ = [
+    "calculate",
+    "CalculationMethod",
+    "EnergySharingInput",
+    "EnergySharingOutput",
+    "KeyInput",
+]

openenergyid/energysharing/data_formatting.py

@@ -22,9 +22,6 @@ def create_multi_index_input_frame(
 
     df = pd.concat([gross_injection, gross_offtake, key], axis=1)
 
-    # Do a check that the sum of the keys per timestamp is 1
-    assert df[KEY].dropna(how="all").sum(axis=1).round(2).eq(1).all()
-
     return df
 
 

openenergyid/energysharing/models.py

@@ -1,9 +1,9 @@
 """Data models for energy sharing."""
 
 from enum import Enum
-from typing import Annotated
+from typing import Annotated, Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, confloat
 import pandas as pd
 
 from openenergyid import TimeDataFrame
@@ -19,22 +19,46 @@ class CalculationMethod(Enum):
     OPTIMAL = "Optimal"
 
 
+class KeyInput(TimeDataFrame):
+    """Energy Sharing Keys."""
+
+    data: Annotated[
+        list[list[confloat(ge=0.0, le=1.0)]],  # type: ignore
+        Field(
+            description="Key data, column per participant. "
+            "Must be between 0 and 1. "
+            "Each row must sum to 1."
+        ),
+    ]
+
+    def model_post_init(self, __context: Any) -> None:
+        """Post-initialization validation."""
+        for row in self.data:
+            if round(sum(row), 6) != 1:
+                raise ValueError("Each row must sum to 1.")
+        return super().model_post_init(__context)
+
+
 class EnergySharingInput(BaseModel):
     """Input data for energy sharing."""
 
-    gross_injection: Annotated[TimeDataFrame, Field(alias="grossInjection")]
-    gross_offtake: Annotated[TimeDataFrame, Field(alias="grossOfftake")]
-    key: Annotated[TimeDataFrame, Field(alias="key")]
-    timezone: str = Field(alias="timeZone", default="Europe/Brussels")
+    gross_injection: Annotated[
+        TimeDataFrame,
+        Field(alias="grossInjection", description="Gross injection data, column per participant"),
+    ]
+    gross_offtake: Annotated[
+        TimeDataFrame,
+        Field(alias="grossOfftake", description="Gross offtake data, column per participant"),
+    ]
+    key: KeyInput
 
-    def data_frame(self) -> pd.DataFrame:
+    def to_pandas(self) -> pd.DataFrame:
         """Return the data as a combined DataFrame"""
         df = create_multi_index_input_frame(
             gross_injection=self.gross_injection.to_pandas(),
             gross_offtake=self.gross_offtake.to_pandas(),
             key=self.key.to_pandas(),
         )
-        df = df.tz_convert(self.timezone)
         return df
 
 

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

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

@@ -1,4 +1,4 @@
-openenergyid/__init__.py,sha256=5EauuvlNmYacZW0kJXDfcpOSZWOwSlzX640snXiX92E,193
+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
@@ -6,17 +6,17 @@ openenergyid/dyntar/__init__.py,sha256=iQXQXrEQOiVNeeF6LRmUf3oOhKlGjMNF7o4T04IWT
 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=swGqqgTh6DS2wFhnKs4CtnVMVrQNs6kv1BAzwgo0MQA,229
+openenergyid/energysharing/__init__.py,sha256=A4JfrUYf-hBCzhUm0qL1GGlNMvpO8OwXJo80dJxFIvw,274
 openenergyid/energysharing/const.py,sha256=X2zEPtTlsmZ66w6RmLS_h8NmdzObAEi5N6-0yrLN5V4,219
-openenergyid/energysharing/data_formatting.py,sha256=ruAPa_Qbg6PMoUSObnhIYz5y-BeK92WlsOpLIdNXaeg,2736
+openenergyid/energysharing/data_formatting.py,sha256=RjP6NOyCXS9gI3x2NfQwHTJh9IbZJEExhXMZ4Zc0ImI,2604
 openenergyid/energysharing/main.py,sha256=2AWaTysNVLZEFVs8yRmFWx1_qG-NPeAazWXlFLHfLRM,4409
-openenergyid/energysharing/models.py,sha256=Bh7Nj_PFoCIKwdI7k4d_RrJnaiubT3dN2eIn5P4Xam4,1894
+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.12.dist-info/METADATA,sha256=5wBSQdBWuoeh8YMuW-pU9Y9VeK3gRhK9QG18zMZf1kM,2432
-openenergyid-0.1.12.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-openenergyid-0.1.12.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
-openenergyid-0.1.12.dist-info/RECORD,,
+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,,