kyoslib_py 4.0.1__tar.gz

kyoslib_py-4.0.1/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 KYOS Energy Analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kyoslib_py-4.0.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: kyoslib-py
+Version: 4.0.1
+Summary: KYOS shared lib code as python package
+Home-page: http://github.com/kyosenergy/kyoslib_py
+License: MIT
+Author: KYOS
+Author-email: support@kyos.com
+Requires-Python: >=3.7,<3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Requires-Dist: h5py (>=3.6.0,<4.0.0)
+Requires-Dist: numba (==0.56.4)
+Requires-Dist: numpy (<1.22.1)
+Requires-Dist: pandas (<1.5.3)
+Requires-Dist: plotly (>=5.7.0,<6.0.0)
+Requires-Dist: requests (>=2.28.1,<3.0.0)
+Project-URL: Documentation, https://kyosenergy.github.io/kyoslib_py/
+Project-URL: Repository, http://github.com/kyosenergy/kyoslib_py
+Description-Content-Type: text/markdown
+
+# kyoslib_py
+
+## Usage
+
+Example code:
+
+```python
+from kyoslib_py.simulation import Simulation
+simulation_set = Simulation()
+```
+
+## Installation
+
+```pip install kyoslib_py -extra-index-url https://pypi.fury.io/kyos/```
+
+## Dependencies
+
+Python 3.7+
+
+## Development
+
+This project is executing CI checks using **GitHub actions**.
+
+It will run `pytest` and `black`.
+
+### Invoking development tasks
+
+[Invoke](https://www.pyinvoke.org/) is used for development tasks.
+
+Tasks are stored in `tasks.py` and are executable using the `inv[oke]` command line tool.
+
+To see the list of tasks, you can type:
+
+```bash
+inv --list
+```
+
+For example, before your commits, you should run
+```bash
+inv format
+```
+to format your code.
+
+## Documentation
+
+The package documentation is generated by MkDocs. The correct version can be installed in the project's virtual environment by:
+
+```bash
+poetry install
+```
+
+Then the documentation can be built, and a server to view it started by:
+
+```bash
+mkdocs serve
+```
+

kyoslib_py-4.0.1/README.md

@@ -0,0 +1,56 @@
+# kyoslib_py
+
+## Usage
+
+Example code:
+
+```python
+from kyoslib_py.simulation import Simulation
+simulation_set = Simulation()
+```
+
+## Installation
+
+```pip install kyoslib_py -extra-index-url https://pypi.fury.io/kyos/```
+
+## Dependencies
+
+Python 3.7+
+
+## Development
+
+This project is executing CI checks using **GitHub actions**.
+
+It will run `pytest` and `black`.
+
+### Invoking development tasks
+
+[Invoke](https://www.pyinvoke.org/) is used for development tasks.
+
+Tasks are stored in `tasks.py` and are executable using the `inv[oke]` command line tool.
+
+To see the list of tasks, you can type:
+
+```bash
+inv --list
+```
+
+For example, before your commits, you should run
+```bash
+inv format
+```
+to format your code.
+
+## Documentation
+
+The package documentation is generated by MkDocs. The correct version can be installed in the project's virtual environment by:
+
+```bash
+poetry install
+```
+
+Then the documentation can be built, and a server to view it started by:
+
+```bash
+mkdocs serve
+```

kyoslib_py-4.0.1/kyoslib_py/forward_curve.py

@@ -0,0 +1,192 @@
+import os
+
+import pandas as pd
+
+from kyoslib_py.kyos_api import call_kyos_api_v1
+
+
+def write_curve_to_csv(curves, delTypes, grID, fullFileName):
+    """Stores the forward curves in generalized data format on the disk in ./ForwardCurves directory
+
+    Args:
+        curves (dict): HTTP response body which provided by kyos_api.call_kyos_api_v1
+        delTypes (list): baseload:1, peak:2, offpeak:3
+        grID (int): granularity id of the requested forward curve(e.g. half-hour:1, hour:2, day:3, month:5)
+        fullFileName (str): full path of the file(e.g. "./ForwardCurves/ForwardCurveDaily_2_20200101")
+
+    Note:
+        The current implementation allows to store only data based on monthly granularity.
+
+    Example:
+        >>> from kyoslib_py.forward_curve import write_curve_to_csv
+        >>> curves = {}
+        >>> data = {}
+        >>> month = {}
+        >>> baseload = [{'date':'2020-01-01', 'value':20.2}, {'date':'2020-02-01', 'value':30.3}]
+        >>> month['baseload'] = baseload
+        >>> data['month'] = month
+        >>> curves['data'] = data
+        >>> write_curve_to_csv(curves, [1, 2, 3], 5, "./ForwardCurves/ForwardCurveMonthlyDeliveryTypes_2_20200101")
+    """
+
+    if grID == 1:  # half-hourly
+        return
+    elif grID == 2:  # hourly
+        return
+    elif grID == 3:  # daily
+        return
+    elif grID == 5:  # monthly
+        curves_df = pd.DataFrame()
+        numDelType = len(delTypes)
+        # read dates from base load and store in the table, column name should be "0" for the date column
+        curves_df['0'] = [x['date'] for x in curves['data']['month']['baseload']]
+
+        for i in range(numDelType):
+
+            if delTypes[i] == 1:
+                curves_df[str(delTypes[i])] = [
+                    x['value'] for x in curves['data']['month']['baseload']
+                ]
+            elif delTypes[i] == 2:
+                curves_df[str(delTypes[i])] = [
+                    x['value'] for x in curves['data']['month']['peakload']
+                ]
+            elif delTypes[i] == 3:
+                curves_df[str(delTypes[i])] = [
+                    x['value'] for x in curves['data']['month']['offpeak']
+                ]
+        # write monthly curves to csv
+        curves_df.to_csv(fullFileName, index=False)
+    return
+
+
+def get_curve_api(fwdCurveID, granularityID, deliveryTypes, tradingDates, isCSVWrite):
+    """Performs API requests to KYOS API and stores the curve inputs in a generalized format in CSV files or
+    returns a pandas.DataFrame
+
+    Args:
+        fwdCurveID (int): id of the curve profile
+        granularityID (int): half-hour:1, hour:2, day:3, month:5
+        deliveryTypes (list or int): list of delivery type ids(int array), base load:1, peak:2, off-peak:3
+        tradingDates (list): list of trading dates(string array) e.g. ['2019-01-01', '2019-01-02', '2019-01-03']
+        isCSVWrite (bool): indicator of creating csv files, 0 or 1, we will provide  a DataFrame in case of zero.
+
+    Returns:
+        (pandas.DataFrame): Contains all requested curves. If isCSVWrite equals 1 then the dataframe will be empty and
+        the curves will be saved as CSV files on the disk in directory ./ForwardCurves.
+
+    Note:
+        The current implementation allows to read only data based on monthly granularity.
+        KYOS API provides the curves with the daylight saving switches for the half-hourly and hourly curves.
+        KYOS API supports base load, peak and off-peak delivery types.
+
+    Example:
+        >>> from kyoslib_py.forward_curve import get_curve_api
+        >>> arg = {'fwdCurveID': 4, 'granularityID': 5, 'deliveryTypes': [1, 2, 3],
+        >>>        'tradingDates': ['2019-01-01', '2019-01-02'], 'isCSVWrite': 1}
+        >>> curves_df = get_curve_api(**arg)
+        >>> arg = {'fwdCurveID': 4, 'granularityID': 5, 'deliveryTypes': 1 ,
+        >>>        'tradingDates': '2019-01-01', 'isCSVWrite': 1}
+        >>> curves_df2 = get_curve_api(**arg)
+    """
+    # Initialize output directory
+    curDir = os.getcwd()
+    outputDir = os.path.join(curDir, 'ForwardCurves')
+    if isCSVWrite and (not os.path.exists(outputDir)):
+        os.mkdir(outputDir)
+    forward_curves_df = pd.DataFrame()
+    # ################################################# INPUT VALIDATION ###########################################
+    # Check the granularity input
+    if granularityID == 1:
+        fileName = f"ForwardCurveHalfHourlyDST_{fwdCurveID}_"
+        granularity = 'half_hour'
+        print('The function does not support reading of the ' + granularity + ' curves !!!')
+        return forward_curves_df
+    elif granularityID == 2:
+        fileName = f"ForwardCurveHourlyDST_{fwdCurveID}_"
+        granularity = 'hour'
+        print('The function does not support reading of the ' + granularity + ' curves !!!')
+        return forward_curves_df
+    elif granularityID == 3:
+        fileName = f"ForwardCurveDaily_{fwdCurveID}_"
+        granularity = 'day'
+        print('The function does not support reading of the ' + granularity + ' curves !!!')
+        return forward_curves_df
+    elif granularityID == 5:
+        fileName = f"ForwardCurveMonthlyDeliveryTypes_{fwdCurveID}_"
+        granularity = 'month'
+    else:
+        print('The granularity id:' + str(granularityID) + ' is not supported in KYOS API!!!')
+        return forward_curves_df
+    # in case of empty delivery type after the cleaning process, initialize base load in the list
+    if deliveryTypes is None:
+        deliveryTypes = [1]
+
+    # Check the delivery type input, deliveryTypes should be a list
+    if type(deliveryTypes) != list:
+        deliveryTypes = [deliveryTypes]
+    if len(deliveryTypes) == 0:
+        deliveryTypes.append(1)  # in case of empty delivery type list, import the base load curve
+    else:
+        # remove the unsupported delivery types from the list
+        deliveryTypes = [
+            deliveryTypes for deliveryTypes in deliveryTypes if deliveryTypes in [1, 2, 3]
+        ]
+
+    # Check tradingDates, it should be provided as a list
+    if type(tradingDates) != list:
+        tradingDates = [tradingDates]
+
+    # ########################################### IMPORT CURVES #######################################################
+    numTradDays = tradingDates.__len__()
+    for i in range(numTradDays):
+        tradingDate_i = tradingDates[i]
+        query = f"/curves/results/{fwdCurveID}/{tradingDate_i}?filter[granularity]={granularity}"
+
+        status, data = call_kyos_api_v1(query)
+        if 200 >= status < 300:
+            print(query + ' Imported!')
+            if isCSVWrite == 1:  # in this case, we will store the curves on disk per trading dates
+                fullName = os.path.join(
+                    outputDir, f"{fileName}{tradingDate_i.replace('-', '')}.csv"
+                )
+                write_curve_to_csv(data, deliveryTypes, granularityID, fullName)
+            else:  # in this case, we will store the curves in a dataframe
+                if granularityID == 1:  # half-hourly
+                    return
+                elif granularityID == 2:  # hourly
+                    return
+                elif granularityID == 3:  # daily
+                    return
+                elif granularityID == 5:  # monthly
+                    curves_df_i = pd.DataFrame()
+                    numDelType = len(deliveryTypes)
+                    # update curve id and trading dates column
+                    numMonths = data['data']['month']['baseload'].__len__()
+                    curves_df_i['curve_id'] = [fwdCurveID for _ in range(numMonths)]
+                    curves_df_i['trading_dates'] = [tradingDate_i for _ in range(numMonths)]
+
+                    # read dates from base load and store in the table as delivery dates
+                    curves_df_i['delivery_dates'] = [
+                        x['date'] for x in data['data']['month']['baseload']
+                    ]
+                    for i in range(numDelType):
+
+                        if deliveryTypes[i] == 1:
+                            curves_df_i['baseload'] = [
+                                x['value'] for x in data['data']['month']['baseload']
+                            ]
+                        elif deliveryTypes[i] == 2:
+                            curves_df_i['peak'] = [
+                                x['value'] for x in data['data']['month']['peakload']
+                            ]
+                        elif deliveryTypes[i] == 3:
+                            curves_df_i['offpeak'] = [
+                                x['value'] for x in data['data']['month']['offpeak']
+                            ]
+
+                    forward_curves_df = pd.concat([forward_curves_df, curves_df_i])
+        else:
+            print(query + ' could not be imported!')
+
+    return forward_curves_df