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
gan eumetsat forecasting-models graph-neural-networks weather pytorch-lightning climate-model pytorch-implementation nowcasting-precipitation nowcasting-models
Last synced: about 13 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 (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T09:35:15.000Z (9 days ago)
- Last Synced: 2025-04-20T10:40:25.423Z (7 days ago)
- Topics: nowcasting, pvoutput, python, python-library, solar
- Language: Python
- Homepage:
- Size: 5.1 MB
- Stars: 34
- Watchers: 4
- Forks: 17
- Open Issues: 34
- Releases: 32
-
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
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_urlto your configuration file (~/.pvoutput.yml) or - pass
data_service_urlto thePVOutputconstructor.
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/
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):
This project follows the all-contributors specification. Contributions of any kind welcome!
Owner metadata
- Name: Open Climate Fix
- Login: openclimatefix
- Email: [email protected]
- 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
- Create event: 4
- Release event: 3
- Issues event: 1
- Delete event: 1
- Push event: 43
- Pull request event: 2
Last Year
- Create event: 4
- Release event: 3
- Issues event: 1
- Delete event: 1
- Push event: 43
- Pull request event: 2
Committers metadata
Last synced: 4 days ago
Total Commits: 289
Total Committers: 14
Avg Commits per committer: 20.643
Development Distribution Score (DDS): 0.709
Commits in past year: 7
Committers in past year: 3
Avg Commits per committer in past year: 2.333
Development Distribution Score (DDS) in past year: 0.571
| Name | Commits | |
|---|---|---|
| Jack Kelly | j****t@x****k | 84 |
| peterdudfield | p****d@h****m | 80 |
| pre-commit-ci[bot] | 6****] | 34 |
| BumpVersion Action | b****n@g****s | 33 |
| allcontributors[bot] | 4****] | 18 |
| ssmssam | s****m@g****m | 17 |
| Jamie Taylor | j****r@s****k | 7 |
| Jacob Bieker | j****b@b****h | 4 |
| devsjc | d****c@o****m | 4 |
| Antsthebul | a****t@g****m | 2 |
| Gabriel Tseng | g****g@m****a | 2 |
| vnshanmukh | v****h@g****m | 2 |
| Rachit Singh | r****h@o****m | 1 |
| Sol OCF | s****c@S****l | 1 |
Committer domains:
- mail.mcgill.ca: 1
- bieker.tech: 1
- sheffield.ac.uk: 1
- xlk.org.uk: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 68
Total pull requests: 59
Average time to close issues: about 1 month
Average time to close pull requests: 20 days
Total issue authors: 9
Total pull request authors: 13
Average comments per issue: 1.44
Average comments per pull request: 0.95
Merged pull request: 52
Bot issues: 0
Bot pull requests: 17
Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 1
Top Issue Authors
- JackKelly (37)
- peterdudfield (15)
- JamieTaylor-TUOS (7)
- JulianBriggs (4)
- jacobbieker (1)
- hazaioud (1)
- SophiaLi20 (1)
- fabmid (1)
- flowirtz (1)
Top Pull Request Authors
- peterdudfield (18)
- allcontributors[bot] (9)
- pre-commit-ci[bot] (8)
- JamieTaylor-TUOS (6)
- ssmssam (5)
- rachel-labri-tipton (4)
- devsjc (2)
- gabrieltseng (2)
- vnshanmukh (1)
- jacobbieker (1)
- rachtsingh (1)
- Antsthebul (1)
- falknerdominik (1)
Top Issue Labels
- enhancement (22)
- 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:
- pypi: 1,068 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 31
- Total maintainers: 1
pypi.org: pvoutput-ocf
- Homepage:
- Documentation: https://pvoutput-ocf.readthedocs.io/
- Licenses: MIT
- Latest release: 0.1.33 (published 9 days ago)
- Last Synced: 2025-04-25T13:04:48.337Z (1 day ago)
- Versions: 31
- Dependent Packages: 0
- Dependent Repositories: 1
- Downloads: 1,068 Last month
-
Rankings:
- Dependent packages count: 10.109%
- Average: 17.901%
- Dependent repos count: 21.559%
- Downloads: 22.035%
- Maintainers (1)
Dependencies
- beautifulsoup4 *
- cython >0.15.1
- geopandas *
- jupyter *
- matplotlib *
- numpy *
- pandas *
- pyproj *
- pyshp *
- pytest *
- pyyaml *
- requests *
- shapely *
- tables *
- urllib3 *
- beautifulsoup4
- jupyterlab
- matplotlib
- pandas
- pytables
- pytest
- python >=3.7
- pyyaml
- requests
- urllib3
Score: 13.833978962247317