Create API

[peterdudfield]

Detailed Description

Create a simple API that could take in site level details and make a forecast

Context

• wrap around this function - from quartz_solar_forecast.forecast import run_forecast
• we can think about deploy this later
• if we have an api, then lots of tech stacks, like websites could get a forecast

Possible Implementation

• create fastapi that wraps the function run_forecast

[aryanbhosale]

Hey @peterdudfield , the run_forecast function uses make_pv_data in data.py, which in turn optionally uses the functions from enphase.py-where some functions require CLI inputs given by the user. Should it be like calling an API with a cURL-which only Linux users will be able to use ? Otherwise we'd have to make a .ps1 (powershell) file for windows-specific users to use the api.

[peterdudfield]

Perhaps we could focus on doing this without data from enphase first. I think a FastApi could be a great way to do this

[Clemo97]

Hey @peterdudfield , the run_forecast function uses make_pv_data in data.py, which in turn optionally uses the functions from enphase.py-where some functions require CLI inputs given by the user. Should it be like calling an API with a cURL-which only Linux users will be able to use ? Otherwise we'd have to make a .ps1 (powershell) file for windows-specific users to use the api.

What is enphase.py

[Clemo97]

Perhaps we could focus on doing this without data from enphase first. I think a FastApi could be a great way to do this

I already created the API, though I'm curious should it exist within this repos folder or can be on its own folder and GitHub repo?

[peterdudfield]

Hey @peterdudfield , the run_forecast function uses make_pv_data in data.py, which in turn optionally uses the functions from enphase.py-where some functions require CLI inputs given by the user. Should it be like calling an API with a cURL-which only Linux users will be able to use ? Otherwise we'd have to make a .ps1 (powershell) file for windows-specific users to use the api.

What is enphase.py

enphase is a solar inverter, we trying to get this working so people can connect to their own solar panels and give a solar forecast

[peterdudfield]

Perhaps we could focus on doing this without data from enphase first. I think a FastApi could be a great way to do this

I already created the API, though I'm curious should it exist within this repos folder or can be on its own folder and GitHub repo?

I think what #146 has done with the API is the way forward. If #146 gets merged, can you build of that API?

[aryanbhosale]

Hey @peterdudfield , which folder should the api file be in? any suggestions? or should i go ahead with making a new folder called "api"/"run_forecast_api.py"

[Clemo97]

Perhaps we could focus on doing this without data from enphase first. I think a FastApi could be a great way to do this

I already created the API, though I'm curious should it exist within this repos folder or can be on its own folder and GitHub repo?

I think what #146 has done with the API is the way forward. If #146 gets merged, can you build of that API?

No need @aryanbhosale is already working on it. I think I'll just put my efforts on issue #93

[aryanbhosale]

Perhaps we could focus on doing this without data from enphase first. I think a FastApi could be a great way to do this

I already created the API, though I'm curious should it exist within this repos folder or can be on its own folder and GitHub repo?

I think what #146 has done with the API is the way forward. If #146 gets merged, can you build of that API?

No need @aryanbhosale is already working on it. I think I'll just put my efforts on issue #93

I'm not working on it since #146 has already put in some work into it, you could try it out!

[Clemo97]

Perhaps we could focus on doing this without data from enphase first. I think a FastApi could be a great way to do this

I already created the API, though I'm curious should it exist within this repos folder or can be on its own folder and GitHub repo?

I think what #146 has done with the API is the way forward. If #146 gets merged, can you build of that API?

No need @aryanbhosale is already working on it. I think I'll just put my efforts on issue #93

I'm not working on it since #146 has already put in some work into it, you could try it out!

Yeah, I will look into it, since she's already created the API all that's left is creating the schema and the Open API docs for interactivity.
Though I'm also looking at issue #93 since it's given me the most headache as I use Ubuntu 24.04 which unfortunately uses Python 3.12.

[peterdudfield]

I think we should close this now, right?

[aryanbhosale]

I think we should close this now, right?

Yes I think this has been resolved