pvoutput-ocf 0.1.34

No project description provided

Download historical solar photovoltaic data from PVOutput.org.

This code is a work-in-progress. The aim is to provide both a Python library for interacting with PVOutput.org's API, and a set of scripts for downloading lots of data :)

Installation

$ pip install pvoutput-ocf

Development installation

If you want to install the latest development version directly from GitHub:

pip install git+https://github.com/openclimatefix/pvoutput.git

Register with PVOutput.org

You need to get an API key and a system ID from PVOutput.org.

If you don't own a physical PV system, click the "energy consumption only" box when registering on PVOutput. If you don't include a system ID, then you'll get a "401 Unauthorized" response from the PVOutput API.

You can pass the API key and system ID into the PVOutput constructor. Or, create a ~/.pvoutput.yml file which looks like:

api_key: <API key from PVOutput.org>
system_id: <SystemID from PVOutput.org>

The default location of the .pvoutput.yml is the user's home directory, expanded from ~. This can be overridden by setting the PVOUTPUT_CONFIG environment variable.

e.g. export PVOUTPUT_CONFIG="/my/preferred/location/.pvoutput.yml"

Alternatively, you can set API_KEY, SYSTEM_ID and DATA_SERVICE_URL (see below) as environmental variables.

API quotas and paid subscriptions

Please see here for update info.

Free

For free, PVOutput.org gives you 60 API requests per hour. In a single API request you can download one day of data for one PV system. (See PVOutput's docs for more info about rate limits.)

Donate

Donating to PVOutput.org increases your API quota to 300 requests per hour.

Paid

To get more historical data, you can pay $800 Australian dollars for a year's 'Live System History' subscription for a single country (more info here. And here's PVOutput.org's full price list). This allows you to use the get batch status API to download 900 PV-system-years per hour.

If you have subscribed to PVOutput's data service then either

• add data_service_url to your configuration file (~/.pvoutput.yml) or
• pass data_service_url to the PVOutput constructor.

The data_service_url should end in .org (note the data_service_url doesn't include the /service/r2 part of the URL) For example: data_service_url: https://pvoutput.org/

Usage

See the Quick Start notebook.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jack Kelly 💻	Sam Murphy-Sugrue 💻	Gabriel Tseng 💻	Jamie Taylor 💻	Peter Dudfield 🚇	Shanmukh Chava 💻	Antsthebul 💻
Rachit Singh 🔣 💻	devsjc 💻

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