rdtools
An open source library to support reproducible technical analysis of time series data from photovoltaic energy systems.
https://github.com/nrel/rdtools
Category: Renewable Energy
Sub Category: Photovoltaics and Solar Energy
Keywords from Contributors
photovoltaics renewable-energy renewables solar-energy measur archiving transforms projection generic convolutional-neural-networks
Last synced: about 6 hours ago
JSON representation
Repository metadata
PV Analysis Tools in Python
- Host: GitHub
- URL: https://github.com/nrel/rdtools
- Owner: NREL
- License: mit
- Created: 2016-11-18T22:17:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-19T21:13:59.000Z (about 1 month ago)
- Last Synced: 2025-04-19T15:57:02.218Z (8 days ago)
- Language: Python
- Homepage: https://rdtools.readthedocs.io/
- Size: 81.4 MB
- Stars: 162
- Watchers: 24
- Forks: 75
- Open Issues: 34
- Releases: 38
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
README.md
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=MOD_LSTD_CLIM_M
https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MOD_LSTN_CLIM_M
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.
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"
Owner metadata
- Name: National Renewable Energy Laboratory
- Login: NREL
- Email:
- Kind: organization
- Description:
- Website: http://www.nrel.gov
- Location: Golden, CO
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/1906800?v=4
- Repositories: 599
- Last ynced at: 2024-12-18T09:41:07.898Z
- Profile URL: https://github.com/NREL
GitHub Events
Total
- Create event: 18
- Release event: 3
- Issues event: 21
- Watch event: 9
- Delete event: 21
- Issue comment event: 61
- Push event: 118
- Pull request review comment event: 22
- Pull request review event: 40
- Pull request event: 39
- Fork event: 10
Last Year
- Create event: 18
- Release event: 3
- Issues event: 21
- Watch event: 9
- Delete event: 21
- Issue comment event: 61
- Push event: 118
- Pull request review comment event: 22
- Pull request review event: 40
- Pull request event: 39
- Fork event: 10
Committers metadata
Last synced: 8 days ago
Total Commits: 950
Total Committers: 25
Avg Commits per committer: 38.0
Development Distribution Score (DDS): 0.608
Commits in past year: 289
Committers in past year: 5
Avg Commits per committer in past year: 57.8
Development Distribution Score (DDS) in past year: 0.367
Name | 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 | 27 |
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:
- 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
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 168
Total pull requests: 297
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: 2.01
Average comments per pull request: 2.38
Merged pull request: 239
Bot issues: 0
Bot pull requests: 46
Past year issues: 8
Past year pull requests: 45
Past year average time to close issues: 4 months
Past year average time to close pull requests: 22 days
Past year issue authors: 3
Past year pull request authors: 7
Past year average comments per issue: 0.75
Past year average comments per pull request: 2.02
Past year merged pull request: 30
Past year bot issues: 0
Past year bot pull requests: 8
Top Issue Authors
- mdeceglie (75)
- kandersolar (31)
- abshinn (12)
- cdeline (10)
- martin-springer (7)
- mikofski (3)
- dirkjordan (3)
- matsuobasho (2)
- traviskemper (2)
- computron (2)
- amnag (2)
- cwhanse (2)
- williamhobbs (2)
- wfvining (1)
- yonsa22 (1)
Top Pull Request Authors
- mdeceglie (91)
- kandersolar (82)
- dependabot[bot] (46)
- martin-springer (31)
- cdeline (15)
- abshinn (7)
- mikofski (4)
- kperrynrel (4)
- amnag (3)
- araval (2)
- wfvining (2)
- GregoryKimball (2)
- yjy1663 (1)
- noromo01 (1)
- BMcDonie (1)
Top Issue Labels
- Fixed in development branch (54)
- 3.0 Release (10)
- bug (6)
- enhancement (5)
- Proposed API change (3)
- duplicate (1)
Top Pull Request Labels
- dependencies (50)
- APPROVED (5)
- enhancement (3)
- bug (2)
- Fixed in development branch (1)
Package metadata
- Total packages: 3
-
Total downloads:
- pypi: 1,461 last-month
- Total dependent packages: 1 (may contain duplicates)
- Total dependent repositories: 3 (may contain duplicates)
- Total versions: 38
- 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/
- Licenses: MIT
- Latest release: 3.0.0 (published 3 months ago)
- Last Synced: 2025-04-26T14:38:13.063Z (1 day ago)
- Versions: 34
- Dependent Packages: 1
- Dependent Repositories: 3
- Downloads: 1,461 Last month
-
Rankings:
- Downloads: 2.091%
- Forks count: 5.481%
- Average: 6.04%
- Stargazers count: 6.18%
- Dependent packages count: 7.306%
- Dependent repos count: 9.139%
- Maintainers (1)
proxy.golang.org: github.com/nrel/rdtools
- Homepage:
- Documentation: https://pkg.go.dev/github.com/nrel/rdtools#section-documentation
- Licenses:
- Latest release: v1.2.0 (published about 7 years ago)
- Last Synced: 2025-04-26T14:38:12.860Z (1 day ago)
- Versions: 2
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%
proxy.golang.org: github.com/NREL/rdtools
- Homepage:
- Documentation: https://pkg.go.dev/github.com/NREL/rdtools#section-documentation
- Licenses:
- Latest release: v1.2.0 (published about 7 years ago)
- Last Synced: 2025-04-26T14:38:13.373Z (1 day ago)
- Versions: 2
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%
Dependencies
- 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
- 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
- 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
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
Score: 15.787283366545314