Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Each version includes a description of the Added, Changed, and Removed functionality.

[Unreleased]¶

[5.4.1] - 2025-09-16¶

Changed¶

In simulation module:

Support for reading yearly renewable asset volume files

[5.4.0] - 2025-08-22¶

Changed¶

Bump Python requirement from >=3.11,<3.13 to >=3.11,<3.14

[5.3.4] - 2025-08-21¶

Changed¶

Bump plotly from ^5.16.1 to >=5.16.1,<7.0.0

[5.3.3] - 2025-08-20¶

Changed¶

Bump numpy from ^1.24.4 to >=1.24.4,<3.0.0 and numba from >=0.57.1,<0.61.0 to >=0.57.1,<0.62.0

[5.3.2] - 2025-07-07¶

Changed¶

Increased timeout in get_historical_prices_api API calls to cope with large historical datasets.

[5.3.1] - 2025-05-26¶

Changed¶

Bump setuptools from 75.6.0 to 78.1.1

[5.3.0] - 2024-12-15¶

Added¶

In settings module:

Add name_of_cents attribute to Currency class, and parse it from 'nameOfCents' column of 'currency.csv' file when available.

[5.2.8] - 2024-12-06¶

Changed¶

In simulation module:

Avoid changing the dtype of data frame columns.

[5.2.7] - 2024-10-10¶

Changed¶

Bump pandas from <2.0.0 to >=2.0.0,<3.0.0

[5.2.6] - 2024-09-25¶

Changed¶

In settings.py module, initialize data type of empty Pandas series to avoid warning.

[5.2.5] - 2024-08-12¶

Changed¶

Bump setuptools from 69.2.0 to 70.0.0

[5.2.4] - 2024-07-08¶

Changed¶

Bump certifi from 2024.2.2 to 2024.7.4

[5.2.3] - 2024-06-19¶

In kyos_utils module:

Minor adjustments to the function send_email_notification().

[5.2.2] - 2024-06-17¶

Changed¶

Bump authlib from 1.3.0 to 1.3.1

[5.2.1] - 2024-06-13¶

Changed¶

In kyos_utils module:

Minor adjustments to the function send_email_notification().

[5.2.0] - 2024-05-30¶

Added¶

In kyos_utils module:

Adds utility function send_email_notification() to send out email notification to clients.

[5.1.1] - 2023-04-15¶

Changed¶

Bump idna from 3.6 to 3.7

[5.1.0] - 2024-03-28¶

Added¶

In simulation module:

get_spot method now allows calling for intraday and imbalance simulations

[5.0.7] - 2024-01-30¶

Changed¶

In simulation module:

Specify keywords of pandas drop() method to remove warnings

[5.0.6] - 2024-01-15¶

Changed¶

In simulation module:

A bug was fixed when constructing correct filename to query for volume simulations. The bug happened if volume identifier was passed as an integer.

[5.0.5] - 2023-12-13¶

Changed¶

In kyos_utils module:

Adds utility function add_to_log() to print log messages together with their timestamps

[5.0.4] - 2023-11-21¶

Changed¶

Drop 'DeliveryTypes' XML nodes from model settings if nodes do not contain the "ID" child

[5.0.3] - 2023-10-18¶

Changed¶

Bump urllib3 from 2.0.6 to 2.0.7

[5.0.2] - 2023-10-05¶

Changed¶

Bump urllib3 from 2.0.4 to 2.0.6

[5.0.1] - 2023-09-25¶

Changed¶

Fix the type names that changed in latest version of numpy. np.float is no longer supported, float is now used.

[5.0.0] - 2023-09-19¶

Changed¶

Upgrade kyoslib_py and its dependencies to Python 3.11+. Older versions of Python are no longer supported.

[4.2.0] - 2023-08-09¶

Added¶

In forward_curve module:

Allow submonthly, i.e. half-hourly, hourly, and daily, granularity curves to be queried via get_curve_api

[4.1.1] - 2023-05-24¶

Changed¶

In simulation module:

Improvement of errors logging for volumes

[4.1.0] - 2023-04-20¶

Added¶

In simulation module:

get_fwd_curve method now allows half and quarter-hour curves

[4.0.2] - 2022-12-19¶

Changed¶

Publish package to PyPi.

[4.0.1] - 2022-12-14¶

Changed¶

New arguments in Simulation.get_weather_volume_sim().

[4.0.0] - 2022-05-04¶

Changed¶

Repackage library with Poetry.
Move stop_model from dedicated module to kyos_utils.
Set python requirement to >=3.7,<3.10
Bump dependencies:
- numpy from 1.19.2 to 1.21.6
- pandas from 1.0.5 to 1.1.5
- requests from 2.23.0 to 2.27.1
- h5py from 2.10.0 to 3.6.0
- numba from 0.54.1 to 0.55.1
- plotly from 4.14.3 to 5.7.0
If you are installing using Poetry, you need to update the source name from fury to kyos

[3.5.2] - 2022-05-03¶

Changed¶

In settings module:

A bug was fixed in the constructor of DstSwitchesSet. The bug happened if the csv file containing DST switches was empty.

[3.5.1] - 2022-04-28¶

Changed¶

In kyos_api module:

Changed call_kyos_api_v1 function to use Bearer token authentication.

[3.5.0] - 2022-04-11¶

Added¶

New stop_model function:

Allows publishing of error messages on the platform from python code.

[3.4.21] - 2022-02-14¶

Fixed¶

In simulation module:

Fixed bug in the load_sims_for_all_months method, when the optional input argument end_date is not provided, or is after the start delivery date.

[3.4.20] - 2021-12-22¶

Changed¶

In simulation module:

A bug fixed in the get_fwd_product method, when the commodity type is neither power nor gas, and the requested price is in the current month.

[3.4.19] - 2021-10-29¶

Changed¶

In settings module:

A bug is fixed in count_delivery_hours, when a single month is passed.

[3.4.18] - 2021-10-28¶

Changed¶

In simulation module:

A bug fixed in the calculate_tradable_product method. Counting the delivery hours of the rolling products

[3.4.17] - 2021-10-27¶

Changed¶

Updated the dependecies to include the latest version of numba

[3.4.16] - 2021-10-11¶

Changed¶

In PlatformGraphs.save2disk() method:

Optional input arguments defined for the legend settings such as xanchor, yanchor etc.

[3.4.15] - 2021-09-29¶

Changed¶

In simulation module:

A bug fixed in the calculate_tradable_product method. There we were calculating incorrect forward product prices for some products such as yearly

[3.4.14] - 2021-08-30¶

Fixed¶

In the simulation class:

Delete SimulationError for model-currency-only simulation. It is no longer needed, as now it is also possible to load simulations in the commodities currencies.

Assign model currency if the currency-to-load is not in the commodities currencies.

[3.4.13] - 2021-07-02¶

Fixed¶

Drop urllib3 dependency. It causes conflicts, because it is already in the dependencies of requests.

[3.4.12] - 2021-06-25¶

Changed¶

In front_end module: - PlatformGraphs class added

[3.4.11] - 2021-05-25¶

Changed¶

In Commodity module: - bug fixed in the get_delivery_hours method.

[3.4.10] - 2021-05-25¶

Added¶

In Commodity module: - get_delivery_hours method added.

[3.4.9] - 2021-05-11¶

Added¶

Automate tag creation Deploy to Gemfury

[3.4.8] - 2021-04-23¶

Changed¶

More flexible numpy dependencies to match tensorflow - from 1.19.0 to >=1.19.2,<1.20.0

[3.4.7] - 2021-03-30¶

Changed¶

In Commodity module: - bugfix in the Commodity constructor related to the type of LHV energy content..

[3.4.6] - 2021-03-30¶

Added¶

In Commodity module: - add count_delivery_hours.

[3.4.5] - 2021-03-29¶

Changed¶

In Simulation module: - bugfix reading rolling products directly instead of creating

[3.4.4] - 2021-03-26¶

Changed¶

In Settings module: - added dst_switches

[3.4.3] - 2021-01-07¶

Changed¶

In Simulation module: - bugfix convert daily peakload prices

[3.4.2] - 2021-01-07¶

Changed¶

In Simulation module: - bugfix correct the file name for non power commodities.

[3.4.1] - 2021-01-05¶

Changed¶

In Simulation module: - bugfix in .convertfx().

[3.4.0] - 2020-12-24¶

Added¶

In Simulation module: - allow .get_spot(), .get_fwd_product() and .get_fwd_product_roll() to get simulations in all simulated currencies.

[3.3.1] - 2020-12-22¶

Added¶

In Simulation module: - add base_currency_id to .get_fx(), so that more type of fx can be requested

[3.3.0] - 2020-12-22¶

Added¶

In Simulation module: - add delivery_period_id to .get_fwd_product, so that the method makes more products such as a quarter product.

[3.2.0] - 2020-12-17¶

Added¶

In Simulation module: - add .get_fwd_product_roll, so that simulations can be requested on a rolling basis.

[3.1.2] - 2020-12-10¶

Changed¶

In Commodity module: - add more properties to object.

[3.1.1] - 2020-12-10¶

Changed¶

In Simulation module: - bugfix only return commodities which are simulated.

[3.1.0] - 2020-12-04¶

Added¶

In Simulation module: - add two new methods: .get_fx() and .convert_fx to the Simulation class.

[3.0.3] - 2020-11-30¶

Changed¶

In Simulation module: - correct self.end_date so that it takes into account the hours of the last simulation day. In DeliveryTypeSet: - initalise always a default value for holiday_delivery_type

[3.0.2] - 2020-11-26¶

Changed¶

in the valuation_interface module, extra_model_data attribute of the ValuationInterface class changed as extra_model_information

[3.0.1] - 2020-11-25¶

In CalendarSet module: - if no CalendarInfo was given in the xml the model doesn't crash anymore.

[3.0.0] - 2020-11-24¶

Added¶

Added: - currency_set, commodity_set, delivery_type_set, calendar_set

Changed¶

in the simulation module, to build the object the from_xml method is necessary.

[2.3.0] - 2020-11-20¶

Added¶

Method set_extra_model_data added to valuation_interface. Attribute extra_model_data added to the ValuationInterface class. Function dict_merge added to the kyos_utils class.

Changed¶

more unit tests added in test_valuation_interface for valuation_interface

[2.2.2] - 2020-11-13¶

In historical_price module: - is_cent is added to get_spot and get_fwd_product

[2.2.1] - 2020-11-13¶

Changed¶

In historical_price module: - adjusted order in which API method attempts to detect spot price granularity

[2.2.0] - 2020-11-10¶

Added¶

In historical_price module: - method to import prices via API.

[2.1.0] - 2020-10-27¶

Added¶

In front_end module: - new chart types added.

Changed¶

The customField property of the valuation_interface object changed as customFields

[2.0.3] - 2020-10-21¶

Changed¶

In simulation module: - Running time of the get_spot is reduced

[2.0.2] - 2020-09-04¶

Changed¶

In settings module: - Bug fixed in class DeliveryType when no holiday calendar defined

[2.0.1] - 2020-08-25¶

Changed¶

In forward_curve module: - isCSVWrite should be boolean - only create ForwardCurves directory if isCSVWrite is true

[2.0.0] - 2020-08-24¶

Changed¶

Only v7.3 mat files now supported by simulation module.

[1.6.9] - 2020-08-24¶

Changed¶

h5py library included as default mat file reader in simulation module. Reading of v7.3 mat files only supported.

[1.6.8] - 2020-08-13¶

Changed¶

Scipy and h5py replaced with pymatreader in simulation module. Scipy and h5py no longer dependencies.

[1.6.7] - 2020-08-06¶

Changed¶

Return a dataframe from get_curve_api() method when the isCSVWrite input is 0 in forward_curve module.

[1.6.6] - 2020-08-06¶

Added¶

Module get_curve_api added to forward_curve.

[1.6.5] - 2020-08-04¶

Changed¶

Package documentation, generated by MkDocs.

[1.6.4] - 2020-07-31¶

Changed¶

Bugfix in get_historical_prices() method in class HistoricalPrice.

[1.6.3] - 2020-07-03¶

Added¶

Module tradable_product added.

[1.5.14] - 2020-06-03¶

Added¶

Added method get_weather_volume_sim() method to class Simulation.

[1.5.7] - 2020-04-29¶

Added¶

Class DeliveryType added to module settings.
Class CalendarInfo added to module settings.

[1.5.0] - 2020-04-07¶

Added¶

Module kyos_api added.

[1.4.6] - 2020-03-25¶

Added¶

Module front_end added.

[1.2.0] - 2020-01-29¶

Added¶

Module valuation_interface added.

[1.0.0] - 2020-01-02¶

Added¶

Class Commodity added to module settings.
Class Currency added to module settings.
Class Simulation added to module simulation.
Class HistoricalPrice added to module historical_price.