fboerman / jao-py

MIT License
14 stars 6 forks source link

jao-py

tests

Python client for the various endpoints offered by jao.eu, the Joint Allocation Office. "Europe's single leading trading platform( e-CAT) for cross-border transmission capacity"

More information about JAO can be found on their website https://jao.eu/

jao.eu has various ways of retrieving data. This package tries to offer useful functions to handle them. This package is not exhaustive, more methods are added when the authors needs them. If you want to see other methods added please either open a feature request issue to give others ideas or supply a pull request yourself.

Installation

python3 -m pip install jao-py

Usage

Current clients

The package comes with the current pandas clients:

CORE Intraday a and b are combined in the same intraday client. In the initialization of the client you can choose which one you want like so:

from jao import JaoPublicationToolPandasIntraDay

client = JaoPublicationToolPandasIntraDay(version='a') # IDCC(a)
client = JaoPublicationToolPandasIntraDay(version='b') # IDCC(b)

Deprecated clients

The package also includes legacy clients for flowbased CWE data in the CWE subpackage. These return data up until business day 2022-06-08

To use these deprecated clients be sure to install the following additional dependencies:

suds-community
lxml
pillow

this is only required for the CWE deprecated subpackage