Skip to main content

Pvdeg is a python library that supports the calculation of degradation related parameters for photovoltaic (PV) modules.

Project description

License license
Publications DOI
Documentation Documentation Status
Build status GitHub Actions Testing Status

PVDeg: Python Package for Modeling Degradation in Photovoltaic Systems

PVDeg is an open-source Python package for modeling photovoltaic (PV) degradation, developed at the National Laboratory of the Rockies (NLR, formerly NREL) and supported by the Durable Module Materials (DuraMAT) consortium. It provides modular functions, materials databases, and calculation workflows for simulating degradation mechanisms (e.g., LeTID, hydrolysis, UV exposure) using weather data from the National Solar Radiation Database (NSRDB) and the Photovoltaic Geographical Information System (PVGIS). By integrating Monte Carlo uncertainty propagation and geospatial processing, PVDeg enables field-relevant predictions and uncertainty quantification of module reliability and lifetime.

Key Features

  • Core Degradation Functions: Dedicated functions for physical degradation mechanisms including moisture ingress, LeTID, UV exposure, and thermal stress
  • Scenario Class: Simplified workflow interface for complex multi-parameter degradation studies
  • Geospatial Analysis: Large-scale spatial analyses with parallel processing across geographic regions
  • Monte Carlo Framework: Uncertainty quantification through parameter distribution sampling
  • Material Databases: Curated degradation parameters, kinetic coefficients, and material properties
  • Weather Data Integration: Seamless access to NSRDB and PVGIS meteorological data
  • Standards Support: Contributions to IEC TS 63126 and other standardization efforts

Example Applications

PVDeg has been adopted in multiple studies across the PV reliability community:

  • Thermal Stability and IEC TS 63126 Compliance: Calculate effective standoff distances and generate public maps supporting the IEC TS 63126 standard
  • Light and Elevated Temperature Induced Degradation (LeTID): Integrated into international interlaboratory comparison studies and field-aged array analyses
  • Geospatial Performance Modeling: Coupled with GeoGridFusion to streamline weather-data storage and spatial queries for large-scale degradation simulations
  • Agrivoltaics and System-Level Modeling: Combined with PySAM to assess degradation-driven yield losses in dual-use agrivoltaic systems
  • Material-Property Parameterization: Studies of UV-induced polymer degradation and moisture-related failures in encapsulants and backsheets

Documentation

Full documentation is available at ReadTheDocs including:

Installation

PVDeg releases may be installed using pip and conda tools. Compatible with Python 3.10 and above.

Quick Install:

pip install pvdeg

With optional dependencies:

Group Install Command Purpose
sam pip install pvdeg[sam] PySAM support for system modeling
docs pip install pvdeg[docs] Sphinx documentation tools
test pip install pvdeg[test] Testing and validation tools
books pip install pvdeg[books] Jupyter Book publishing
all pip install pvdeg[all] All optional dependencies

Developer Installation:

git clone https://github.com/NatLabRockies/PVDegradationTools.git
cd PVDegradationTools
pip install -e .[all]

📖 For detailed installation instructions including conda environments, HPC setup, troubleshooting, and version compatibility, see the Installation Guide.

Tutorials

PVDeg provides comprehensive tutorials organized by topic. Choose your preferred environment:

Jupyter Book (Recommended)

Interactive tutorials with live execution: PVDeg Jupyter Book

  • Click the 🚀 rocket icon to launch notebooks in Google Colab
  • Development Preview: See latest changes at dev-preview

Binder

Run tutorials in your browser without installation: Binder

Local Installation

  1. Install PVDeg (see Installation)

  2. Clone the repository to access tutorial notebooks:

    git clone https://github.com/NatLabRockies/PVDegradationTools.git
    cd PVDegradationTools
    
  3. Start Jupyter:

    jupyter notebook
    
  4. Navigate to tutorials organized by category:

    • 01_basics/ - Introduction to PVDeg fundamentals
    • 02_degradation/ - Degradation mechanism modeling
    • 03_monte_carlo/ - Monte Carlo uncertainty analysis
    • 04_geospatial/ - Geospatial and HPC scenarios
    • 05_advanced/ - Advanced topics and API access
    • 10_workshop_demos/ - Workshop demonstrations
    • tools/ - Standalone analysis tools

📖 For more information on running and validating notebooks, see the documentation.

License

BSD 3-clause

Contributing

We welcome contributions to this software! Please see CONTRIBUTING.md for detailed instructions on:

  • Setting up your development environment
  • Installing and using pre-commit hooks
  • Code style guidelines
  • Testing and documentation requirements
  • Contributing to material property and degradation parameter databases
  • Submitting pull requests

Please read the copyright license agreement (cla-1.0.md), with instructions on signing it in sign-CLA.md.

All code, documentation, and discussion contributors are acknowledged for their contributions to the PVDeg project.

Getting support

If you suspect that you may have discovered a bug or if you'd like to change something about PVDeg, then please make an issue on our GitHub issues page.

Citing

If you use PVDeg in a published work, please cite both the software and the paper.

Software Citation:

Click the "Cite this repository" button in the right sidebar to get a formatted citation, or visit Zenodo for the DOI corresponding to your specific version:

DOI

On the Zenodo page, use the "Cite as" section in the right sidebar to copy the citation in your preferred format (BibTeX, APA, etc.).

JOSS Paper (In Review):

Daxini, R., Ovaitt, S., Springer, M., Ford, T., & Kempe, M. (2025). PVDeg: a python package for modeling degradation on solar photovoltaic systems. Journal of Open Source Software (In Review).

Acknowledgements

This work was authored in part by the National Laboratory of the Rockies for the U.S. Department of Energy (DOE), operated under Contract No. DE-AC36-08GO28308. Funding provided as part of the Durable Module Materials Consortium 2 (DuraMAT 2) funded by the by U.S. DOE Office of Critical Minerals and Energy Innovation (CMEI) Solar Energy Technologies Office (SETO), Agreement 38259. The views expressed in the article do not necessarily represent the views of the DOE or the U.S. Government. The U.S. Government retains and the publisher, by accepting the article for publication, acknowledges that the U.S. Government retains a nonexclusive, paid-up, irrevocable, worldwide license to publish or reproduce the published form of this work, or allow others to do so, for U.S. Government purposes

HPC disclaimer: A portion of This research was performed using computational resources sponsored by the U.S. Department of Energy's Office of Critical Minerals and Energy Innovation and located at the National Laboratory of the Rockies.

NLR Software Record: SWR-20-71 (Holsapple, Derek; Ayala Pelaez, Silvana; Kempe, Michael. "PV Degradation Tools", NLR Github 2020)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pvdeg-0.7.1.tar.gz (30.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pvdeg-0.7.1-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file pvdeg-0.7.1.tar.gz.

File metadata

  • Download URL: pvdeg-0.7.1.tar.gz
  • Upload date:
  • Size: 30.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pvdeg-0.7.1.tar.gz
Algorithm Hash digest
SHA256 84110fe6658721c0c13c56f2293cc31ff87d852a4439eb283aa45c18c2d08fae
MD5 3fb89ab5d8fd9176dd5bddf9ca26853e
BLAKE2b-256 cba0bb51e2e7ec8f54680348c9b9ac1ccc78a589468646b24084a0e9f2d6efd9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pvdeg-0.7.1.tar.gz:

Publisher: publish-to-pypi.yml on NatLabRockies/PVDegradationTools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pvdeg-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: pvdeg-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pvdeg-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 92672fdfeaf3f38e306765e10648ebe59cdcfebe435dc999b2efab264c79c388
MD5 e60e3f0ae23bdad953ea55d7c5f8a352
BLAKE2b-256 454dbad39545dee3e8b97c267e948840e60d4bf84a9a0f9a32f467d157f486ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for pvdeg-0.7.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on NatLabRockies/PVDegradationTools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page