PVSiteAPI

Warning

This repo will soon be deprecated in favour of quartz-api

API for PV site level forecasting

Setup and Run

Install poetry

Install python dependencies

poetry install

Start the API using uvicorn

poetry run uvicorn pv_site_api.main:app --reload

Running the tests

poetry run pytest tests

Data Platform Integration

Generation values are always forwarded to the OCF Data Platform via gRPC. Configure the following environment variables to point it at the right instance:

Environment Variable	Default	Description
DATA_PLATFORM_HOST	localhost	gRPC host for Data Platform service
DATA_PLATFORM_PORT	50051	gRPC port for Data Platform service

Manual Observer Creation (Pre-requisite)

Before sending observations to a new Data Platform environment, create/register the pv_actual observer.

Coding style

Format the code in place

make format

Verify that the code satisfies the style

make lint

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Peter Dudfield 💻	rachel tipton 💻	Eric Liu 💻	Simon Lemieux 💻	Rahul Maurya 💻	Suleman Karigar 💻	BraunRudolf 💻
Nicholas Tucker 💻	Anas Khan 💻	Utkarsh Verma 💻

This project follows the all-contributors specification. Contributions of any kind welcome!