Metadata-Version: 2.4
Name: rdtools
Version: 3.2.1
Summary: Functions for reproducible timeseries analysis of photovoltaic systems.
Author-email: Rdtools Python Developers <RdTools@nlr.gov>
Maintainer-email: RdTools@nlr.gov
License: MIT
Project-URL: Homepage, https://github.com/NatLabRockies/rdtools
Project-URL: Bug Tracker, https://github.com/NatLabRockies/rdtools/issues
Project-URL: Documentation, https://rdtools.readthedocs.io/
Project-URL: Source Code, https://github.com/NatLabRockies/rdtools
Keywords: photovoltaic,solar,analytics,analysis,performance,degradation,PV
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.5.3
Requires-Dist: numpy>=1.22.4
Requires-Dist: pandas>=1.4.4
Requires-Dist: statsmodels>=0.13.5
Requires-Dist: scipy>=1.8.1
Requires-Dist: h5py>=3.7.0
Requires-Dist: plotly>=4.0.0
Requires-Dist: xgboost>=1.7.0.post0
Requires-Dist: pvlib>=0.13.1
Requires-Dist: scikit-learn!=1.6.0,>=1.1.3
Requires-Dist: arch>=5.6
Requires-Dist: bayesian-filters>=1.4.5
Provides-Extra: doc
Requires-Dist: sphinx==7.4.7; extra == "doc"
Requires-Dist: nbsphinx==0.9.5; extra == "doc"
Requires-Dist: nbsphinx-link==1.3.1; extra == "doc"
Requires-Dist: sphinx_rtd_theme==3.0.1; extra == "doc"
Requires-Dist: ipython; extra == "doc"
Requires-Dist: sphinx-gallery==0.18.0; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest>=3.10.1; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: nbval>=0.10.0; extra == "test"
Requires-Dist: pytest-mock; extra == "test"
Provides-Extra: notebooks
Requires-Dist: jupyter; extra == "notebooks"
Requires-Dist: ipywidgets; extra == "notebooks"
Requires-Dist: numexpr>=2.10.2; extra == "notebooks"
Requires-Dist: tabulate>=0.9.0; extra == "notebooks"
Requires-Dist: lxml; extra == "notebooks"
Provides-Extra: dev
Requires-Dist: rdtools[notebooks,test]; extra == "dev"
Provides-Extra: all
Requires-Dist: rdtools[dev,doc]; extra == "all"
Dynamic: license-file

<img src="./docs/sphinx/source/_images/logo_horizontal_highres.png" width="500" alt="RdTools logo"/>

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

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

Code coverage:
[![codecov](https://codecov.io/gh/NatLabRockies/rdtools/graph/badge.svg?token=K2HDjFkBws)](https://codecov.io/gh/NatLabRockies/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
```

Optional extras are available:

```
pip install rdtools[notebooks]  # Jupyter and notebook dependencies
pip install rdtools[test]       # pytest, coverage, flake8
pip install rdtools[dev]        # notebooks + test combined
```

Alternatively, RdTools uses [pixi](https://pixi.sh) for reproducible
environment management. To get started with pixi, first
[install pixi](https://pixi.sh/latest/#installation), then clone this
repository and run `pixi install` from its root:

```
git clone https://github.com/NatLabRockies/rdtools.git
cd rdtools
pixi install          # default environment (rdtools + notebooks)
pixi run lab          # launch Jupyter Lab
```

For development, use the `dev` environment which includes both notebook
and test dependencies:

```
pixi shell -e dev     # activate the dev environment
pixi run -e dev test  # run pytest with coverage
pixi run -e dev nbval # validate notebooks
pixi run -e dev lab   # launch Jupyter Lab
```

For API documentation and full examples, please see the [documentation](https://rdtools.readthedocs.io).

RdTools currently is tested on Python 3.10+.

## 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, Martin Springer, Kevin Anderson,  Adam Shinn, Kirsten Perry, Ambarish Nag,
   Mark Mikofski, Jiyang Yan, 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/NatLabRockies/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/NatLabRockies/rdtools/wiki) for additional usage documentation, and for information on development goals and framework.

