Add a national end point, that provides elexon BMRS solar foreacsts from elexonpy package #347

14Richa · 2024-07-17T09:55:22Z

Description

This PR introduces a new API endpoint /v0/solar/national/bmrs to fetch BMRS solar forecasts from the Elexon API.

Example Response

Below is the screenshot of the data getting from the API:

Fixes #346

Checklist:

My code follows OCF's coding style guidelines
I have performed a self-review of my own code
I have checked my code and corrected any misspellings

for more information, see https://pre-commit.ci

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

for more information, see https://pre-commit.ci

peterdudfield

Yea looks really good
A few points

It would be good, to only get slar forecasts, not wind forecasts
Need to add a test
We might want to create a pydantic return object, not just a dataframe.

src/main.py

src/national.py

for more information, see https://pre-commit.ci

src/national.py

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

for more information, see https://pre-commit.ci

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

for more information, see https://pre-commit.ci

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

src/national.py

peterdudfield · 2024-07-23T15:11:53Z

Can you make sure tge pre commit works

14Richa · 2024-07-23T16:13:38Z

Can you make sure tge pre commit works

This is solved.

peterdudfield · 2024-07-23T16:24:03Z

Can you add a test?

src/main.py

src/national.py

peterdudfield

Also do you need to add elexonpy to requirements?

src/tests/test_elexon_forecast.py

peterdudfield

Code is good apart from a small change

Tests need test the actual api. The mocking is good though

src/pydantic_models.py

peterdudfield · 2024-07-27T09:58:30Z

src/tests/test_elexon_forecast.py

+            f"&process_type=Day Ahead"
+        )
+
+        m.get(url, json=empty_mock_data, headers={"Content-Type": "application/json"})


You need to set the actual api up and call the route. See other national tests

peterdudfield · 2024-07-29T12:23:10Z

src/tests/test_elexon_forecast.py

+
+        m.get(url, json=empty_mock_data, headers={"Content-Type": "application/json"})
+
+        response = requests.get(url)


Instead use response = api_client.get("/v0/solar/GB/national/elexon"), this should use the mocked api you have done above

braddf · 2024-07-31T14:14:52Z

Hmm I know this is merged now, but I'm not sure that the test added here is actually testing anything at all as it is..? 😅

cc. @peterdudfield

peterdudfield · 2024-07-31T14:34:16Z

I know i merged it to give it a go myself - https://github.com/openclimatefix/uk-pv-national-gsp-api/pull/350/files

* Add a national end point, that provides elexon BMRS solar foreacsts from elexonpy package (#347) * added import statements of elexonpy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added API for solar forecast * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * minor fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * minor fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * changed function name * added filter functionality * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added API link * minor fix * remove try except block * changed bmrs to elexon * minor fix * resolving pre hook * minor fix in docstring * removed router * minor fix in naming * added elexonpy in requirement.txt file * resolve hook error * minor fix * added response model * fixed unit test * remove plevel --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * first try at mocking elexon api * upadte url for api * update test, remove try and except * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * isort * and try and except * add intergation test * lint * PR comments, move elexon to below forecast and pvlive * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * change docker-compose to docker compose * fix test * Minor change to mock method on real class --------- Co-authored-by: Richa <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: braddf <[email protected]> Co-authored-by: braddf <[email protected]>

14Richa and others added 6 commits July 17, 2024 15:23

added import statements of elexonpy

e125c2a

[pre-commit.ci] auto fixes from pre-commit.com hooks

1ab3837

for more information, see https://pre-commit.ci

resolve conflicts

aec73d2

Merge branch '14Richa/solar-forecast-endpoint' of github.com:14Richa/…

9b302f9

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

added API for solar forecast

bae31a9

[pre-commit.ci] auto fixes from pre-commit.com hooks

9158800

for more information, see https://pre-commit.ci

14Richa marked this pull request as ready for review July 18, 2024 18:33

peterdudfield requested changes Jul 19, 2024

View reviewed changes

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/main.py Outdated Show resolved Hide resolved

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Outdated Show resolved Hide resolved

14Richa and others added 2 commits July 19, 2024 16:52

minor fix

81af713

[pre-commit.ci] auto fixes from pre-commit.com hooks

9ca6cf0

for more information, see https://pre-commit.ci

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Show resolved Hide resolved

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Outdated Show resolved Hide resolved

14Richa and others added 9 commits July 19, 2024 17:23

minor fix

746d979

Merge branch '14Richa/solar-forecast-endpoint' of github.com:14Richa/…

f6cad5d

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

[pre-commit.ci] auto fixes from pre-commit.com hooks

8b988ab

for more information, see https://pre-commit.ci

changed function name

299497d

Merge branch '14Richa/solar-forecast-endpoint' of github.com:14Richa/…

f03e377

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

added filter functionality

0193ad0

[pre-commit.ci] auto fixes from pre-commit.com hooks

e4b19e4

for more information, see https://pre-commit.ci

added API link

bc5cece

Merge branch '14Richa/solar-forecast-endpoint' of github.com:14Richa/…

a1ddc32

…uk-pv-national-gsp-api into 14Richa/solar-forecast-endpoint

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Outdated Show resolved Hide resolved

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Outdated Show resolved Hide resolved

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Show resolved Hide resolved

peterdudfield reviewed Jul 19, 2024

View reviewed changes

src/national.py Show resolved Hide resolved

14Richa added 3 commits July 20, 2024 15:30

minor fix

f86c36b

remove try except block

25a345b

changed bmrs to elexon

f254216

peterdudfield requested changes Jul 23, 2024

View reviewed changes

src/national.py Outdated Show resolved Hide resolved

src/national.py Outdated Show resolved Hide resolved

14Richa added 2 commits July 23, 2024 21:12

minor fix

67a2293

resolving pre hook

e01ea24

braddf requested changes Jul 23, 2024

View reviewed changes

src/main.py Outdated Show resolved Hide resolved

src/national.py Outdated Show resolved Hide resolved

src/national.py Outdated Show resolved Hide resolved

peterdudfield reviewed Jul 23, 2024

View reviewed changes

minor fix in docstring

b12e8c2

peterdudfield closed this Jul 24, 2024

peterdudfield reopened this Jul 24, 2024

14Richa added 4 commits July 24, 2024 19:26

removed router

c40b4ec

minor fix in naming

7d21b13

added elexonpy in requirement.txt file

841554a

resolve hook error

448bd81

peterdudfield reviewed Jul 25, 2024

View reviewed changes

src/tests/test_elexon_forecast.py Outdated Show resolved Hide resolved

14Richa added 3 commits July 25, 2024 21:48

minor fix

8e8167a

added response model

e734329

fixed unit test

0d0cc1c

peterdudfield requested changes Jul 27, 2024

View reviewed changes

remove plevel

e53d7a8

peterdudfield reviewed Jul 29, 2024

View reviewed changes

peterdudfield changed the base branch from main to development July 31, 2024 13:14

peterdudfield merged commit a6b5e1b into openclimatefix:development Jul 31, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a national end point, that provides elexon BMRS solar foreacsts from elexonpy package #347

Add a national end point, that provides elexon BMRS solar foreacsts from elexonpy package #347

14Richa commented Jul 17, 2024 •

edited

Loading

peterdudfield left a comment

peterdudfield commented Jul 23, 2024

14Richa commented Jul 23, 2024

peterdudfield commented Jul 23, 2024

peterdudfield left a comment

peterdudfield left a comment

peterdudfield Jul 27, 2024

peterdudfield Jul 29, 2024

braddf commented Jul 31, 2024

peterdudfield commented Jul 31, 2024


		m.get(url, json=empty_mock_data, headers={"Content-Type": "application/json"})

		response = requests.get(url)

Add a national end point, that provides elexon BMRS solar foreacsts from elexonpy package #347

Add a national end point, that provides elexon BMRS solar foreacsts from elexonpy package #347

Conversation

14Richa commented Jul 17, 2024 • edited Loading

Description

Example Response

Checklist:

peterdudfield left a comment

Choose a reason for hiding this comment

peterdudfield commented Jul 23, 2024

14Richa commented Jul 23, 2024

peterdudfield commented Jul 23, 2024

peterdudfield left a comment

Choose a reason for hiding this comment

peterdudfield left a comment

Choose a reason for hiding this comment

peterdudfield Jul 27, 2024

Choose a reason for hiding this comment

peterdudfield Jul 29, 2024

Choose a reason for hiding this comment

braddf commented Jul 31, 2024

peterdudfield commented Jul 31, 2024

14Richa commented Jul 17, 2024 •

edited

Loading