Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Browse accepted projects | Review proposed projects | Propose new project | Open Issues

rdtools

An open source library to support reproducible technical analysis of time series data from photovoltaic energy systems.
https://github.com/nrel/rdtools

Last synced: about 16 hours ago
JSON representation

Repository metadata

PV Analysis Tools in Python

README

        

RdTools logo

Master branch:
[![Build Status](https://github.com/NREL/rdtools/workflows/pytest/badge.svg?branch=master)](https://github.com/NREL/rdtools/actions?query=branch%3Amaster)

Development branch:
[![Build Status](https://github.com/NREL/rdtools/workflows/pytest/badge.svg?branch=development)](https://github.com/NREL/rdtools/actions?query=branch%3Adevelopment)

Code coverage:
[![codecov](https://codecov.io/gh/NREL/rdtools/graph/badge.svg?token=K2HDjFkBws)](https://codecov.io/gh/NREL/rdtools)

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](https://rdtools.readthedocs.io).

RdTools currently is tested on Python 3.7+.

## Citing RdTools

To cite RdTools, please use the following along with the version number
and the specific DOI coresponding to that version from [Zenodo](https://doi.org/10.5281/zenodo.1210316):

- Michael G. Deceglie, Ambarish Nag, Adam Shinn, Gregory Kimball,
Daniel Ruth, Dirk Jordan, Jiyang Yan, Kevin Anderson, Kirsten Perry,
Mark Mikofski, Matthew Muller, Will Vining, and Chris Deline
RdTools, version {insert version}, Compuer 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](https://doi.org/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](https://doi.org/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](https://doi.org/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](https://doi.org/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](https://github.com/NREL/rdtools/wiki) for additional usage documentation, and for information on development goals and framework.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 597
Total Committers: 24
Avg Commits per committer: 24.875
Development Distribution Score (DDS): 0.585

Commits in past year: 56
Committers in past year: 6
Avg Commits per committer in past year: 9.333
Development Distribution Score (DDS) in past year: 0.482

Name Email Commits
Michael Deceglie m****e@n****v 248
Adam Shinn a****n@g****m 65
Kevin Anderson 5****l 55
Kevin Anderson k****n@n****v 48
Michael Deceglie m****i@m****l 42
Michael Deceglie m****i@m****v 30
Chris Deline c****e@n****v 22
Ambarish Nag a****g@n****v 21
dependabot[bot] 4****] 18
GregoryKimball g****l@s****m 12
Mark Mikofski b****o@y****m 7
Michael Deceglie m****i@s****v 6
martin-springer m****s@g****m 5
Michael Deceglie m****i@s****v 4
Jiyang Yan j****1@u****u 4
Michael Deceglie m****i@s****v 2
Kirsten Perry 7****l 1
Martin Springer 9****r 1
Sandra Villamar 1****r 1
Will Vining w****g@g****m 1
nb137 n****7 1
Michael Deceglie m****i@s****v 1
Traveler t****r@M****l 1
martin-springer m****s@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 161
Total pull requests: 253
Average time to close issues: 8 months
Average time to close pull requests: about 1 month
Total issue authors: 28
Total pull request authors: 18
Average comments per issue: 1.92
Average comments per pull request: 2.41
Merged pull request: 205
Bot issues: 0
Bot pull requests: 38

Past year issues: 17
Past year pull requests: 28
Past year average time to close issues: about 1 month
Past year average time to close pull requests: about 1 month
Past year issue authors: 9
Past year pull request authors: 4
Past year average comments per issue: 1.06
Past year average comments per pull request: 1.14
Past year merged pull request: 18
Past year bot issues: 0
Past year bot pull requests: 13

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

Top Issue Authors

  • mdeceglie (73)
  • kandersolar (31)
  • abshinn (12)
  • cdeline (10)
  • dirkjordan (3)
  • mikofski (3)
  • matsuobasho (2)
  • amnag (2)
  • williamhobbs (2)
  • computron (2)
  • cwhanse (2)
  • traviskemper (2)
  • martin-springer (2)
  • matt14muller (1)
  • shirubana (1)

Top Pull Request Authors

  • mdeceglie (84)
  • kandersolar (81)
  • dependabot[bot] (38)
  • cdeline (15)
  • abshinn (7)
  • martin-springer (6)
  • mikofski (4)
  • amnag (3)
  • kperrynrel (3)
  • araval (2)
  • wfvining (2)
  • GregoryKimball (2)
  • SandraVillamar (1)
  • nb137 (1)
  • kevinsa5 (1)

Top Issue Labels

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

Top Pull Request Labels

  • dependencies (42)
  • APPROVED (5)
  • enhancement (3)
  • bug (2)
  • Fixed in development branch (1)

Package metadata

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: 2.1.8 (published 6 months ago)
  • Last Synced: 2024-05-10T09:03:57.732Z (1 day ago)
  • Versions: 30
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 1,116 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 6 years ago)
  • Last Synced: 2024-05-10T09:03:58.367Z (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 6 years ago)
  • Last Synced: 2024-05-10T09:03:58.028Z (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

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

Score: 15.492442619361578