openenergyid 0.1.7__py2.py3-none-any.whl → 0.1.9__py2.py3-none-any.whl

openenergyid/__init__.py

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

openenergyid/const.py

@@ -0,0 +1,13 @@
+"""Constants for the Open Energy ID package."""
+
+from typing import Literal
+
+# METRICS
+
+ELECTRICITY_DELIVERED: Literal["electricity_delivered"] = "electricity_delivered"
+ELECTRICITY_EXPORTED: Literal["electricity_exported"] = "electricity_exported"
+ELECTRICITY_PRODUCED: Literal["electricity_produced"] = "electricity_produced"
+
+PRICE_DAY_AHEAD: Literal["price_day_ahead"] = "price_day_ahead"
+PRICE_IMBALANCE_UPWARD: Literal["price_imbalance_upward"] = "price_imbalance_upward"
+PRICE_IMBALANCE_DOWNWARD: Literal["price_imbalance_downward"] = "price_imbalance_downward"

openenergyid/models.py

@@ -1,6 +1,7 @@
 """Data models for the Open Energy ID."""
 
 import datetime as dt
+from typing import Optional, overload
 
 import pandas as pd
 from pydantic import BaseModel
@@ -23,3 +24,44 @@ class TimeSeries(BaseModel):
         frame = pd.DataFrame(self.data, columns=self.columns, index=self.index)
         frame.index = pd.to_datetime(frame.index, utc=True)
         return frame.tz_convert(timezone)
+
+    @overload
+    def to_json(self, path: None = None, **kwargs) -> str:
+        ...
+
+    @overload
+    def to_json(self, path: str, **kwargs) -> None:
+        ...
+
+    def to_json(self, path: Optional[str] = None, **kwargs) -> Optional[str]:
+        """Save the TimeSeries to a JSON file or return as string."""
+        if path is None:
+            return self.model_dump_json(**kwargs)
+        else:
+            encoding = kwargs.pop("encoding", "UTF-8")
+            with open(path, "w", encoding=encoding) as file:
+                file.write(self.model_dump_json(**kwargs))
+
+    @overload
+    @classmethod
+    def from_json(cls, string: str, **kwargs) -> "TimeSeries":
+        ...
+
+    @overload
+    @classmethod
+    def from_json(cls, path: str, **kwargs) -> "TimeSeries":
+        ...
+
+    @classmethod
+    def from_json(
+        cls, string: Optional[str] = None, path: Optional[str] = None, **kwargs
+    ) -> "TimeSeries":
+        """Load the TimeSeries from a JSON file or string."""
+        if string:
+            return cls.model_validate_json(string, **kwargs)
+        elif path:
+            encoding = kwargs.pop("encoding", "UTF-8")
+            with open(path, "r", encoding=encoding) as file:
+                return cls.model_validate_json(file.read(), **kwargs)
+        else:
+            raise ValueError("Either string or path must be provided.")

openenergyid/mvlr/main.py

@@ -17,6 +17,8 @@ def find_best_mvlr(
             y=data.dependent_variable,
             granularity=granularity,
             allow_negative_predictions=data.allow_negative_predictions,
+            single_use_exog_prefixes=data.single_use_exog_prefixes,
+            exogs__disallow_negative_coefficient=data.get_disallowed_negative_coefficients(),
         )
         mvlr.do_analysis()
         if mvlr.validate(

openenergyid/mvlr/models.py

@@ -51,6 +51,11 @@ class IndependentVariableInput(BaseModel):
         "Eg. `HDD_16.5` will be Heating Degree Days with a base temperature of 16.5°C, "
         "`CDD_0` will be Cooling Degree Days with a base temperature of 0°C.",
     )
+    allow_negative_coefficient: bool = Field(
+        default=True,
+        alias="allowNegativeCoefficient",
+        description="Whether the coefficient can be negative.",
+    )
 
 
 class MultiVariableRegressionInput(BaseModel):
@@ -67,6 +72,12 @@ class MultiVariableRegressionInput(BaseModel):
     validation_parameters: ValidationParameters = Field(
         alias="validationParameters", default=ValidationParameters()
     )
+    single_use_exog_prefixes: Optional[List[str]] = Field(
+        # default=["HDD", "CDD", "FDD"],
+        default=None,
+        alias="singleUseExogPrefixes",
+        description="List of prefixes to be used as single-use exogenous variables.",
+    )
 
     def model_post_init(self, __context: Any) -> None:
         """Post init hook."""
@@ -117,6 +128,17 @@ class MultiVariableRegressionInput(BaseModel):
 
         return frame
 
+    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
+            if iv.name == COLUMN_TEMPERATUREEQUIVALENT and iv.variants is not None:
+                if not iv.allow_negative_coefficient:
+                    result.extend(iv.variants)
+            elif not iv.allow_negative_coefficient:
+                result.append(iv.name)
+        return result
+
 
 ######################
 # MVLR Result Models #

openenergyid/mvlr/mvlr.py

@@ -40,6 +40,8 @@ class MultiVariableLinearRegression:
         cross_validation: bool = False,
         allow_negative_predictions: bool = False,
         granularity: Granularity = None,
+        single_use_exog_prefixes: list[str] = None,
+        exogs__disallow_negative_coefficient: list[str] = None,
     ):
         """Parameters
         ----------
@@ -62,6 +64,17 @@ class MultiVariableLinearRegression:
             If True, allow predictions to be negative.
             For gas consumption or PV production, this is not physical
             so allow_negative_predictions should be False
+        granularity : Granularity, default=None
+            Granularity of the data. Is only used for the output of the model.
+            If None, the granularity is not set.
+        single_use_exog_prefixes : list of str, default=None
+            List of variable prefixes that indicate a variable type that should only be used once.
+            For example, if the list contains "HDD", only one of the columns "HDD1", "HDD2", "HDD3" etc.
+            will be used as an independent variable.
+            Once the best fit using a variable with a given prefix is found, the other variables with the same
+            prefix will not be used as independent variables.
+        exogs__disallow_negative_coefficient : list of str, default=None
+            List of variable names for which the coefficient is not allowed to be negative.
         """
         self.data = data.copy()
         if y not in self.data.columns:
@@ -76,6 +89,8 @@ class MultiVariableLinearRegression:
         self.cross_validation = cross_validation
         self.allow_negative_predictions = allow_negative_predictions
         self.granularity = granularity
+        self.single_use_exog_prefixes = single_use_exog_prefixes
+        self.exogs__disallow_negative_coefficient = exogs__disallow_negative_coefficient
         self._fit = None
         self._list_of_fits = []
         self.list_of_cverrors = []
@@ -150,6 +165,15 @@ class MultiVariableLinearRegression:
                     ref_fit.model.formula.rhs_termlist + [term],
                 )
                 fit = fm.ols(model_desc, data=self.data).fit()
+
+                # Check if the coefficient of the variable is allowed to be negative
+                if (
+                    self.exogs__disallow_negative_coefficient is not None
+                    and x in self.exogs__disallow_negative_coefficient
+                    and fit.params[x] < 0
+                ):
+                    continue
+
                 if fit.bic < best_bic:
                     best_bic = fit.bic
                     best_fit = fit
@@ -163,9 +187,21 @@ class MultiVariableLinearRegression:
                 ref_fit.model.formula.rhs_termlist,
             ):
                 break
-            else:
-                self._list_of_fits.append(best_fit)
-                all_model_terms_dict.pop(best_x)
+
+            self._list_of_fits.append(best_fit)
+            all_model_terms_dict.pop(best_x)
+
+            # Check if `best_x` starts with a prefix that should only be used once
+            # If so, remove all other variables with the same prefix from the list of candidates
+            if self.single_use_exog_prefixes:
+                for prefix in self.single_use_exog_prefixes:
+                    if best_x.startswith(prefix):
+                        all_model_terms_dict = {
+                            k: v
+                            for k, v in all_model_terms_dict.items()
+                            if not k.startswith(prefix)
+                        }
+
         self._fit = self._list_of_fits[-1]
 
     def _do_analysis_cross_validation(self):
@@ -237,6 +273,17 @@ class MultiVariableLinearRegression:
             # next iteration with the found exog removed
             all_model_terms_dict.pop(best_x)
 
+            # Check if `best_x` starts with a prefix that should only be used once
+            # If so, remove all other variables with the same prefix from the list of candidates
+            if self.single_use_exog_prefixes:
+                for prefix in self.single_use_exog_prefixes:
+                    if best_x.startswith(prefix):
+                        all_model_terms_dict = {
+                            k: v
+                            for k, v in all_model_terms_dict.items()
+                            if not k.startswith(prefix)
+                        }
+
         self._fit = self._list_of_fits[-1]
 
     def _prune(self, fit: fm.ols, p_max: float) -> fm.ols:

{openenergyid-0.1.7.dist-info → openenergyid-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openenergyid
-Version: 0.1.7
+Version: 0.1.9
 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.9.dist-info/RECORD

@@ -0,0 +1,13 @@
+openenergyid/__init__.py,sha256=_KWarhaNa9a-pxb9L4P7NUtWUi8A2CVl9nD29g21mYs,160
+openenergyid/const.py,sha256=bF-U-r0Qj2GWCYBBxReg8fbv2D0V1JzfPMwSEQ5ZWds,569
+openenergyid/enums.py,sha256=jdw4CB1gkisx0re_SesrTEyh_T-UxYp6uieE7iYlHdA,357
+openenergyid/models.py,sha256=pUJpQCodph0NukiIpFdc9X6Zj6qEGQPSWoztYDwqyuE,2214
+openenergyid/mvlr/__init__.py,sha256=Glrc218oqa8tq_Y2G9LXaSoN4Yba-vsjXUi9r9iPzaY,471
+openenergyid/mvlr/helpers.py,sha256=fsx-gSvBdU31BjncFkRd1RySmSPPYgwflCnmSFzox2Q,961
+openenergyid/mvlr/main.py,sha256=cn7jZ98cHn2eh-0zG9q8Pad0Ft_FuI-u3a-eeHeF8jA,1304
+openenergyid/mvlr/models.py,sha256=SdZYroi3EM4D1U6OnnyfBv6ygzfAQM2UzICg0jaQD6w,8616
+openenergyid/mvlr/mvlr.py,sha256=F7WvWnZQtqUmK1vsguemsn9n8pDDk3tQ1weOlv-bo0c,18626
+openenergyid-0.1.9.dist-info/METADATA,sha256=8BhGlQs47GfSa2XnCp3Hb9vQE_eE0vtSo7RoSAH3Mx8,2431
+openenergyid-0.1.9.dist-info/WHEEL,sha256=ccEkY-EGGllEs7ySpwBlD8G4u70wR77CNej8Q6tzIqA,105
+openenergyid-0.1.9.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
+openenergyid-0.1.9.dist-info/RECORD,,

{openenergyid-0.1.7.dist-info → openenergyid-0.1.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.18.0
+Generator: hatchling 1.21.1
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

openenergyid-0.1.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-openenergyid/__init__.py,sha256=LWqiRKaHvmuTOpoTZcvQkgPhotMEc7tsuqzZ47Y1AKs,160
-openenergyid/enums.py,sha256=jdw4CB1gkisx0re_SesrTEyh_T-UxYp6uieE7iYlHdA,357
-openenergyid/models.py,sha256=w6YJHi1fysmLZYEI6peTfQAbMS92Kf5sk0VtXw7HrAM,813
-openenergyid/mvlr/__init__.py,sha256=Glrc218oqa8tq_Y2G9LXaSoN4Yba-vsjXUi9r9iPzaY,471
-openenergyid/mvlr/helpers.py,sha256=fsx-gSvBdU31BjncFkRd1RySmSPPYgwflCnmSFzox2Q,961
-openenergyid/mvlr/main.py,sha256=r4o3394jUd72sSJtIae67WDrGB7XP9ZMAiytpr3YFPw,1142
-openenergyid/mvlr/models.py,sha256=F8GrqtAK6bfR3Eur7hp3XjGj433bh4hZVRtGvg3DeUY,7625
-openenergyid/mvlr/mvlr.py,sha256=Cxgc-GeZpVuxvoRgP1Po7ttFdFArA5tW0fB8sihtikI,16063
-openenergyid-0.1.7.dist-info/METADATA,sha256=nDBrDk5TFlmzLFbMAiEnP_4A7QFceNL_RO5F6Mj1UmE,2431
-openenergyid-0.1.7.dist-info/WHEEL,sha256=fagL_Tj29mg80flwlxJNW45nBDbboxF04Tnbc_jt3Bg,105
-openenergyid-0.1.7.dist-info/licenses/LICENSE,sha256=NgRdcNHwyXVCXZ8sJwoTp0DCowThJ9LWWl4xhbV1IUY,1074
-openenergyid-0.1.7.dist-info/RECORD,,