eptr2 1.2.0.dev0__tar.gz → 1.2.1.dev0__tar.gz

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/.gitignore

@@ -164,4 +164,4 @@ data/
 runs/
 .vscode/
 helpdocs/
-creds/
+creds/.env

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eptr2
-Version: 1.2.0.dev0
+Version: 1.2.1.dev0
 Summary: EPIAS Transparency Platform v2.0 Python client by Robokami Data
 Author-email: Tideseed <info@tideseed.com>
 License: Apache License 2.0
@@ -253,10 +253,8 @@ df = get_day_ahead_and_bilateral_matches(eptr=eptr,start_date="2023-01-01", end_
 df2 = get_day_ahead_detail_info(
     eptr=eptr, start_date="2023-01-01", end_date="2023-01-31", verbose=True
 )
-
 ```
 
-
 #### Balancing Power Market Data
 
 ```python
@@ -276,3 +274,24 @@ df2 = get_bpm_period(
 )
 ```
 
+#### Plant Costs
+
+```python
+from eptr2 import EPTR2
+from eptr2.composite import gather_and_calculate_plant_costs
+
+eptr = EPTR2(credentials_file_path="creds/eptr_credentials.json")
+
+df = gather_and_calculate_plant_costs(
+    eptr=eptr,
+    start_date="2023-01-01",
+    end_date="2023-01-31",
+    pp_id=120,  ## BOZCAADA RES
+    org_id=195,  ## EÜAŞ
+    uevcb_id=3204384,  ## BOZCAADA RES
+    plant_type="wind",
+    verbose=True,
+    forecast_source = "kgup",
+    actual_source = "uevm"
+)
+```

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/README.md

@@ -231,10 +231,8 @@ df = get_day_ahead_and_bilateral_matches(eptr=eptr,start_date="2023-01-01", end_
 df2 = get_day_ahead_detail_info(
     eptr=eptr, start_date="2023-01-01", end_date="2023-01-31", verbose=True
 )
-
 ```
 
-
 #### Balancing Power Market Data
 
 ```python
@@ -254,3 +252,24 @@ df2 = get_bpm_period(
 )
 ```
 
+#### Plant Costs
+
+```python
+from eptr2 import EPTR2
+from eptr2.composite import gather_and_calculate_plant_costs
+
+eptr = EPTR2(credentials_file_path="creds/eptr_credentials.json")
+
+df = gather_and_calculate_plant_costs(
+    eptr=eptr,
+    start_date="2023-01-01",
+    end_date="2023-01-31",
+    pp_id=120,  ## BOZCAADA RES
+    org_id=195,  ## EÜAŞ
+    uevcb_id=3204384,  ## BOZCAADA RES
+    plant_type="wind",
+    verbose=True,
+    forecast_source = "kgup",
+    actual_source = "uevm"
+)
+```

eptr2-1.2.1.dev0/creds/eptr_credentials.json

@@ -0,0 +1,9 @@
+{
+    "EPTR_USERNAME": "berk.orbay@tideseed.com",
+    "EPTR_PASSWORD": "TDSD!S3ffaf2",
+    "tgt_d": {
+        "tgt": "TGT-2550194--Z6WQIsu7keXmLbbKdIspChHBqJprLfR-dcCthsnUJGBaVO-p-XM3E0W1eNiPfjYdyM-cas-7dc76c888-gmdxk",
+        "tgt_exp": 1753043389.532092,
+        "tgt_exp_0": 1753043389.532092
+    }
+}

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/eptr2/composite/__init__.py

@@ -5,3 +5,4 @@ from eptr2.composite.dabi_idm import *
 from eptr2.composite.bpm import *
 from eptr2.composite.idm_log import *
 from eptr2.composite.mms import *
+from eptr2.composite.plant_costs import *

eptr2-1.2.1.dev0/eptr2/composite/plant_costs.py

@@ -0,0 +1,142 @@
+from eptr2 import EPTR2
+import pandas as pd
+from eptr2.composite.production import wrapper_hourly_production_plan_and_realized
+from eptr2.composite.price_and_cost import get_hourly_price_and_cost_data
+from eptr2.util.costs import calculate_kupsm, get_kupst_tolerance
+from typing import Literal
+
+
+def postprocess_plant_cost_df(df: pd.DataFrame):
+    df["cumulative_kupst_cost"] = df["total_kupst_cost"].cumsum()
+    df["cumulative_imb_cost"] = df["total_imb_cost"].cumsum()
+    df["cumulative_total_cost"] = df["total_cost"].cumsum()
+
+    d = {
+        "total_forecast": df["forecast"].sum(),
+        "total_actual": df["actual"].sum(),
+        "total_kupsm": df["kupsm"].sum(),
+        "total_bias": df["diff"].sum(),
+        "total_mae": df["diff"].abs().sum(),
+        "total_kupst_cost": df["total_kupst_cost"].sum(),
+        "total_imb_cost": df["total_imb_cost"].sum(),
+        "total_cost": df["total_cost"].sum(),
+    }
+
+    return {"summary": d, "data": df}
+
+
+def gather_and_calculate_plant_costs(
+    eptr: EPTR2,
+    start_date: str,
+    end_date: str,
+    pp_id: int | str,
+    org_id: int | str,
+    uevcb_id: int | str,
+    plant_type: str,
+    forecast_source: Literal["kgup_v1", "kgup", "kudup"] = "kudup",
+    actual_source: Literal["rt", "uevm"] = "uevm",
+    verbose=False,
+    timeout=5,
+    postprocess: bool = False,
+    **kwargs,
+):
+    """
+    For a given power plant and selected forecast and actual production sources, this function gathers data and calculates imbalance and kupst costs.
+
+    Example usage:
+    pp_id=120,  ## BOZCAADA RES
+    org_id=195,  ## EÜAŞ
+    uevcb_id=3204384,  ## BOZCAADA RES
+    plant_type="wind",
+    """
+
+    ### Regulate skips
+    params = dict(
+        skip_kgup=True,
+        skip_kgup_v1=True,
+        skip_kudup=True,
+        skip_uevm=True,
+        skip_rt=True,
+    )
+
+    params[f"skip_{forecast_source}"] = False
+    params[f"skip_{actual_source}"] = False
+
+    ### Regulate ids
+    if actual_source == "rt":
+        params["rt_pp_id"] = pp_id
+        params["uevm_pp_id"] = None
+    else:
+        params["rt_pp_id"] = None
+        params["uevm_pp_id"] = pp_id
+
+    df = wrapper_hourly_production_plan_and_realized(
+        eptr=eptr,
+        start_date=start_date,
+        end_date=end_date,
+        verbose=verbose,
+        include_contract_symbol=True,
+        org_id=org_id,
+        uevcb_id=uevcb_id,
+        timeout=timeout,
+        **params,
+        **kwargs,
+    )
+
+    cost_df = get_hourly_price_and_cost_data(
+        eptr=eptr,
+        start_date=start_date,
+        end_date=end_date,
+        verbose=verbose,
+        include_contract_symbol=True,
+        include_wap=False,
+        timeout=timeout,
+    )
+
+    #### Merge and calculate costs
+    prod_df = (
+        df[["dt", "contract", f"toplam_{forecast_source}", f"total_{actual_source}"]]
+        .rename(
+            columns={
+                f"toplam_{forecast_source}": "forecast",
+                f"total_{actual_source}": "actual",
+            }
+        )
+        .copy()
+    )
+
+    prod_df["diff"] = prod_df["forecast"] - prod_df["actual"]
+
+    merged_df = prod_df.merge(
+        cost_df.rename(columns={"date": "dt"})[
+            ["dt", "pos_imb_cost", "neg_imb_cost", "kupst_cost"]
+        ],
+        on="dt",
+        how="inner",
+    )
+
+    ## Calculate kupsm and costs
+    kupst_tolerance = get_kupst_tolerance(plant_type)
+    merged_df["kupsm"] = merged_df.apply(
+        lambda row: calculate_kupsm(
+            actual=row["actual"], forecast=row["forecast"], tol=kupst_tolerance
+        ),
+        axis=1,
+    )
+
+    ### Calculate total costs
+    merged_df["total_kupst_cost"] = merged_df["kupsm"] * merged_df["kupst_cost"]
+    merged_df["total_imb_cost"] = merged_df.apply(
+        lambda row: (row["pos_imb_cost"] if row["diff"] < 0 else row["neg_imb_cost"])
+        * abs(row["diff"]),
+        axis=1,
+    )
+    merged_df["total_cost"] = (
+        merged_df["total_kupst_cost"] + merged_df["total_imb_cost"]
+    )
+
+    if postprocess:
+        d = postprocess_plant_cost_df(merged_df)
+        return d
+
+    return merged_df

eptr2-1.2.1.dev0/eptr2/composite/production.py

@@ -0,0 +1,376 @@
+from eptr2 import EPTR2
+import pandas as pd
+from eptr2.util.time import (
+    iso_to_contract,
+    check_date_for_settlement,
+)
+import time
+
+
+def get_hourly_production_data(
+    eptr: EPTR2,
+    start_date: str,
+    end_date: str,
+    rt_pp_id: str | int | None = None,
+    uevm_pp_id: str | int | None = None,
+    verbose: bool = False,
+    include_contract_symbol: bool = True,
+    skip_uevm: bool = False,
+    skip_rt: bool = False,
+    **kwargs,
+):
+    """
+    This composite function gets production data (Gerçek Zamanlı Üretim, UEVM) and merges them.
+
+    It is also possible to enter pp_id to get the production data for a specific production plan. Example ID values are given below.
+
+    rt_pp_id=641, ## ATATÜRK HES
+    uevm_pp_id=142, ## ATATÜRK HES
+    """
+
+    max_trials = kwargs.get("max_trials", 2)
+    timeout = kwargs.get("timeout", 5)
+    sleep_interval = kwargs.get("sleep_interval", 3)
+
+    #### SANITY CHECKS ####
+    if skip_rt and skip_uevm:
+        raise ValueError("Both skip_rt and skip_uevm cannot be True.")
+
+    #### REAL TIME GENERATION PHASE ####
+    if skip_rt:
+        rt_included = False
+        rt_gen_df = pd.DataFrame()
+
+    else:
+        rt_included = True
+        if verbose:
+            print("Loading real time production data...")
+
+        trials = max_trials
+        while trials > 0:
+            try:
+                rt_gen_df: pd.DataFrame = eptr.call(
+                    "rt-gen",
+                    start_date=start_date,
+                    end_date=end_date,
+                    pp_id=rt_pp_id,
+                    request_kwargs={"timeout": timeout},
+                )
+                break
+            except Exception as e:
+                trials -= 1
+
+                if trials == 0:
+                    raise e
+
+                time.sleep(sleep_interval)
+                if verbose:
+                    print(
+                        f"An error occurred while fetching RT data. Retrying after {sleep_interval} seconds... ({trials} attempts left)"
+                    )
+
+        if rt_gen_df.empty:
+            raise ValueError("No data (production) is available for this date range.")
+
+        try:
+            rt_gen_df.drop("hour", axis=1, inplace=True)
+        except Exception as e:
+            if verbose:
+                print(e)
+
+        rt_gen_df.columns = [
+            x + "_rt" if x not in ["date"] else x for x in rt_gen_df.columns
+        ]
+
+    #### UEVM PHASE ####
+    if skip_uevm:
+        uevm_included = False
+        uevm_df = pd.DataFrame()
+
+    else:
+        uevm_included = True
+        if verbose:
+            print("Loading UEVM data...")
+
+        trials = max_trials
+        while trials > 0:
+            try:
+                uevm_df: pd.DataFrame = eptr.call(
+                    "uevm",
+                    start_date=start_date,
+                    end_date=end_date,
+                    pp_id=uevm_pp_id,
+                    request_kwargs={"timeout": timeout},
+                )
+                break
+            except Exception as e:
+                trials -= 1
+                if trials == 0:
+                    raise e
+
+                time.sleep(sleep_interval)
+                if verbose:
+                    print(
+                        f"An error occurred while fetching UEVM data. Retrying after {sleep_interval} seconds... ({trials} attempts left)"
+                    )
+
+        try:
+            uevm_df.drop("hour", axis=1, inplace=True)
+        except Exception as e:
+            within_settlement = check_date_for_settlement(x=end_date)
+            if not within_settlement:
+                print("Warning: The end date may not be within the settlement period.")
+            if verbose:
+                print(e)
+
+        uevm_df.columns = [
+            x + "_uevm" if x not in ["date"] else x for x in uevm_df.columns
+        ]
+
+    if uevm_included and rt_included:
+        if verbose:
+            print("Merging data...")
+
+        if uevm_df.empty:
+            merged_df = rt_gen_df.copy()
+        else:
+            merged_df = rt_gen_df.merge(uevm_df, how="left", on=["date"])
+    elif uevm_included:
+        merged_df = uevm_df.copy()
+    elif rt_included:
+        merged_df = rt_gen_df.copy()
+
+    if include_contract_symbol:
+        try:
+            merged_df["contract"] = merged_df["date"].apply(
+                lambda x: iso_to_contract(x)
+            )
+        except Exception as e:
+            print("Contract information could not be added. Error:", e)
+
+    merged_df = merged_df.rename(columns={"date": "dt"})
+
+    return merged_df
+
+
+def get_hourly_production_plan_data(
+    eptr: EPTR2,
+    start_date: str,
+    end_date: str,
+    org_id: str | None = None,
+    uevcb_id: str | None = None,
+    verbose: bool = False,
+    include_contract_symbol: bool = True,
+    skip_kgup: bool = False,
+    skip_kgup_v1: bool = False,
+    skip_kudup: bool = False,
+    **kwargs,
+):
+    """
+    This composite function gets KGUP v1, KGUP and KUDUP data and merges them.
+
+    It is also possible to enter org_id to get the total production plan for a specific organization. If uevcb_id is also added with org_id, it will get the production plan for a specific uevcb. Example ID values are given below.
+
+    org_id=195, ## ELEKTRİK ÜRETİM AŞ
+    uevcb_id=733, ## ATATÜRK HES DB
+    """
+
+    max_trials = kwargs.get("max_trials", 2)
+    timeout = kwargs.get("timeout", 5)
+
+    if all([skip_kgup_v1, skip_kgup, skip_kudup]):
+        raise ValueError(
+            "At least one of skip_kgup, skip_kgupv1, or skip_kudup must be False."
+        )
+
+    if uevcb_id is not None:
+        if org_id is None:
+            raise ValueError("org_id is required if uevcb_id is specified.")
+
+    if not skip_kgup_v1:
+
+        if verbose:
+            print("Loading KGUP v1...")
+
+        trials = max_trials
+        while trials > 0:
+            try:
+                kgup_v1_df: pd.DataFrame = eptr.call(
+                    "kgup-v1",
+                    start_date=start_date,
+                    end_date=end_date,
+                    org_id=org_id,
+                    uevcb_id=uevcb_id,
+                    request_kwargs={"timeout": timeout},
+                )
+                break
+            except Exception as e:
+                trials -= 1
+                if trials == 0:
+                    raise e
+                if verbose:
+                    print(
+                        f"An error occurred while fetching KGUP v1 data. Retrying... ({trials} attempts left)"
+                    )
+
+        if kgup_v1_df.empty:
+            skip_kgup_v1 = True
+            print("No data (KGUP v1) is available for this date range.")
+        else:
+            kgup_v1_df.columns = [
+                x + "_kgup_v1" if x not in ["date", "time"] else x
+                for x in kgup_v1_df.columns
+            ]
+
+    if not skip_kgup:
+        if verbose:
+            print("Loading KGUP...")
+
+        trials = max_trials
+        while trials > 0:
+            try:
+                kgup_df: pd.DataFrame = eptr.call(
+                    "kgup",
+                    start_date=start_date,
+                    end_date=end_date,
+                    org_id=org_id,
+                    uevcb_id=uevcb_id,
+                    request_kwargs={"timeout": timeout},
+                )
+                break
+            except Exception as e:
+                trials -= 1
+                if trials == 0:
+                    raise e
+                if verbose:
+                    print(
+                        f"An error occurred while fetching KGUP data. Retrying... ({trials} attempts left)"
+                    )
+        if kgup_df.empty:
+            skip_kgup = True
+            print("No data (KGUP) is available for this date range.")
+        else:
+            kgup_df.columns = [
+                x + "_kgup" if x not in ["date", "time"] else x for x in kgup_df.columns
+            ]
+
+    if not skip_kudup:
+        if verbose:
+            print("Loading KUDUP...")
+
+        trials = max_trials
+        while trials > 0:
+            try:
+                kudup_df: pd.DataFrame = eptr.call(
+                    "kudup",
+                    start_date=start_date,
+                    end_date=end_date,
+                    org_id=org_id,
+                    uevcb_id=uevcb_id,
+                    request_kwargs={"timeout": timeout},
+                )
+                break
+            except Exception as e:
+                trials -= 1
+                if trials == 0:
+                    raise e
+                if verbose:
+                    print(
+                        f"An error occurred while fetching KUDUP data. Retrying... ({trials} attempts left)"
+                    )
+
+        if kudup_df.empty:
+            skip_kudup = True
+            print("No data (KUDUP) is available for this date range.")
+        else:
+            kudup_df.columns = [
+                x + "_kudup" if x not in ["date", "time"] else x
+                for x in kudup_df.columns
+            ]
+
+    #### MERGE PHASE ####
+    if verbose:
+        print("Merging dataframes...")
+
+    merged_df = None
+    for _ in ["kgup_v1", "kgup", "kudup"]:
+        if not eval(f"skip_{_}"):
+            if merged_df is None:
+                merged_df: pd.DataFrame = eval(f"{_}_df").copy()
+            else:
+                merged_df = merged_df.merge(
+                    eval(f"{_}_df"), on=["date", "time"], how="outer"
+                )
+
+    ### Column reordering and contract addition
+    if include_contract_symbol:
+        try:
+            merged_df["contract"] = merged_df["date"].apply(
+                lambda x: iso_to_contract(x)
+            )
+        except Exception as e:
+            print("Contract information could not be added. Error:", e)
+
+    merged_df = merged_df.rename(columns={"date": "dt"})
+
+    col_order = (
+        ["dt", "time"] + ["contract"]
+        if include_contract_symbol
+        else [] + [x for x in merged_df.columns if x.startswith("toplam")]
+    )
+
+    merged_df = merged_df[
+        col_order + [x for x in merged_df.columns if x not in col_order]
+    ]
+
+    return merged_df
+
+
+def wrapper_hourly_production_plan_and_realized(
+    eptr: EPTR2,
+    start_date: str,
+    end_date: str,
+    org_id: str | None = None,
+    uevcb_id: str | None = None,
+    rt_pp_id: str | None = None,
+    uevm_pp_id: str | None = None,
+    verbose: bool = False,
+    include_contract_symbol: bool = True,
+    **kwargs,
+):
+
+    if verbose:
+        print("Loading production plan data...")
+
+    plan_df = get_hourly_production_plan_data(
+        eptr=eptr,
+        start_date=start_date,
+        end_date=end_date,
+        org_id=org_id,
+        uevcb_id=uevcb_id,
+        verbose=verbose,
+        include_contract_symbol=include_contract_symbol,
+        **kwargs,
+    )
+
+    if verbose:
+        print("Loading production realizations data...")
+
+    realized_df = get_hourly_production_data(
+        eptr=eptr,
+        start_date=start_date,
+        end_date=end_date,
+        rt_pp_id=rt_pp_id,
+        uevm_pp_id=uevm_pp_id,
+        verbose=verbose,
+        include_contract_symbol=include_contract_symbol,
+        **kwargs,
+    )
+
+    merged_df = plan_df.merge(
+        realized_df,
+        how="outer",
+        on=["dt"] + (["contract"] if include_contract_symbol else []),
+    )
+
+    return merged_df

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/eptr2/mapping/help.py

@@ -743,6 +743,18 @@ def get_help_d(key=None):
             },
             "url": "https://seffaflik.epias.com.tr/electricity/electricity-generation/ex-post-generation/real-time-generation",
         },
+        "pp-list-for-date-range": {
+            "category": "Listeleme",
+            "title": {
+                "tr": "Santral Listeleme (Tarih Aralığı ile)",
+                "en": "Powerplant listing (with Date Range)",
+            },
+            "desc": {
+                "tr": "Santral Listeleme (Tarih Aralığı ile)",
+                "en": "Powerplant listing (with Date Range)",
+            },
+            "url": "https://seffaflik.epias.com.tr/electricity/electricity-generation/ex-post-generation/real-time-generation",
+        },
         "gen-org": {
             "category": "Listeleme",
             "title": {

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/eptr2/mapping/parameters.py

@@ -121,6 +121,7 @@ def get_required_parameters(key, return_mapping=False, mapping_only_keys=False):
         "load-plan": ["start_date", "end_date"],
         "rt-cons": ["start_date", "end_date"],
         "pp-list": [],
+        "pp-list-for-date-range": ["start_date", "end_date"],
         "uevm-pp-list": [],
         "ren-pp-list": ["period"],
         "ren-rt-gen": ["start_date", "end_date"],

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/eptr2/mapping/path.py

@@ -323,6 +323,12 @@ def get_path_map(just_call_keys: bool = False):
                 "prev": "generation",
                 "label": "powerplant-list",
             },
+            ##Tarih Araligina Gore Santral Listeleme Servisi
+            "pp-list-for-date-range": {
+                "prefix": "data",
+                "prev": "generation",
+                "label": "powerplant-list-for-date-range",
+            },
             ## Santral Listeleme
             "uevm-pp-list": {
                 "prefix": "data",
@@ -1132,6 +1138,7 @@ def get_call_method(key):
         "interim-mcp-status",
         "market-participants-organization-list",
         "pp-list",
+        # "pp-list-for-date-range", ## POST method
         "uevm-pp-list",
         "region-list",
         "mms-message-type-list",

{eptr2-1.2.0.dev0 → eptr2-1.2.1.dev0}/eptr2/mapping/processing.py

@@ -58,6 +58,7 @@ def get_postprocess_function(key):
         "gen-uevcb",
         "rt-gen",
         "pp-list",
+        "pp-list-for-date-range",
         "uevm-pp-list",
         "lic-pp-list",
         "load-plan",