Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

EIDF internal API #35

Open
1 of 3 tasks
mjaquiery opened this issue Feb 20, 2023 · 0 comments
Open
1 of 3 tasks

EIDF internal API #35

mjaquiery opened this issue Feb 20, 2023 · 0 comments
Labels
enhancement New feature or request integration Integrating with other services

Comments

@mjaquiery
Copy link
Collaborator

A fragmented Galvanalyser instance will run within the EIDF. Part of its responsibility will be to make data available for viewing and processing via versions of its frontend web interface and Python APIs.

The web interface should allow neat overviews of battery data.

The Python API will be used by VM instances within the EIDF cloud to access data without requiring huge data transfers.

Galvanalyser should:

  • allow users to log in via CKAN authorisation service
  • provide data overview to authorised users via a web interface
  • provide data to authorised users via a Python API

The functionality for this is highly similar to the implementation within the full Galvanalyser service, except that the REST API and its children (frontend and Python API) will be read only interfaces. This should make provision markedly simpler.

Depending upon specifics, the Python API may need to be altered to provide direct database access. For example, implementing Python API access via REST API access may mean data are processed and reduplicated where providing a Python API with direct access to the database minimises this extra processing and transfer. This would be a substantial amount of work, but may yeild commensurate rewards.

This component comprises the REST API, Web frontend, and Python API in the diagram below.
restructure

@mjaquiery mjaquiery added enhancement New feature or request integration Integrating with other services labels Feb 20, 2023
@mjaquiery mjaquiery added this to the Integrating with EIDF milestone Feb 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request integration Integrating with other services
Projects
None yet
Development

No branches or pull requests

1 participant