pvoutput

Python code for downloading PV data from PVOutput.org.
https://github.com/openclimatefix/pvoutput

Category: Renewable Energy
Sub Category: Photovoltaics and Solar Energy

Keywords

nowcasting pvoutput python python-library solar

Keywords from Contributors

eumetsat forecasting-models graph-neural-networks weather solar-energy gan nowcasting-models nowcasting-precipitation pytorch-implementation pytorch-lightning

Last synced: about 14 hours ago
JSON representation

Repository metadata

Python code for downloading PV data from PVOutput.org

Host: GitHub
URL: https://github.com/openclimatefix/pvoutput
Owner: openclimatefix
License: apache-2.0
Created: 2019-07-16T16:51:03.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2026-01-29T20:36:01.000Z (21 days ago)
Last Synced: 2026-02-08T22:42:00.344Z (11 days ago)
Topics: nowcasting, pvoutput, python, python-library, solar
Language: Python
Homepage:
Size: 5.16 MB
Stars: 36
Watchers: 4
Forks: 18
Open Issues: 33
Releases: 38
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

README.md

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):

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

Owner metadata

Name: Open Climate Fix
Login: openclimatefix
Email: info@openclimatefix.org
Kind: organization
Description: Using open science to mitigate climate change
Website: openclimatefix.org
Location: London
Twitter: openclimatefix
Company:
Icon url: https://avatars.githubusercontent.com/u/48357542?v=4
Repositories: 88
Last ynced at: 2024-04-15T07:32:15.529Z
Profile URL: https://github.com/openclimatefix

GitHub Events

Total

Release event: 5
Delete event: 1
Pull request event: 5
Fork event: 1
Issues event: 3
Watch event: 2
Issue comment event: 9
Push event: 67
Pull request review comment event: 1
Create event: 4

Last Year

Release event: 5
Delete event: 1
Pull request event: 5
Fork event: 1
Issues event: 2
Watch event: 2
Issue comment event: 9
Push event: 41
Pull request review comment event: 1
Create event: 4

Committers metadata

Last synced: 1 day ago

Total Commits: 308
Total Committers: 16
Avg Commits per committer: 19.25
Development Distribution Score (DDS): 0.727

Commits in past year: 26
Committers in past year: 5
Avg Commits per committer in past year: 5.2
Development Distribution Score (DDS) in past year: 0.654

Name	Email	Commits
Jack Kelly	j**t@x**k	84
peterdudfield	p**d@h**m	80
pre-commit-ci[bot]	6****]	39
BumpVersion Action	b**n@g**s	39
allcontributors[bot]	4****]	18
ssmssam	s**m@g**m	17
Jamie Taylor	j**r@s**k	7
Ayush Singh	a**8@g**m	5
devsjc	d**c@o**m	4
Jacob Bieker	j**b@b**h	4
Vishal	v**1@g**m	3
vnshanmukh	v**h@g**m	2
Gabriel Tseng	g**g@m**a	2
Antsthebul	a**t@g**m	2
Rachit Singh	r**h@o**m	1
Sol OCF	s**c@S**l	1

Committer domains:

Issue and Pull Request metadata

Last synced: 3 days ago

Total issues: 68
Total pull requests: 65
Average time to close issues: about 1 month
Average time to close pull requests: about 1 month
Total issue authors: 10
Total pull request authors: 15
Average comments per issue: 1.56
Average comments per pull request: 1.15
Merged pull request: 56
Bot issues: 0
Bot pull requests: 19

Past year issues: 1
Past year pull requests: 5
Past year average time to close issues: 6 days
Past year average time to close pull requests: about 9 hours
Past year issue authors: 1
Past year pull request authors: 3
Past year average comments per issue: 7.0
Past year average comments per pull request: 3.6
Past year merged pull request: 3
Past year bot issues: 0
Past year bot pull requests: 2

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/openclimatefix/pvoutput

Top Issue Authors

JackKelly (37)
peterdudfield (14)
JamieTaylor-TUOS (7)
JulianBriggs (4)
jacobbieker (1)
hazaioud (1)
SophiaLi20 (1)
fabmid (1)
flowirtz (1)
ArkVex (1)

Top Pull Request Authors

peterdudfield (18)
pre-commit-ci[bot] (10)
allcontributors[bot] (9)
JamieTaylor-TUOS (6)
ssmssam (5)
rachel-labri-tipton (4)
devsjc (2)
gabrieltseng (2)
falknerdominik (2)
ArkVex (2)
rachtsingh (1)
Antsthebul (1)
vnshanmukh (1)
jacobbieker (1)
CodeVishal-17 (1)

Top Issue Labels

enhancement (23)
bug (12)
good first issue (5)
Refactoring (5)
documentation (2)
testing (1)
wontfix (1)

Top Pull Request Labels

enhancement (2)
help wanted (1)

Package metadata

Total packages: 1
Total downloads: unknown
Total dependent packages: 0
Total dependent repositories: 0
Total versions: 39

proxy.golang.org: github.com/openclimatefix/pvoutput

Homepage:
Documentation: https://pkg.go.dev/github.com/openclimatefix/pvoutput#section-documentation
Licenses: apache-2.0
Latest release: v0.1.39 (published 21 days ago)
Last Synced: 2026-02-16T23:01:47.817Z (3 days ago)
Versions: 39
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%

Dependencies

.github/workflows/pytest.yml actions

.github/workflows/release.yaml actions

requirements.txt pypi

beautifulsoup4 *
cython >0.15.1
geopandas *
jupyter *
matplotlib *
numpy *
pandas *
pyproj *
pyshp *
pytest *
pyyaml *
requests *
shapely *
tables *
urllib3 *

setup.py pypi

environment.yml conda

beautifulsoup4
jupyterlab
matplotlib
pandas
pytables
pytest
python >=3.7
pyyaml
requests
urllib3

Score: -Infinity

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology