openstef 3.4.40__py3-none-any.whl → 3.4.43__py3-none-any.whl

openstef/data_classes/prediction_job.py

@@ -9,7 +9,7 @@ from pydantic.v1 import BaseModel
 from openstef.data_classes.data_prep import DataPrepDataClass
 from openstef.data_classes.model_specifications import ModelSpecificationDataClass
 from openstef.data_classes.split_function import SplitFuncDataClass
-from openstef.enums import PipelineType
+from openstef.enums import PipelineType, BiddingZone
 
 
 class PredictionJobDataClass(BaseModel):
@@ -54,6 +54,8 @@ class PredictionJobDataClass(BaseModel):
     lon: Optional[float] = 5.291266
     """Longitude of the forecasted location in degrees. Used for fetching weather data in tasks, calculating derrived features and component splitting."""
     name: str
+    """Bidding zone is used to determine the electricity price. It is also used to determine the holidays that should be used. Currently only ENTSO-E bidding zones are supported."""
+    electricity_bidding_zone: Optional[BiddingZone] = BiddingZone.NL
     """Name of the forecast, e.g. the location name."""
     train_components: Optional[bool]
     """Whether splitting the forecasts in wind, solar, rest is desired."""

openstef/enums.py

@@ -4,6 +4,110 @@
 from enum import Enum
 
 
+class BiddingZone(Enum):
+    DE_50HZ = "DE_50HZ"
+    AL = "AL"
+    DE_AMPRION = "DE_AMPRION"
+    AT = "AT"
+    BY = "BY"
+    BE = "BE"
+    BA = "BA"
+    BG = "BG"
+    CZ_DE_SK = "CZ_DE_SK"
+    HR = "HR"
+    CWE = "CWE"
+    CY = "CY"
+    CZ = "CZ"
+    DE_AT_LU = "DE_AT_LU"
+    DE_LU = "DE_LU"
+    DK = "DK"
+    DK_1 = "DK_1"
+    DK_1_NO_1 = "DK_1_NO_1"
+    DK_2 = "DK_2"
+    DK_CA = "DK_CA"
+    EE = "EE"
+    FI = "FI"
+    MK = "MK"
+    FR = "FR"
+    DE = "DE"
+    GR = "GR"
+    HU = "HU"
+    IS = "IS"
+    IE_SEM = "IE_SEM"
+    IE = "IE"
+    IT = "IT"
+    IT_SACO_AC = "IT_SACO_AC"
+    IT_CALA = "IT_CALA"
+    IT_SACO_DC = "IT_SACO_DC"
+    IT_BRNN = "IT_BRNN"
+    IT_CNOR = "IT_CNOR"
+    IT_CSUD = "IT_CSUD"
+    IT_FOGN = "IT_FOGN"
+    IT_GR = "IT_GR"
+    IT_MACRO_NORTH = "IT_MACRO_NORTH"
+    IT_MACRO_SOUTH = "IT_MACRO_SOUTH"
+    IT_MALTA = "IT_MALTA"
+    IT_NORD = "IT_NORD"
+    IT_NORD_AT = "IT_NORD_AT"
+    IT_NORD_CH = "IT_NORD_CH"
+    IT_NORD_FR = "IT_NORD_FR"
+    IT_NORD_SI = "IT_NORD_SI"
+    IT_PRGP = "IT_PRGP"
+    IT_ROSN = "IT_ROSN"
+    IT_SARD = "IT_SARD"
+    IT_SICI = "IT_SICI"
+    IT_SUD = "IT_SUD"
+    RU_KGD = "RU_KGD"
+    LV = "LV"
+    LT = "LT"
+    LU = "LU"
+    LU_BZN = "LU_BZN"
+    MT = "MT"
+    ME = "ME"
+    GB = "GB"
+    GE = "GE"
+    GB_IFA = "GB_IFA"
+    GB_IFA2 = "GB_IFA2"
+    GB_ELECLINK = "GB_ELECLINK"
+    UK = "UK"
+    NL = "NL"
+    NO_1 = "NO_1"
+    NO_1A = "NO_1A"
+    NO_2 = "NO_2"
+    NO_2_NSL = "NO_2_NSL"
+    NO_2A = "NO_2A"
+    NO_3 = "NO_3"
+    NO_4 = "NO_4"
+    NO_5 = "NO_5"
+    NO = "NO"
+    PL_CZ = "PL_CZ"
+    PL = "PL"
+    PT = "PT"
+    MD = "MD"
+    RO = "RO"
+    RU = "RU"
+    SE_1 = "SE_1"
+    SE_2 = "SE_2"
+    SE_3 = "SE_3"
+    SE_4 = "SE_4"
+    RS = "RS"
+    SK = "SK"
+    SI = "SI"
+    GB_NIR = "GB_NIR"
+    ES = "ES"
+    SE = "SE"
+    CH = "CH"
+    DE_TENNET = "DE_TENNET"
+    DE_TRANSNET = "DE_TRANSNET"
+    TR = "TR"
+    UA = "UA"
+    UA_DOBTPP = "UA_DOBTPP"
+    UA_BEI = "UA_BEI"
+    UA_IPS = "UA_IPS"
+    XK = "XK"
+    DE_AMP_LU = "DE_AMP_LU"
+
+
 class ModelType(Enum):
     XGB = "xgb"
     XGB_QUANTILE = "xgb_quantile"

openstef/feature_engineering/apply_features.py

@@ -14,10 +14,14 @@ Examples of features that are added:
 import pandas as pd
 
 from openstef.data_classes.prediction_job import PredictionJobDataClass
+from openstef.enums import BiddingZone
 from openstef.feature_engineering.holiday_features import (
     generate_holiday_feature_functions,
 )
 from openstef.feature_engineering.lag_features import generate_lag_feature_functions
+from openstef.feature_engineering.bidding_zone_to_country_mapping import (
+    BIDDING_ZONE_TO_COUNTRY_CODE_MAPPING,
+)
 from openstef.feature_engineering.weather_features import (
     add_additional_solar_features,
     add_additional_wind_features,
@@ -58,6 +62,7 @@ def apply_features(
 
         import pandas as pd
         import numpy as np
+        from geopy.geocoders import Nominatim
         index = pd.date_range(start = "2017-01-01 09:00:00",
         freq = '15T', periods = 200)
         data = pd.DataFrame(index = index,
@@ -66,6 +71,9 @@ def apply_features(
                             np.random.uniform(0.7,1.7, 200)))
 
     """
+    if pj is None:
+        pj = {"electricity_bidding_zone": BiddingZone.NL}
+
     # Get lag feature functions
     feature_functions = generate_lag_feature_functions(feature_names, horizon)
 
@@ -80,8 +88,14 @@ def apply_features(
         }
     )
 
+    # Get country code from bidding zone if available
+    electricity_bidding_zone = pj.get("electricity_bidding_zone", BiddingZone.NL)
+    country_code = BIDDING_ZONE_TO_COUNTRY_CODE_MAPPING[electricity_bidding_zone.name]
+
     # Get holiday feature functions
-    feature_functions.update(generate_holiday_feature_functions())
+    feature_functions.update(
+        generate_holiday_feature_functions(country_code=country_code)
+    )
 
     # Add the features to the dataframe using previously defined feature functions
     for key, featfunc in feature_functions.items():

openstef/feature_engineering/bidding_zone_to_country_mapping.py

@@ -0,0 +1,106 @@
+# SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+BIDDING_ZONE_TO_COUNTRY_CODE_MAPPING = {
+    "DE_50HZ": "DE",
+    "AL": "AL",
+    "DE_AMPRION": "DE",
+    "AT": "AT",
+    "BY": "BY",
+    "BE": "BE",
+    "BA": "BA",
+    "BG": "BG",
+    "CZ_DE_SK": "CZ",
+    "HR": "HR",
+    "CWE": "CWE",
+    "CY": "CY",
+    "CZ": "CZ",
+    "DE_AT_LU": "DE",
+    "DE_LU": "DE",
+    "DK": "DK",
+    "DK_1": "DK",
+    "DK_1_NO_1": "DK",
+    "DK_2": "DK",
+    "DK_CA": "DK",
+    "EE": "EE",
+    "FI": "FI",
+    "MK": "MK",
+    "FR": "FR",
+    "DE": "DE",
+    "GR": "GR",
+    "HU": "HU",
+    "IS": "IS",
+    "IE_SEM": "IE",
+    "IE": "IE",
+    "IT": "IT",
+    "IT_SACO_AC": "IT",
+    "IT_CALA": "IT",
+    "IT_SACO_DC": "IT",
+    "IT_BRNN": "IT",
+    "IT_CNOR": "IT",
+    "IT_CSUD": "IT",
+    "IT_FOGN": "IT",
+    "IT_GR": "IT",
+    "IT_MACRO_NORTH": "IT",
+    "IT_MACRO_SOUTH": "IT",
+    "IT_MALTA": "IT",
+    "IT_NORD": "IT",
+    "IT_NORD_AT": "IT",
+    "IT_NORD_CH": "IT",
+    "IT_NORD_FR": "IT",
+    "IT_NORD_SI": "IT",
+    "IT_PRGP": "IT",
+    "IT_ROSN": "IT",
+    "IT_SARD": "IT",
+    "IT_SICI": "IT",
+    "IT_SUD": "IT",
+    "RU_KGD": "RU",
+    "LV": "LV",
+    "LT": "LT",
+    "LU": "LU",
+    "LU_BZN": "LU",
+    "MT": "MT",
+    "ME": "ME",
+    "GB": "GB",
+    "GE": "GE",
+    "GB_IFA": "GB",
+    "GB_IFA2": "GB",
+    "GB_ELECLINK": "GB",
+    "UK": "UK",
+    "NL": "NL",
+    "NO_1": "NO",
+    "NO_1A": "NO",
+    "NO_2": "NO",
+    "NO_2_NSL": "NO",
+    "NO_2A": "NO",
+    "NO_3": "NO",
+    "NO_4": "NO",
+    "NO_5": "NO",
+    "NO": "NO",
+    "PL_CZ": "PL",
+    "PL": "PL",
+    "PT": "PT",
+    "MD": "MD",
+    "RO": "RO",
+    "RU": "RU",
+    "SE_1": "SE",
+    "SE_2": "SE",
+    "SE_3": "SE",
+    "SE_4": "SE",
+    "RS": "RS",
+    "SK": "SK",
+    "SI": "SI",
+    "GB_NIR": "GB",
+    "ES": "ES",
+    "SE": "SE",
+    "CH": "CH",
+    "DE_TENNET": "DE",
+    "DE_TRANSNET": "DE",
+    "TR": "TR",
+    "UA": "UA",
+    "UA_DOBTPP": "UA",
+    "UA_BEI": "UA",
+    "UA_IPS": "UA",
+    "XK": "XK",
+    "DE_AMP_LU": "DE",
+}

openstef/feature_engineering/holiday_features.py

@@ -14,7 +14,7 @@ HOLIDAY_CSV_PATH: str = PROJECT_ROOT / "openstef" / "data" / "dutch_holidays.csv
 
 
 def generate_holiday_feature_functions(
-    country: str = "NL",
+    country_code: str = "NL",
     years: list = None,
     path_to_school_holidays_csv: str = HOLIDAY_CSV_PATH,
 ) -> dict:
@@ -69,7 +69,7 @@ def generate_holiday_feature_functions(
             now.year + 1,
         ]
 
-    country_holidays = holidays.country_holidays(country, years=years)
+    country_holidays = holidays.country_holidays(country_code, years=years)
 
     # Make holiday function dict
     holiday_functions = {}
@@ -96,7 +96,7 @@ def generate_holiday_feature_functions(
 
         # Check for bridge day
         holiday_functions, bridge_days = check_for_bridge_day(
-            date, holiday_name, country, years, holiday_functions, bridge_days
+            date, holiday_name, country_code, years, holiday_functions, bridge_days
         )
 
     # Add feature function that includes all bridgedays
@@ -104,33 +104,42 @@ def generate_holiday_feature_functions(
         {"is_bridgeday": lambda x: np.isin(x.index.date, np.array(list(bridge_days)))}
     )
 
-    # Manully generated csv including all dutch schoolholidays for different regions
-    df_holidays = pd.read_csv(path_to_school_holidays_csv, index_col=None)
-    df_holidays["datum"] = pd.to_datetime(df_holidays.datum).apply(lambda x: x.date())
-
-    # Add check function that includes all holidays of the provided csv
-    holiday_functions.update(
-        {"is_schoolholiday": lambda x: np.isin(x.index.date, df_holidays.datum.values)}
-    )
-
-    # Loop over list of holidays names
-    for holiday_name in list(set(df_holidays.name)):
-        # Define function explicitely to mitigate 'late binding' problem
-        def make_holiday_func(holidayname=holiday_name):
-            return lambda x: np.isin(
-                x.index.date, df_holidays.datum[df_holidays.name == holidayname].values
-            )
+    # Add school holidays if country is NL
+    if country_code == "NL":
+        # Manully generated csv including all dutch schoolholidays for different regions
+        df_holidays = pd.read_csv(path_to_school_holidays_csv, index_col=None)
+        df_holidays["datum"] = pd.to_datetime(df_holidays.datum).apply(
+            lambda x: x.date()
+        )
 
-        # Create lag function for each holiday
+        # Add check function that includes all holidays of the provided csv
         holiday_functions.update(
             {
-                "is_"
-                + holiday_name.replace(" ", "_").lower(): make_holiday_func(
-                    holidayname=holiday_name
+                "is_schoolholiday": lambda x: np.isin(
+                    x.index.date, df_holidays.datum.values
                 )
             }
         )
 
+        # Loop over list of holidays names
+        for holiday_name in list(set(df_holidays.name)):
+            # Define function explicitely to mitigate 'late binding' problem
+            def make_holiday_func(holidayname=holiday_name):
+                return lambda x: np.isin(
+                    x.index.date,
+                    df_holidays.datum[df_holidays.name == holidayname].values,
+                )
+
+            # Create lag function for each holiday
+            holiday_functions.update(
+                {
+                    "is_"
+                    + holiday_name.replace(" ", "_").lower(): make_holiday_func(
+                        holidayname=holiday_name
+                    )
+                }
+            )
+
     return holiday_functions
 
 

openstef/validation/validation.py

@@ -244,7 +244,7 @@ def detect_ongoing_zero_flatliner(
     """
     # remove all timestamps in the future
     load = load[load.index.tz_localize(None) <= datetime.utcnow()]
-    latest_measurement_time = load.index.max()
+    latest_measurement_time = load.dropna().index.max()
     latest_measurements = load[
         latest_measurement_time - timedelta(minutes=duration_threshold_minutes) :
     ].dropna()

{openstef-3.4.40.dist-info → openstef-3.4.43.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openstef
-Version: 3.4.40
+Version: 3.4.43
 Summary: Open short term energy forecaster
 Home-page: https://github.com/OpenSTEF/openstef
 Author: Alliander N.V

{openstef-3.4.40.dist-info → openstef-3.4.43.dist-info}/RECORD

@@ -1,7 +1,7 @@
 openstef/__init__.py,sha256=93UM6m0LLQhO69-mSqLuUy73jgs4W7Iuxfo3Lm8c98g,419
 openstef/__main__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/app_settings.py,sha256=EJTDtimctFQQ-3f7ZcOQaRYohpZk3JD6aZBWPFYM2_A,582
-openstef/enums.py,sha256=dqwQUn09b-lsQ6BXhL_s_WzPxVDOPO27kQHzuQIeBG8,673
+openstef/enums.py,sha256=Wmoag2p7G2cvENA1qt8FcVbAgo-MswXKxmq7vkxHaxs,2680
 openstef/exceptions.py,sha256=U4u2LTcdT6cmzpipT2Jh7kq9nCjT_-6gntn8yjuhGU0,1993
 openstef/settings.py,sha256=nSgkBqFxuqB3w7Rwo60i8j37c5ngDbt6vpjHS6QtJXQ,354
 openstef/data/dutch_holidays.csv,sha256=Cg8EYjXp1O0lcFOkIOmrS5HaOArrxZwOXsZ9pVkIcKI,49847
@@ -15,15 +15,16 @@ openstef/data/dazls_model_3.4.24/dazls_stored_3.4.24_model_card.md.license,sha25
 openstef/data_classes/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/data_classes/data_prep.py,sha256=gRSL7UiHvZis8m8z7VoTCZc0Ccffhef5_hmSyApnqK0,3417
 openstef/data_classes/model_specifications.py,sha256=Uod1W3QzhRqVLb6zvXwxh9wRL3EHCzSvX0oDNd28cFk,1197
-openstef/data_classes/prediction_job.py,sha256=tE3K8QCDasXh0ESOBvMgJ3yI_noS6Uz7jU0sSDdt_us,5232
+openstef/data_classes/prediction_job.py,sha256=oVgk6rTC8IYYIGpEuaZHPi01l7gomQQ--BHlixj0Eb0,5496
 openstef/data_classes/split_function.py,sha256=ljQIQQu1t1Y_CVWGAy25jrM6wG9odIVVQVimrT1n-1s,3358
 openstef/feature_engineering/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
-openstef/feature_engineering/apply_features.py,sha256=-3fyisOVj9ckIkRe2iYfWutbXSX8iqBkcvt8AYr-gmE,3906
+openstef/feature_engineering/apply_features.py,sha256=AgIFnfud55vj0UUWJYwrMTjUzFCBxpV5ACaUK21-ZUo,4451
+openstef/feature_engineering/bidding_zone_to_country_mapping.py,sha256=u9aabjFDImydkO6_cXiaQxBT4gb5zy0gGTg2EoIUO_Y,2106
 openstef/feature_engineering/data_preparation.py,sha256=htca9LBO3ZN1D-iX4vXf0UN1fw_rRO7y6N3AuYVMpfk,5628
 openstef/feature_engineering/feature_adder.py,sha256=aSqDl_gUrB3H2TD3cNvU5JniY_KOb4u4a2A6J7zB2BQ,6835
 openstef/feature_engineering/feature_applicator.py,sha256=DR7jayrEMlra4BFL1Ps5WV2fxbkQ6VaOTa5RIKM-YNk,7447
 openstef/feature_engineering/general.py,sha256=tgU4_1stag9jJmaQAfWCMhfBscznVuQvW5hPK_z9_9g,4438
-openstef/feature_engineering/holiday_features.py,sha256=e4BfS4Wrd3sn_SeXh8F1tL1JNu99oa2smSJJiejcrIw,7891
+openstef/feature_engineering/holiday_features.py,sha256=q_wJvKaVUd54GjPo3qEt1No_XsQ9d1oNmNNJD3AIHtE,8181
 openstef/feature_engineering/lag_features.py,sha256=Dr6qS8UhdgEHPZZSe-w6ibtjl_lcbcQohhqdZN9fqEU,5652
 openstef/feature_engineering/missing_values_transformer.py,sha256=o_zCVEOCPn2tWzvlY44XZuDysV0TuxqeVYhilYU54YY,5010
 openstef/feature_engineering/weather_features.py,sha256=Lr9DItyHvJ2CpWQ1r6A83tJKtR2k_Wwn32FdFTGblO0,15750
@@ -87,9 +88,9 @@ openstef/tasks/utils/dependencies.py,sha256=Jy9dtV_G7lTEa5Cdy--wvMxJuAb0adb3R0X4
 openstef/tasks/utils/predictionjobloop.py,sha256=Ysy3zF5lzPMz_asYDKeF5m0qgVT3tCtwSPihqMjnI5Q,9580
 openstef/tasks/utils/taskcontext.py,sha256=L9K14ycwgVxbIVUjH2DIn_QWbnu-OfxcGtQ1K9T6sus,5630
 openstef/validation/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
-openstef/validation/validation.py,sha256=628xaDbAm8B4AYtFOAn8_SXLjejNfULGCfX3hVf_mU0,11119
-openstef-3.4.40.dist-info/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
-openstef-3.4.40.dist-info/METADATA,sha256=dKNS74MnfUzR7VgZuCpHzNSGxioEEgbr2Gkv7Cb60Wg,8068
-openstef-3.4.40.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-openstef-3.4.40.dist-info/top_level.txt,sha256=kD0H4PqrQoncZ957FvqwfBxa89kTrun4Z_RAPs_HhLs,9
-openstef-3.4.40.dist-info/RECORD,,
+openstef/validation/validation.py,sha256=HVgreHvcZvPazfwC3NNE8_3lsMsZEd_42osCAg1_6W4,11128
+openstef-3.4.43.dist-info/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
+openstef-3.4.43.dist-info/METADATA,sha256=L2J9ATvIMBE06--ITAksEWnqGYNZr5T-oODgLroNZFw,8068
+openstef-3.4.43.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+openstef-3.4.43.dist-info/top_level.txt,sha256=kD0H4PqrQoncZ957FvqwfBxa89kTrun4Z_RAPs_HhLs,9
+openstef-3.4.43.dist-info/RECORD,,

{openstef-3.4.40.dist-info → openstef-3.4.43.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any