eptr2 1.1.4.dev0__tar.gz → 1.2.1.dev0__tar.gz

eptr2-1.2.1.dev0/.gitignore

@@ -0,0 +1,167 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+**/.DS_Store
+data/
+runs/
+.vscode/
+helpdocs/
+creds/.env

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

@@ -1,25 +1,23 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: eptr2
-Version: 1.1.4.dev0
+Version: 1.2.1.dev0
 Summary: EPIAS Transparency Platform v2.0 Python client by Robokami Data
-License: Apache-2.0
-Author: Tideseed
-Author-email: info@tideseed.com
-Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
+Author-email: Tideseed <info@tideseed.com>
+License: Apache License 2.0
+License-File: LICENSE
+Requires-Python: !=3.9.7,>=3.9.6
+Requires-Dist: pytz>=2024.1
+Requires-Dist: urllib3==2.5.0
 Provides-Extra: allextras
+Requires-Dist: pandas>=2.1.3; extra == 'allextras'
+Requires-Dist: requests>=2.32.4; extra == 'allextras'
+Requires-Dist: streamlit>=1.48.0; extra == 'allextras'
+Requires-Dist: tornado>=6.5.0; extra == 'allextras'
 Provides-Extra: dataframe
-Requires-Dist: pandas (>=2.1.3) ; extra == "dataframe" or extra == "allextras"
-Requires-Dist: pytz (>=2024.1)
-Requires-Dist: requests (>=2.32.4) ; extra == "allextras"
-Requires-Dist: streamlit (>=1.48.0) ; extra == "allextras"
-Requires-Dist: tornado (>=6.5.0) ; extra == "allextras"
-Requires-Dist: urllib3 (==2.5.0)
+Requires-Dist: pandas>=2.1.3; extra == 'dataframe'
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: python-dotenv>=0.19.1; extra == 'dev'
 Description-Content-Type: text/markdown
 
 ![PyPI - Version](https://img.shields.io/pypi/v/eptr2) ![PyPI - Downloads](https://img.shields.io/pypi/dm/eptr2) 
@@ -28,6 +26,9 @@ Description-Content-Type: text/markdown
 
 This document is a quickstart guide for `eptr2` package. It is a Python client for [EPIAS Transparency Platform v2.0](https://seffaflik.epias.com.tr/home) API. It is an unofficial package with Apache License 2.0.
 
++ For live demo, please visit <https://eptr2demo.streamlit.app/>
++ For local demo, you can run `eptr2demo` at terminal after installing the library.
+
 ## Installation
 
 You can easily install it from PyPI with the following commmand.
@@ -252,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
@@ -275,4 +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.1.4.dev0 → eptr2-1.2.1.dev0}/README.md

@@ -4,6 +4,9 @@
 
 This document is a quickstart guide for `eptr2` package. It is a Python client for [EPIAS Transparency Platform v2.0](https://seffaflik.epias.com.tr/home) API. It is an unofficial package with Apache License 2.0.
 
++ For live demo, please visit <https://eptr2demo.streamlit.app/>
++ For local demo, you can run `eptr2demo` at terminal after installing the library.
+
 ## Installation
 
 You can easily install it from PyPI with the following commmand.
@@ -228,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
@@ -251,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.1.4.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