Merge pull request #20 from NREL/development

fix docs and zenodo badge

Author: martin-springer

README.md

@@ -1,4 +1,4 @@
-<img src="pvdeg_tutorials/PVD_logo.png" width="100">
+<img src="pvdeg_tutorials/pvdeg_logo.png" width="200">
 
 <table>
 <tr>
@@ -12,7 +12,7 @@
 <tr>
   <td>Publications</td>
   <td>
-	[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8088403.svg)](https://doi.org/10.5281/zenodo.8088403)
+     <a href="https://doi.org/10.5281/zenodo.8088578"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8088578.svg" alt="DOI"></a>
   </td>
 </tr>
 <tr>

docs/sphinx/source/_autosummary/pvdeg.design.rst

@@ -13,9 +13,8 @@
 
    .. autosummary::
 
-      edge_seal_from_dew_pt
+      edge_seal_ingress_rate
       edge_seal_width
-      k
 
 
 

docs/sphinx/source/_autosummary/pvdeg.fatigue.rst

@@ -0,0 +1,29 @@
+pvdeg.fatigue
+=============
+
+.. automodule:: pvdeg.fatigue
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      solder_fatigue
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

docs/sphinx/source/_autosummary/pvdeg.humidity.rst

@@ -14,15 +14,15 @@
    .. autosummary::
 
       Ce_numba
-      calc_rel_humidity
+      back_encap
+      backsheet
+      backsheet_from_encap
       dew_yield
+      front_encap
+      module
       psat
-      rh_back_encap
-      rh_backsheet
-      rh_backsheet_from_encap
-      rh_front_encap
-      rh_surface_outside
-      run_calc_rel_humidity
+      run_module
+      surface_outside
 
 
 

docs/sphinx/source/_autosummary/pvdeg.main.rst

@@ -16,6 +16,7 @@
       convert_tmy
       get_kinetics
       gid_downsampling
+      meta_as_dict
       quantile_df
       ts_gid_df
       write_gids

docs/sphinx/source/_autosummary/pvdeg.utilities.rst

@@ -1,27 +1,27 @@
-.. image:: ../../../pvdeg_tutorials/PVD_logo.png
-  :width: 100
+.. image:: ../../../pvdeg_tutorials/pvdeg_logo.png
+  :width: 200
 
 Welcome to pvdeg!
 ==============================================================
 
-This PVDegradation Tools Model is a first-of-its-kind detailed spatio-temporal 
+This PVDegradation Tools Model is a first-of-its-kind detailed spatio-temporal
 modeling assessment tool that empowers users to calculate various PV degradation
 modes, for different PV technologies and materials in its database.
 
-NREL is developing the pvdeg model to help PV Researchers, Module manufacturers, 
-and other PV stakeholders assess different materials and technologies for 
-different degradation modes in all locations throughout the world. Available as 
-open source, the PVDegradation model currently supports PV energy calculations 
-for water vapor pressure, ingress rate, edge seal width, Van Hofft Irradiance 
-Degradation, Weighted Average Irradiance, Arrehnius Acceleration Factor, 
+NREL is developing the pvdeg model to help PV Researchers, Module manufacturers,
+and other PV stakeholders assess different materials and technologies for
+different degradation modes in all locations throughout the world. Available as
+open source, the PVDegradation model currently supports PV energy calculations
+for water vapor pressure, ingress rate, edge seal width, Van Hofft Irradiance
+Degradation, Weighted Average Irradiance, Arrehnius Acceleration Factor,
 relative humidity in the outside, front and back encapsulant and backsheet,
-spectral degradation, and solder fatigue. More functions for standards and 
+spectral degradation, and solder fatigue. More functions for standards and
 other degradation profiles are in the works.
 
 The source code for pvdeg is hosted on `github
 <https://github.com/NREL/pvdeg>`_.
 
-Tutorials to learn how to use and experiment with the various functionalities 
+Tutorials to learn how to use and experiment with the various functionalities
 are available for running interactively through Google Collab at
 `PVDeg JupyterBook<https://nrel.github.io/PVDegradationTools/intro.html>`.
 
@@ -30,15 +30,15 @@ Please see the :ref:`installation` page for installation help.
 How the Model Works
 ===================
 
-Coupled with pvlib for module performan and weather/irradiance calculations, 
-the PVDegradation Tool estimates degradations, and accelerated factors on 
+Coupled with pvlib for module performan and weather/irradiance calculations,
+the PVDegradation Tool estimates degradations, and accelerated factors on
 user-defined parameters. The `Data Library` is under development as part of the
 PVDegradationTool project, compiling literature parameters and functions.
 
-The PVDegradationTool simulatineously reads tens of terabytes of time-series 
+The PVDegradationTool simulatineously reads tens of terabytes of time-series
 solar data from state-of-art resource data set National Solar Radiation Database
- (NSRDB), publicly avialable no the cloud, enabling the execution of pvdeg 
- beyond the confines of NREL's high-performance computing capabilities.
+(NSRDB), publicly avialable no the cloud, enabling the execution of pvdeg
+beyond the confines of NREL's high-performance computing capabilities.
 
 
 Citing PVDegradation Tools
@@ -47,7 +47,7 @@ Citing PVDegradation Tools
 If you use this calculator in a published work, please cite:
 
 
-Please also cite the DOI corresponding to the specific version that you used. 
+Please also cite the DOI corresponding to the specific version that you used.
 DOIs are listed at Zenodo.org
 
 
@@ -62,7 +62,7 @@ Contents
    whatsnew
    installation
    api
-   
+
 
 
 Indices and tables

docs/sphinx/source/index.rst

@@ -2,7 +2,7 @@
 
 from .config import *
 
-from . import cli
+#from . import cli
 from . import collection
 from . import degradation
 from . import design