Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 5 committers (20.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.4%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: fboerman
- License: mit
- Language: Python
- Default Branch: master
- Size: 94.7 KB
Statistics
- Stars: 15
- Watchers: 4
- Forks: 9
- Open Issues: 2
- Releases: 55
Metadata Files
README.md
jao-py
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:
- JaoAPIClient: api client for the webservice API defined here
- JaoPublicationToolClient: client for the Core Day-Ahead publication tool defined here
- JaoPublicationToolPandasIntraDay: client for Core Intradaypublication tool for Intraday defined here
- JaoPublicationToolPandasNordics: client for Nordic Day-Ahead publication tool defined here
The publication tool clients have valid data from their respective go lives:
- Core Day-Ahead: business day 2022-06-09 onwards
- Core Intraday(b): business day 2024-05-29 onwards
- Core Intraday(a): business day 2024-06-14 onwards
- Nordic Day-Ahead: business day 2024-10-30 onwards
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: ```python from jao import JaoPublicationToolPandasIntraDay
client = JaoPublicationToolPandasIntraDay(version='a') # IDCC(a) client = JaoPublicationToolPandasIntraDay(version='b') # IDCC(b) client = JaoPublicationToolPandasIntraDay(version='c') # IDCC(c) ```
There is also a client available for parallel run, which works in the exact same way as the intraday client above: ```python from jao import JaoPublicationToolPandasIntraDayParRun
client = JaoPublicationToolPandasIntraDayParRun('c') #IDCC(c) ```
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
- JaoUtilityToolASMXClient: a very light wrapper around the ASMX Web Service API implemented as a passthrough to the suds-community pakcage
- JaoUtilityToolCSVClient: client to download csv data inm the same way as the utility tool excel file, returns pandas dataframes
- JaoUtilityToolXmlClient: downloads xml data of the utilitytool, this requires solving a captcha by the user, returns pandas dataframes
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
Owner
- Name: fboerman
- Login: fboerman
- Kind: user
- Location: Boxtel
- Company: @KolibriSolutions
- Website: https://boerman.dev/
- Twitter: FrankBoerman
- Repositories: 43
- Profile: https://github.com/fboerman
GitHub Events
Total
- Release event: 10
- Watch event: 1
- Delete event: 1
- Push event: 19
- Fork event: 2
- Create event: 10
Last Year
- Release event: 10
- Watch event: 1
- Delete event: 1
- Push event: 19
- Fork event: 2
- Create event: 10
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Frank Boerman | f****k@f****l | 82 |
| Frank Boerman | f****n@t****u | 6 |
| angryvoegi | n****i@g****m | 3 |
| Simon95H | 5****H | 1 |
| Florian Maurer | m****r@f****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 3
- Total pull requests: 8
- Average time to close issues: 18 days
- Average time to close pull requests: 11 days
- Total issue authors: 3
- Total pull request authors: 4
- Average comments per issue: 1.33
- Average comments per pull request: 1.13
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 1.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- maurerle (1)
- idati (1)
- akshaylohiya92 (1)
Pull Request Authors
- FrankBoermanTenneT (4)
- maurerle (4)
- angryvoegi (2)
- SimonSaysCode418 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 1,956 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 55
- Total maintainers: 1
pypi.org: jao-py
A python API wrapper for JAO.eu
- Homepage: https://github.com/fboerman/jao-py
- Documentation: https://jao-py.readthedocs.io/
- License: MIT
-
Latest release: 0.5.14
published 10 months ago
Rankings
Maintainers (1)
Dependencies
- lxml *
- pillow *
- suds-community *
- beautifulsoup4 *
- lxml *
- pandas *
- pillow *
- python-dateutil *
- requests *
- suds-community *
- beautifulsoup4 *
- pandas *
- python-dateutil *
- requests *
- actions/checkout master composite
- actions/setup-python v1 composite
- pypa/gh-action-pypi-publish master composite
- svenstaro/upload-release-action 2.2.1 composite
- actions/checkout master composite
- actions/setup-python v4 composite