Skip to main content

No project description provided

Project description

All Contributors

codecov

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

Register with PVOutput.org

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

If you don't have a 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

PVOutput.org gives you 60 API requests per hour. Per 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 quota for a year to 300 requests per hour.

Paid

To get more historical data, you can pay $600 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 this dones include the /service/r2 part of the URL) For example: data_service_url: https://pvoutput.org/

Install pvoutput Python library

`pip install -e git+https://github.com/openclimatefix/pvoutput.git@main#egg=pvoutput-ocf

Usage

See the Quick Start notebook.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jack Kelly
Jack Kelly

💻
Sam Murphy-Sugrue
Sam Murphy-Sugrue

💻
Gabriel Tseng
Gabriel Tseng

💻
Jamie Taylor
Jamie Taylor

💻
Peter Dudfield
Peter Dudfield

🚇
Shanmukh Chava
Shanmukh Chava

💻
Antsthebul
Antsthebul

💻
Rachit Singh
Rachit Singh

🔣 💻
devsjc
devsjc

💻

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pvoutput-ocf-0.1.30.tar.gz (43.4 kB view details)

Uploaded Source

Built Distribution

pvoutput_ocf-0.1.30-py3-none-any.whl (47.7 kB view details)

Uploaded Python 3

File details

Details for the file pvoutput-ocf-0.1.30.tar.gz.

File metadata

  • Download URL: pvoutput-ocf-0.1.30.tar.gz
  • Upload date:
  • Size: 43.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pvoutput-ocf-0.1.30.tar.gz
Algorithm Hash digest
SHA256 c0edbc457a7837da8ce3d8f5bf0a961d5bbbcbe625aa8822caf948ede16329b3
MD5 43c424c855b3a927220a1bf2fa890e5f
BLAKE2b-256 37ea9d9d1426afadef7b86aa63ec42a48f3c3a53d6fa547807dd2c3660f5c4e3

See more details on using hashes here.

File details

Details for the file pvoutput_ocf-0.1.30-py3-none-any.whl.

File metadata

File hashes

Hashes for pvoutput_ocf-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 07b668d56344b851b8114d37b8b0414dad115b7853899d9b4f6540a553516037
MD5 a8af4a36af6629c705f83bfe2d85bdee
BLAKE2b-256 4aa3f49e547c6ea50f09f1e949497b3fb46212104523140c915196f9430ce8ad

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page