fix sphinx errors

NREL · May 22, 2023 · 776cb56 · 776cb56
1 parent 01245cb
commit 776cb56
Show file tree

Hide file tree

Showing 12 changed files with 348 additions and 40 deletions.
diff --git a/PVDegradationTools/main.py b/PVDegradationTools/main.py
@@ -468,7 +468,6 @@ def rh_back_encap(rh_ambient, temp_ambient, temp_module,
         --------  
         RHback_series : pandas series (float)
             Relative Humidity of Backside Solar Module Encapsulant     
-
         """
 
         rh_surface = StressFactors.rh_surface_outside(rh_ambient=rh_ambient,
@@ -508,17 +507,14 @@ def rh_backsheet_from_encap(rh_back_encap, rh_surface_outside):
         Parameters
         ----------
         rh_back_encap : pandas series (float)
-            Relative Humidity of Frontside Solar module Encapsulant. *See rh_back_encap()
+            Relative Humidity of Frontside Solar module Encapsulant. See rh_back_encap().
         rh_surface_outside : pandas series (float)
-            The relative humidity of the surface of a solar module. *See rh_surface_outside()
+            The relative humidity of the surface of a solar module. See rh_surface_outside().
 
         Returns
-        --------
+        -------
         RHbacksheet_series : pandas series (float)
-            Relative Humidity of Backside Backsheet of a Solar Module
-
-        @return rh_Surface     -
-\                             
+            Relative Humidity of Backside Backsheet of a Solar Module                 
         """
 
         RHbacksheet_series = (rh_back_encap + rh_surface_outside)/2
@@ -527,7 +523,8 @@ def rh_backsheet_from_encap(rh_back_encap, rh_surface_outside):
 
     def rh_backsheet(rh_ambient, temp_ambient, temp_module,
                     WVTRo=7970633554, EaWVTR=55.0255, So=1.81390702, l=0.5, Eas=16.729):
-        """Function to calculate the Relative Humidity of solar module backsheet as timeseries.
+        """
+        Function to calculate the Relative Humidity of solar module backsheet as timeseries.
         This function uses the same formula as StressFactors.rh_backsheet_from_encap but does
         not require you to independently solve for the backside ecapsulant and surface humidity
         before calculation. 
@@ -803,8 +800,8 @@ def _to_eq_vantHoff(temp_cell, Tf=1.41):
     def IwaVantHoff(poa_global, temp_cell, Teq=None, x=0.5, Tf=1.41):
         """
         IWa : Environment Characterization (W/m²)
-        *for one year of degredation the controlled environmnet lamp settings will
-            need to be set to IWa
+        For one year of degredation the controlled environmnet lamp settings will
+        need to be set to IWa.
 
         Parameters
         -----------
@@ -1024,15 +1021,15 @@ def _RH_wa_arrhenius(rh_outdoor, temp_cell, Ea, Teq=None, n=1):
 
         return RHwa
 
+
+    #TODO:   CHECK
+    # STANDARDIZE
     def IwaArrhenius(poa_global, rh_outdoor, temp_cell, Ea,
                      RHwa=None, Teq=None, x=0.5, n=1):
         """
-        TODO:   CHECK
-                STANDARDIZE
-
-        Function to calculate IWa, the Environment Characterization (W/m²)
-        *for one year of degredation the controlled environmnet lamp settings will
-            need to be set at IWa
+        Function to calculate IWa, the Environment Characterization (W/m²).
+        For one year of degredation the controlled environmnet lamp settings will
+        need to be set at IWa.
 
         Parameters
         ----------
@@ -1041,8 +1038,7 @@ def IwaArrhenius(poa_global, rh_outdoor, temp_cell, Ea,
         rh_outdoor : pandas series
             Relative Humidity of material of interest
             Acceptable relative humiditys can be calculated
-            from these functions: rh_backsheet(), rh_back_encap(), rh_front_encap()
-                                  rh_surface_outside()
+            from these functions: rh_backsheet(), rh_back_encap(), rh_front_encap(), rh_surface_outside()
         temp_cell : pandas series
             Solar module temperature or Cell temperature [°C]
         Ea : float
@@ -1061,7 +1057,6 @@ def IwaArrhenius(poa_global, rh_outdoor, temp_cell, Ea,
         --------
         Iwa : float
             Environment Characterization (W/m²)
-
         """
         if Teq is None:
             Teq = Degradation._T_eq_arrhenius(temp_cell, Ea)

diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.collection.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.collection.rst
@@ -0,0 +1,32 @@
+PVDegradationTools.collection
+=============================
+
+.. automodule:: PVDegradationTools.collection
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      calculate_jsc_from_tau_cp
+      calculate_jsc_from_tau_iqe
+      collection_probability
+      generation_current
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.humidity.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.humidity.rst
@@ -0,0 +1,37 @@
+PVDegradationTools.humidity
+===========================
+
+.. automodule:: PVDegradationTools.humidity
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      Ce_numba
+      calc_rel_humidity
+      psat
+      rh_back_encap
+      rh_backsheet
+      rh_backsheet_from_encap
+      rh_front_encap
+      rh_surface_outside
+      run_calc_rel_humidity
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.letid.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.letid.rst
@@ -0,0 +1,42 @@
+PVDegradationTools.letid
+========================
+
+.. automodule:: PVDegradationTools.letid
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      calc_device_params
+      calc_dn
+      calc_energy_loss
+      calc_ndd
+      calc_pmp_loss_from_tau_loss
+      calc_regeneration_time
+      calc_voc_from_tau
+      carrier_factor
+      carrier_factor_wafer
+      convert_i_to_v
+      ff_green
+      j0_gray
+      k_ij
+      tau_now
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.main.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.main.rst
@@ -0,0 +1,31 @@
+PVDegradationTools.main
+=======================
+
+.. automodule:: PVDegradationTools.main
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Degradation
+      Scenario
+      StressFactors
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.spectral.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.spectral.rst
@@ -0,0 +1,30 @@
+PVDegradationTools.spectral
+===========================
+
+.. automodule:: PVDegradationTools.spectral
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      poa_irradiance
+      solar_position
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.standards.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.standards.rst
@@ -0,0 +1,31 @@
+PVDegradationTools.standards
+============================
+
+.. automodule:: PVDegradationTools.standards
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      calc_standoff
+      eff_gap
+      run_calc_standoff
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.temperature.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.temperature.rst
@@ -0,0 +1,29 @@
+PVDegradationTools.temperature
+==============================
+
+.. automodule:: PVDegradationTools.temperature
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      module
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.utilities.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.utilities.rst
@@ -0,0 +1,34 @@
+PVDegradationTools.utilities
+============================
+
+.. automodule:: PVDegradationTools.utilities
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      convert_tmy
+      get_kinetics
+      gid_downsampling
+      quantile_df
+      ts_gid_df
+      write_gids
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/PVDegradationTools.weather.rst b/docs/sphinx/source/_autosummary/PVDegradationTools.weather.rst
@@ -0,0 +1,33 @@
+PVDegradationTools.weather
+==========================
+
+.. automodule:: PVDegradationTools.weather
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      get_NSRDB
+      get_NSRDB_fnames
+      load
+      read_file
+      read_h5
+
+
+
+
+
+
+
+
+
+
+
+
+