Data

Tools

Indexes

Applications

Experiments

Open Source Science

pvoutput

Python code for downloading PV data from PVOutput.org

https://github.com/openclimatefix/pvoutput

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 14 committers (14.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

nowcasting pvoutput python python-library solar

Keywords from Contributors

gan nowcasting-models nowcasting-precipitation pytorch-implementation pytorch-lightning eumetsat forecasting-models graph-neural-networks weather particle
Last synced: 6 months ago · JSON representation

Repository

Python code for downloading PV data from PVOutput.org

Basic Info
  • Host: GitHub
  • Owner: openclimatefix
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 5.1 MB
Statistics
  • Stars: 34
  • Watchers: 4
  • Forks: 17
  • Open Issues: 35
  • Releases: 32
Topics
nowcasting pvoutput python python-library solar
Created over 6 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

All Contributors <!-- ALL-CONTRIBUTORS-BADGE:END -->

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

bash $ 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:

yaml 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/

Install pvoutput Python library

bash 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!

Owner

  • Name: Open Climate Fix
  • Login: openclimatefix
  • Kind: organization
  • Email: info@openclimatefix.org
  • Location: London

Using open science to mitigate climate change

GitHub Events

Total
  • Create event: 4
  • Release event: 3
  • Issues event: 1
  • Delete event: 1
  • Push event: 55
  • Pull request event: 2
Last Year
  • Create event: 4
  • Release event: 3
  • Issues event: 1
  • Delete event: 1
  • Push event: 55
  • Pull request event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 289
  • Total Committers: 14
  • Avg Commits per committer: 20.643
  • Development Distribution Score (DDS): 0.709
Past Year
  • Commits: 7
  • Committers: 3
  • Avg Commits per committer: 2.333
  • Development Distribution Score (DDS): 0.571
Top Committers
Name Email 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 (Top 20 + Academic)
mail.mcgill.ca: 1 bieker.tech: 1 sheffield.ac.uk: 1 xlk.org.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 67
  • Total pull requests: 62
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 1 month
  • Total issue authors: 9
  • Total pull request authors: 13
  • Average comments per issue: 1.46
  • Average comments per pull request: 0.92
  • Merged pull requests: 53
  • Bot issues: 0
  • Bot pull requests: 19
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
  • JackKelly (37)
  • peterdudfield (14)
  • JamieTaylor-TUOS (7)
  • JulianBriggs (4)
  • jacobbieker (1)
  • hazaioud (1)
  • SophiaLi20 (1)
  • fabmid (1)
  • flowirtz (1)
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)
  • rachtsingh (1)
  • Antsthebul (1)
  • vnshanmukh (1)
  • jacobbieker (1)
Top Labels
Issue Labels
enhancement (22) bug (12) good first issue (5) Refactoring (5) documentation (2) testing (1) wontfix (1)
Pull Request Labels
enhancement (2) help wanted (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 33
proxy.golang.org: github.com/openclimatefix/pvoutput
  • Versions: 33
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

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