NREL · martin-springer · Feb 9, 2024 · Jan 30, 2024 · Jan 30, 2024 · Jan 30, 2024
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please provide a minimal example to reproduce the issue 
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - pvdeg version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches:
     - main
-    - dev
+    - development
   pull_request:
 
 
@@ -20,9 +20,9 @@ jobs:
         ]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install ${{ matrix.env }}
@@ -31,4 +31,8 @@ jobs:
         python -m pip install --progress-bar off ${{ matrix.env }}
     - name: Test with pytest ${{ matrix.env }}
       run: |
-        python -m pytest
+        python -m pytest --cov=./ --cov-report=xml
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v4
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,7 +17,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/sphinx/source/conf.py
+   configuration: docs/source/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:

diff --git a/README.md b/README.md
@@ -23,6 +23,17 @@
 	</a>
   </td>
 </tr>
+<tr>
+  <td>Build status</td>
+  <td>
+   <a href="https://github.com/NREL/PVDegradationTools/actions/workflows/pytest.yml?query=branch%3Amain">
+      <img src="https://github.com/NREL/PVDegradationTools/actions/workflows/pytest.yml/badge.svg?branch=main" alt="GitHub Actions Testing Status" />
+   </a>
+   <a href="https://codecov.io/gh/NREL/PVDegradationTools" >
+   <img src="https://codecov.io/gh/NREL/PVDegradationTools/graph/badge.svg?token=4I24S8BTG7"/>
+   </a>
+  </td>
+</tr>
 </table>
 
 

diff --git a/contributors/martin-springer.md b/contributors/martin-springer.md
@@ -0,0 +1,11 @@
+2024-02-09
+
+I hereby agree to the terms of the Contributors License Agreement,
+version 1.0, with MD5 checksum 46ea45f996295bdb0652333d516a6d0a.
+
+I furthermore declare that I am authorized and able to make this
+agreement and sign this declaration.
+
+Signed,
+
+Martin Springer https://github.com/martin-springer
diff --git a/docs/sphinx/Makefile → docs/Makefile b/docs/sphinx/Makefile → docs/Makefile
diff --git a/docs/sphinx/make.bat → docs/make.bat b/docs/sphinx/make.bat → docs/make.bat
@@ -10,8 +10,6 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=source
 set BUILDDIR=build
 
-if "%1" == "" goto help
-
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -21,10 +19,12 @@ if errorlevel 9009 (
 	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
+	echo.https://www.sphinx-doc.org/
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 

diff --git a/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_cp.rst b/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_cp.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.calculate\_jsc\_from\_tau\_cp
+==============================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: calculate_jsc_from_tau_cp
diff --git a/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_iqe.rst b/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_iqe.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.calculate\_jsc\_from\_tau\_iqe
+===============================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: calculate_jsc_from_tau_iqe
diff --git a/docs/source/_autosummary/pvdeg.collection.collection_probability.rst b/docs/source/_autosummary/pvdeg.collection.collection_probability.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.collection\_probability
+========================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: collection_probability
diff --git a/docs/source/_autosummary/pvdeg.collection.generation_current.rst b/docs/source/_autosummary/pvdeg.collection.generation_current.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.generation\_current
+====================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: generation_current
diff --git a/docs/source/_autosummary/pvdeg.collection.rst b/docs/source/_autosummary/pvdeg.collection.rst
@@ -0,0 +1,77 @@
+.. Please when editing this file make sure to keep it matching the
+   docs in ../configuration.rst:reference_to_examples
+
+pvdeg.collection
+================
+
+.. automodule:: pvdeg.collection
+
+   .. this is crazy  
+
+
+
+
+   Function Overview
+   -----------------
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+
+      pvdeg.collection.calculate_jsc_from_tau_cp
+      pvdeg.collection.calculate_jsc_from_tau_iqe
+      pvdeg.collection.collection_probability
+      pvdeg.collection.generation_current
+
+
+
+
+   .. this is crazy  
+
+
+
+
+.. 
+   Functions
+   ---------
+
+
+
+   .. autofunction:: calculate_jsc_from_tau_cp
+
+   .. _sphx_glr_backref_pvdeg.collection.calculate_jsc_from_tau_cp:
+
+   .. minigallery:: pvdeg.collection.calculate_jsc_from_tau_cp
+       :add-heading:
+
+   .. autofunction:: calculate_jsc_from_tau_iqe
+
+   .. _sphx_glr_backref_pvdeg.collection.calculate_jsc_from_tau_iqe:
+
+   .. minigallery:: pvdeg.collection.calculate_jsc_from_tau_iqe
+       :add-heading:
+
+   .. autofunction:: collection_probability
+
+   .. _sphx_glr_backref_pvdeg.collection.collection_probability:
+
+   .. minigallery:: pvdeg.collection.collection_probability
+       :add-heading:
+
+   .. autofunction:: generation_current
+
+   .. _sphx_glr_backref_pvdeg.collection.generation_current:
+
+   .. minigallery:: pvdeg.collection.generation_current
+       :add-heading:
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/pvdeg.degradation.IwaArrhenius.rst b/docs/source/_autosummary/pvdeg.degradation.IwaArrhenius.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.IwaArrhenius
+==============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: IwaArrhenius
diff --git a/docs/source/_autosummary/pvdeg.degradation.IwaVantHoff.rst b/docs/source/_autosummary/pvdeg.degradation.IwaVantHoff.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.IwaVantHoff
+=============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: IwaVantHoff
diff --git a/docs/source/_autosummary/pvdeg.degradation.arrhenius_deg.rst b/docs/source/_autosummary/pvdeg.degradation.arrhenius_deg.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.arrhenius\_deg
+================================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: arrhenius_deg
diff --git a/docs/source/_autosummary/pvdeg.degradation.degradation.rst b/docs/source/_autosummary/pvdeg.degradation.degradation.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.degradation
+=============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: degradation
diff --git a/docs/source/_autosummary/pvdeg.degradation.rst b/docs/source/_autosummary/pvdeg.degradation.rst
@@ -0,0 +1,85 @@
+.. Please when editing this file make sure to keep it matching the
+   docs in ../configuration.rst:reference_to_examples
+
+pvdeg.degradation
+=================
+
+.. automodule:: pvdeg.degradation
+
+   .. this is crazy  
+
+
+
+
+   Function Overview
+   -----------------
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+
+      pvdeg.degradation.IwaArrhenius
+      pvdeg.degradation.IwaVantHoff
+      pvdeg.degradation.arrhenius_deg
+      pvdeg.degradation.degradation
+      pvdeg.degradation.vantHoff_deg
+
+
+
+
+   .. this is crazy  
+
+
+
+
+.. 
+   Functions
+   ---------
+
+
+
+   .. autofunction:: IwaArrhenius
+
+   .. _sphx_glr_backref_pvdeg.degradation.IwaArrhenius:
+
+   .. minigallery:: pvdeg.degradation.IwaArrhenius
+       :add-heading:
+
+   .. autofunction:: IwaVantHoff
+
+   .. _sphx_glr_backref_pvdeg.degradation.IwaVantHoff:
+
+   .. minigallery:: pvdeg.degradation.IwaVantHoff
+       :add-heading:
+
+   .. autofunction:: arrhenius_deg
+
+   .. _sphx_glr_backref_pvdeg.degradation.arrhenius_deg:
+
+   .. minigallery:: pvdeg.degradation.arrhenius_deg
+       :add-heading:
+
+   .. autofunction:: degradation
+
+   .. _sphx_glr_backref_pvdeg.degradation.degradation:
+
+   .. minigallery:: pvdeg.degradation.degradation
+       :add-heading:
+
+   .. autofunction:: vantHoff_deg
+
+   .. _sphx_glr_backref_pvdeg.degradation.vantHoff_deg:
+
+   .. minigallery:: pvdeg.degradation.vantHoff_deg
+       :add-heading:
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/pvdeg.degradation.vantHoff_deg.rst b/docs/source/_autosummary/pvdeg.degradation.vantHoff_deg.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.vantHoff\_deg
+===============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: vantHoff_deg
diff --git a/docs/source/_autosummary/pvdeg.design.edge_seal_ingress_rate.rst b/docs/source/_autosummary/pvdeg.design.edge_seal_ingress_rate.rst
@@ -0,0 +1,6 @@
+pvdeg.design.edge\_seal\_ingress\_rate
+======================================
+
+.. currentmodule:: pvdeg.design
+
+.. autofunction:: edge_seal_ingress_rate
diff --git a/docs/source/_autosummary/pvdeg.design.edge_seal_width.rst b/docs/source/_autosummary/pvdeg.design.edge_seal_width.rst
@@ -0,0 +1,6 @@
+pvdeg.design.edge\_seal\_width
+==============================
+
+.. currentmodule:: pvdeg.design
+
+.. autofunction:: edge_seal_width