rdtools

PV Analysis Tools in Python

https://github.com/nrel/rdtools

Science Score: 67.0%

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

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 16 DOI reference(s) in README
○
Academic publication links
✓
Committers with academic emails
1 of 25 committers (4.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.5%) to scientific vocabulary

Keywords from Contributors

photovoltaic renewable-energy renewables bifacial radiance interactive solar-energy mesh interpretability sequences

Last synced: 6 months ago · JSON representation ·

Repository

PV Analysis Tools in Python

Basic Info

Host: GitHub
Owner: NREL
License: mit
Language: Python
Default Branch: master
Homepage: https://rdtools.readthedocs.io/
Size: 81.4 MB

Statistics

Stars: 165
Watchers: 24
Forks: 76
Open Issues: 39
Releases: 39

Created over 9 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

README.md

RdTools logo

Master branch:

Development branch:

Code coverage:

RdTools is an open-source library to support reproducible technical analysis of time series data from photovoltaic energy systems. The library aims to provide best practice analysis routines along with the building blocks for users to tailor their own analyses. Current applications include the evaluation of PV production over several years to obtain rates of performance degradation and soiling loss. RdTools can handle both high frequency (hourly or better) or low frequency (daily, weekly, etc.) datasets. Best results are obtained with higher frequency data.

RdTools can be installed automatically into Python from PyPI using the command line:

pip install rdtools

For API documentation and full examples, please see the documentation.

RdTools currently is tested on Python 3.9+.

Citing RdTools

To cite RdTools, please use the following along with the version number and the specific DOI coresponding to that version from Zenodo:

Michael G. Deceglie, Kevin Anderson, Adam Shinn, Ambarish Nag, Mark Mikofski, Martin Springer, Jiyang Yan, Kirsten Perry, Sandra Villamar, Will Vining, Gregory Kimball, Daniel Ruth, Noah Moyer, Quyen Nguyen, Dirk Jordan, Matthew Muller, and Chris Deline, RdTools, version {insert version}, Computer Software, https://github.com/NREL/rdtools. DOI:{insert DOI}

The underlying workflow of RdTools has been published in several places. If you use RdTools in a published work, you may also wish to cite the following as appropriate:

Dirk Jordan, Chris Deline, Sarah Kurtz, Gregory Kimball, Michael Anderson, "Robust PV Degradation Methodology and Application", IEEE Journal of Photovoltaics, 8(2) pp. 525-531, 2018, DOI: 10.1109/JPHOTOV.2017.2779779
Michael G. Deceglie, Leonardo Micheli and Matthew Muller, "Quantifying Soiling Loss Directly From PV Yield," in IEEE Journal of Photovoltaics, 8(2), pp. 547-551, 2018, DOI: 10.1109/JPHOTOV.2017.2784682
Kevin Anderson and Ryan Blumenthal, "Overcoming Communications Outages in Inverter Downtime Analysis", 2020 IEEE 47th Photovoltaic Specialists Conference (PVSC)" DOI: 10.1109/PVSC45281.2020.9300635
Kirsten Perry, Matthew Muller and Kevin Anderson, "Performance Comparison of Clipping Detection Techniques in AC Power Time Series," 2021 IEEE 48th Photovoltaic Specialists Conference (PVSC), pp. 1638-1643 2021, DOI: 10.1109/PVSC43889.2021.9518733.

References

The clear sky temperature calculation, clearsky_temperature.get_clearsky_tamb(), uses data from images created by Jesse Allen, NASA’s Earth Observatory using data courtesy of the MODIS Land Group. https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MODLSTDCLIMM https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MODLSTNCLIMM

Other useful references which may also be consulted for degradation rate methodology include:

D. C. Jordan, M. G. Deceglie, S. R. Kurtz, "PV degradation methodology comparison — A basis for a standard", in 43rd IEEE Photovoltaic Specialists Conference, Portland, OR, USA, 2016, DOI: 10.1109/PVSC.2016.7749593.
Jordan DC, Kurtz SR, VanSant KT, Newmiller J, Compendium of Photovoltaic Degradation Rates, Progress in Photovoltaics: Research and Application, 2016, 24(7), 978 - 989.
D. Jordan, S. Kurtz, PV Degradation Rates – an Analytical Review, Progress in Photovoltaics: Research and Application, 2013, 21(1), 12 - 29.
E. Hasselbrink, M. Anderson, Z. Defreitas, M. Mikofski, Y.-C.Shen, S. Caldwell, A. Terao, D. Kavulak, Z. Campeau, D. DeGraaff, "Validation of the PVLife model using 3 million module-years of live site data", 39th IEEE Photovoltaic Specialists Conference, Tampa, FL, USA, 2013, p. 7 – 13, DOI: 10.1109/PVSC.2013.6744087.

Further Instructions and Updates

Check out the wiki for additional usage documentation, and for information on development goals and framework.

Owner

Name: National Renewable Energy Laboratory
Login: NREL
Kind: organization
Location: Golden, CO

Website: http://www.nrel.gov
Repositories: 599
Profile: https://github.com/NREL

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Deceglie"
  given-names: "Michael G."
  orcid: "https://orcid.org/0000-0001-7063-9676"
- family-names: "Anderson"
  given-names: "Kevin"
- family-names: "Shinn"
  given-names: "Adam"
- family-names: "Ambarish"
  given-names: "Nag"
- family-names: "Mikofski"
  given-names: "Mark"
  orcid: "https://orcid.org/0000-0001-8001-8582"
- family-names: "Springer"
  given-names: "Martin"
  orcid: "https://orcid.org/0000-0001-6803-108X"
- family-names: "Yan"
  given-names: "Jiyang"
- family-names: "Perry"
  given-names: "Kirsten"
- family-names: "Villamar"
  given-names: "Sandra"
- family-names: "Vining"
  given-names: "Will"
- family-names: "Kimball"
  given-names: "Gregory M."
  orcid: "https://orcid.org/0000-0003-1075-1417"
- family-names: "Ruth"
  given-names: "Daniel"
- family-names: "Moyer"
  given-names: "Noah"
- family-names: "Nguyen"
  given-names: "Quyen"
- family-names: "Jordan"
  given-names: "Dirk"
  orcid: "https://orcid.org/0000-0002-2183-7489"
- family-names: "Muller"
  given-names: "Matthew"
- family-names: "Deline"
  given-names: "Chris"
  orcid: "https://orcid.org/0000-0002-9867-8930"
title: "RdTools"
doi: 10.5281/zenodo.1210316
url: "https://github.com/NREL/rdtools"

GitHub Events

Total

Create event: 21
Release event: 4
Issues event: 24
Watch event: 12
Delete event: 23
Issue comment event: 70
Push event: 123
Pull request review comment event: 25
Pull request review event: 40
Pull request event: 51
Fork event: 11

Last Year

Create event: 21
Release event: 4
Issues event: 24
Watch event: 12
Delete event: 23
Issue comment event: 70
Push event: 123
Pull request review comment event: 25
Pull request review event: 40
Pull request event: 51
Fork event: 11

Committers

Last synced: 7 months ago

All Time

Total Commits: 951
Total Committers: 25
Avg Commits per committer: 38.04
Development Distribution Score (DDS): 0.609

Past Year

Commits: 261
Committers: 6
Avg Commits per committer: 43.5
Development Distribution Score (DDS): 0.406

Top Committers

Name	Email	Commits
Michael Deceglie	M**e@n**v	372
martin-springer	m**s@g**m	185
Adam Shinn	a**n@g**m	65
Kevin Anderson	5****l	56
Kevin Anderson	k**n@n**v	51
Michael Deceglie	m**i@m**l	42
Michael Deceglie	m**i@m**v	30
Chris Deline	c**e@n**v	28
dependabot[bot]	4****]	25
Perry, Kirsten	K**y@n**v	23
Ambarish Nag	a**g@n**v	21
GregoryKimball	g**l@s**m	12
Perry	k**y@n**v	11
Mark Mikofski	b**o@y**m	7
Michael Deceglie	m**i@s**v	6
Jiyang Yan	j**1@u**u	4
Michael Deceglie	m**i@s**v	4
Michael Deceglie	m**i@s**v	2
Åsmund Skomedal	4****s	1
Michael Deceglie	m**i@s**v	1
Traveler	t**r@M**l	1
martin-springer	m**s@g**m	1
nb137	n****7	1
Will Vining	w**g@g**m	1
Sandra Villamar	1****r	1

Committer Domains (Top 20 + Academic)

nrel.gov: 6 ssl-vpn-10-10-140-10.nrel.gov: 1 ssl-vpn-10-136-240.nrel.gov: 1 ssl-vpn-10-136-28.nrel.gov: 1 uci.edu: 1 ssl-vpn-10-10-137-78.nrel.gov: 1 sunpowercorp.com: 1 mdecegli-30388s.nrel.gov: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 169
Total pull requests: 305
Average time to close issues: 11 months
Average time to close pull requests: about 1 month
Total issue authors: 28
Total pull request authors: 20
Average comments per issue: 1.99
Average comments per pull request: 2.29
Merged pull requests: 239
Bot issues: 0
Bot pull requests: 55

Past Year

Issues: 5
Pull requests: 43
Average time to close issues: N/A
Average time to close pull requests: 18 days
Issue authors: 2
Pull request authors: 6
Average comments per issue: 0.2
Average comments per pull request: 1.37
Merged pull requests: 21
Bot issues: 0
Bot pull requests: 16

View more stats

Top Authors

Issue Authors

mdeceglie (75)
kandersolar (31)
cdeline (13)
abshinn (12)
martin-springer (4)
mikofski (3)
dirkjordan (3)
matsuobasho (2)
traviskemper (2)
computron (2)
amnag (2)
cwhanse (2)
williamhobbs (2)
wfvining (1)
yonsa22 (1)

Pull Request Authors

mdeceglie (93)
kandersolar (83)
dependabot[bot] (63)
martin-springer (37)
cdeline (24)
abshinn (7)
kperrynrel (5)
mikofski (4)
amnag (3)
araval (2)
qnguyen345 (2)
wfvining (2)
noromo01 (2)
GregoryKimball (2)
kevinsa5 (1)

Top Labels

Issue Labels

Fixed in development branch (54) 3.0 Release (9) bug (6) enhancement (5) Proposed API change (3) duplicate (1)

Pull Request Labels

dependencies (67) python (7) APPROVED (5) enhancement (3) bug (2) Fixed in development branch (1)

Packages

Total packages: 3
Total downloads:
- pypi 954 last-month

Total dependent packages: 1
(may contain duplicates)
Total dependent repositories: 3
(may contain duplicates)
Total versions: 41
Total maintainers: 1

pypi.org: rdtools

Functions for reproducible timeseries analysis of photovoltaic systems.

Homepage: https://github.com/NREL/rdtools
Documentation: https://rdtools.readthedocs.io/
License: MIT
Latest release: 3.0.1
published 6 months ago

Versions: 35
Dependent Packages: 1
Dependent Repositories: 3
Downloads: 954 Last month

Rankings

Downloads: 2.1%

Forks count: 5.5%

Average: 6.0%

Stargazers count: 6.2%

Dependent packages count: 7.3%

Dependent repos count: 9.1%

Maintainers (1)

RdTools

Last synced: 6 months ago

proxy.golang.org: github.com/nrel/rdtools

Documentation: https://pkg.go.dev/github.com/nrel/rdtools#section-documentation
License: mit
Latest release: v3.0.1+incompatible
published 6 months ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 7.0%

Average: 8.2%

Dependent repos count: 9.3%

Last synced: 6 months ago

proxy.golang.org: github.com/NREL/rdtools

Documentation: https://pkg.go.dev/github.com/NREL/rdtools#section-documentation
License: mit
Latest release: v3.0.1+incompatible
published 6 months ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 7.0%

Average: 8.2%

Dependent repos count: 9.3%

Last synced: 6 months ago

Dependencies

docs/notebook_requirements.txt pypi

Jinja2 ==2.11.3
MarkupSafe ==1.1.1
Pygments ==2.7.4
Send2Trash ==1.5.0
appnope ==0.1.0
argon2-cffi ==21.2.0
backcall ==0.1.0
bleach ==3.3.0
cffi ==1.15.0
colorama ==0.4.4
decorator ==4.3.0
entrypoints ==0.2.3
html5lib ==1.0.1
ipykernel ==4.8.2
ipython ==7.16.3
ipython-genutils ==0.2.0
ipywidgets ==7.3.0
jedi ==0.12.1
jsonschema ==2.6.0
jupyter ==1.0.0
jupyter-client ==6.1.7
jupyter-console ==6.4.0
jupyter-core ==4.6.3
mistune ==0.8.3
nbconvert ==6.1.0
nbformat ==5.0.7
notebook ==6.4.1
numexpr ==2.8.0
packaging ==20.9
pandocfilters ==1.4.2
parso ==0.3.1
pexpect ==4.6.0
pickleshare ==0.7.5
prometheus-client ==0.3.0
prompt-toolkit ==3.0.27
ptyprocess ==0.6.0
pycparser ==2.20
pyzmq ==22.2.1
qtconsole ==4.3.1
simplegeneric ==0.8.1
terminado ==0.8.3
testpath ==0.3.1
tornado ==6.1
traitlets ==5.0
wcwidth ==0.1.7
webencodings ==0.5.1
widgetsnbextension ==3.3.0

requirements-min.txt pypi

h5py ==2.8.0
matplotlib ==3.0.0
numpy ==1.15
pandas ==0.23.2
plotly ==4.0.0
pvlib ==0.7.0
scikit-learn ==0.22.0
scipy ==1.1.0
statsmodels ==0.9.0
tables ==3.5.1
xgboost ==1.3.3

requirements.txt pypi

Pillow ==9.0.1
cached-property ==1.5.2
certifi ==2020.12.5
chardet ==4.0.0
cycler ==0.10.0
h5py ==3.6.0
idna ==2.10
kiwisolver ==1.3.2
matplotlib ==3.5.0
numpy ==1.21.3
pandas ==1.3.4
patsy ==0.5.2
plotly ==4.10.0
pvlib ==0.9.0
pyparsing ==2.4.7
python-dateutil ==2.8.1
pytz ==2019.3
requests ==2.25.1
scikit-learn ==1.0.2
scipy ==1.7.2
six ==1.14.0
statsmodels ==0.13.1
urllib3 ==1.26.5
xgboost ==1.5.1

.github/workflows/deploy.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite
actions/upload-artifact v2 composite

.github/workflows/flake8.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/nbval.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite
actions/upload-artifact v2 composite

.github/workflows/pytest.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/requirements.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite

setup.py pypi