docs

NREL · Dec 11, 2024 · 0ee3550 · 0ee3550
1 parent 7139e29
commit 0ee3550
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 103 deletions.
diff --git a/docs/source/_autosummary/pvdeg.degradation.deg.rst b/docs/source/_autosummary/pvdeg.degradation.deg.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.deg
+=====================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: deg
diff --git a/docs/source/_autosummary/pvdeg.degradation.rst b/docs/source/_autosummary/pvdeg.degradation.rst
@@ -22,6 +22,7 @@ pvdeg.degradation
       pvdeg.degradation.IwaArrhenius
       pvdeg.degradation.IwaVantHoff
       pvdeg.degradation.arrhenius_deg
+      pvdeg.degradation.deg
       pvdeg.degradation.degradation
       pvdeg.degradation.vantHoff_deg
       pvdeg.degradation.vecArrhenius
@@ -61,6 +62,13 @@ pvdeg.degradation
    .. minigallery:: pvdeg.degradation.arrhenius_deg
        :add-heading:
 
+   .. autofunction:: deg
+
+   .. _sphx_glr_backref_pvdeg.degradation.deg:
+
+   .. minigallery:: pvdeg.degradation.deg
+       :add-heading:
+
    .. autofunction:: degradation
 
    .. _sphx_glr_backref_pvdeg.degradation.degradation:

diff --git a/docs/source/_autosummary/pvdeg.diffusion.esdiffusion.rst b/docs/source/_autosummary/pvdeg.diffusion.esdiffusion.rst
@@ -0,0 +1,6 @@
+pvdeg.diffusion.esdiffusion
+===========================
+
+.. currentmodule:: pvdeg.diffusion
+
+.. autofunction:: esdiffusion
diff --git a/docs/source/_autosummary/pvdeg.geospatial.can_auto_template.rst b/docs/source/_autosummary/pvdeg.geospatial.can_auto_template.rst
@@ -0,0 +1,6 @@
+pvdeg.geospatial.can\_auto\_template
+====================================
+
+.. currentmodule:: pvdeg.geospatial
+
+.. autofunction:: can_auto_template
diff --git a/docs/source/_autosummary/pvdeg.geospatial.rst b/docs/source/_autosummary/pvdeg.geospatial.rst
@@ -24,6 +24,7 @@ pvdeg.geospatial
       pvdeg.geospatial.auto_template
       pvdeg.geospatial.calc_block
       pvdeg.geospatial.calc_gid
+      pvdeg.geospatial.can_auto_template
       pvdeg.geospatial.elevation_stochastic_downselect
       pvdeg.geospatial.feature_downselect
       pvdeg.geospatial.identify_mountains_radii
@@ -88,6 +89,13 @@ pvdeg.geospatial
    .. minigallery:: pvdeg.geospatial.calc_gid
        :add-heading:
 
+   .. autofunction:: can_auto_template
+
+   .. _sphx_glr_backref_pvdeg.geospatial.can_auto_template:
+
+   .. minigallery:: pvdeg.geospatial.can_auto_template
+       :add-heading:
+
    .. autofunction:: elevation_stochastic_downselect
 
    .. _sphx_glr_backref_pvdeg.geospatial.elevation_stochastic_downselect:

diff --git a/docs/source/_autosummary/pvdeg.spectral.calc_full_from_irradiance_340.rst b/docs/source/_autosummary/pvdeg.spectral.calc_full_from_irradiance_340.rst
@@ -0,0 +1,6 @@
+pvdeg.spectral.calc\_full\_from\_irradiance\_340
+================================================
+
+.. currentmodule:: pvdeg.spectral
+
+.. autofunction:: calc_full_from_irradiance_340
diff --git a/docs/source/_autosummary/pvdeg.temperature.fdm_temperature_irradiance.rst b/docs/source/_autosummary/pvdeg.temperature.fdm_temperature_irradiance.rst
@@ -0,0 +1,6 @@
+pvdeg.temperature.fdm\_temperature\_irradiance
+==============================================
+
+.. currentmodule:: pvdeg.temperature
+
+.. autofunction:: fdm_temperature_irradiance
diff --git a/docs/source/whatsnew/index.rst b/docs/source/whatsnew/index.rst
@@ -4,6 +4,7 @@ What's New
 ==========
 PVDegradationTools (pvdeg) change log:
 
+.. include:: releases/v0.4.5.rst
 .. include:: releases/v0.4.4.rst
 .. include:: releases/v0.4.3.rst
 .. include:: releases/v0.4.2.rst

diff --git a/docs/source/whatsnew/releases/v0.4.5.rst b/docs/source/whatsnew/releases/v0.4.5.rst
@@ -0,0 +1,45 @@
+
+v0.4.5 (2024-12-11)
+===================
+
+Breaking Change
+------------
+* Changed function signature of ``pvdeg.degradation.degradation``.  
+    - New function takes ``spectra_df`` instead of ``spectra`` and ``wavelengths`` disparate arguments.
+    Also takes ``conditions_df`` instead of disparate ``rh_module`` and ``temp_module`` pandas series.
+
+        spectra_df : pd.DataFrame
+                front or rear irradiance data in dataframe format
+
+                - `data`: Spectral irradiance values for each wavelength [W/m^2/nm].
+                - `index`: pd.DateTimeIndex
+                - `columns`: Wavelengths as floats (e.g., 280, 300, etc.) [nm].
+
+                Example::
+
+                    timestamp                 280     300     320     340     360     380     400
+                    2021-03-09 10:00:00    0.6892  0.4022  0.6726  0.0268  0.3398  0.9432  0.7411
+                    2021-03-09 11:00:00    0.1558  0.5464  0.6896  0.7828  0.5050  0.9336  0.4652
+                    2021-03-09 12:00:00    0.2278  0.9057  0.2639  0.0572  0.9906  0.9370  0.1800
+                    2021-03-09 13:00:00    0.3742  0.0358  0.4052  0.9578  0.1044  0.8917  0.4876
+
+            conditions_df : pd.DataFrame, optional
+                Environmental conditions including temperature and relative humidity.
+
+                - `index`: pd.DateTimeIndex
+                - `columns`:  (required)
+                    - "temperature" [°C or K]
+                    - "relative_humidity" [%]
+
+                Example::
+
+                    timestamp                 temperature  relative_humidity
+                    2021-03-09 10:00:00         298.0               45.0
+                    2021-03-09 11:00:00         303.0               50.0
+                    2021-03-09 12:00:00         310.0               55.0
+                    2021-03-09 13:00:00         315.0               60.0
+
+
+Contributors
+-----------
+* Tobin Ford (:ghuser:`tobin-ford`)
diff --git a/pvdeg/degradation.py b/pvdeg/degradation.py
@@ -891,7 +891,7 @@ def degradation(
 
         - `data`: Spectral irradiance values for each wavelength [W/m^2 nm].
         - `index`: pd.DateTimeIndex
-        - `columns`: Wavelengths as floats (e.g., 280, 300, etc.).
+        - `columns`: Wavelengths as floats (e.g., 280, 300, etc.) [nm].
 
         Example::
 
@@ -1009,108 +1009,6 @@ def deg(
     return degradation
 
 
-# @deprecated("old double integral degradation function will be replaced 'pvdegradation' in an updated version of pvdeg")
-# def degradation(
-#     spectra: pd.Series,
-#     rh_module: pd.Series,
-#     temp_module: pd.Series,
-#     wavelengths: Union[int, np.ndarray[float]],
-#     Ea: float = 40.0,
-#     n: float = 1.0,
-#     p: float = 0.5,
-#     C2: float = 0.07,
-#     C: float = 1.0,
-# ) -> float:
-#     """
-#     Compute degredation as double integral of Arrhenius (Activation
-#     Energy, RH, Temperature) and spectral (wavelength, irradiance)
-#     functions over wavelength and time.
-
-#     .. math::
-
-#         D = C \\int_{0}^{t} RH(t)^n \\cdot e^{\\frac{-E_a}{RT(t)}} \\int_{\\lambda} [e^{-C_2 \\lambda} \\cdot G(\\lambda, t)]^p d\\lambda dt
-
-#     Parameters
-#     ----------
-#     spectra : pd.Series type=Float
-#         front or rear irradiance at each wavelength in "wavelengths" [W/m^2 nm]
-#     rh_module : pd.Series type=Float
-#         module RH, time indexed [%]
-#     temp_module : pd.Series type=Float
-#         module temperature, time indexed [C]
-#     wavelengths : int-array
-#         integer array (or list) of wavelengths tested w/ uniform delta
-#         in nanometers [nm]
-#     Ea : float
-#         Arrhenius activation energy. The default is 40. [kJ/mol]
-#     n : float
-#         Fit paramter for RH sensitivity. The default is 1.
-#     p : float
-#         Fit parameter for irradiance sensitivity. Typically
-#         0.6 +- 0.22
-#     C2 : float
-#         Fit parameter for sensitivity to wavelength exponential.
-#         Typically 0.07
-#     C : float
-#         Fit parameter for the Degradation equaiton
-#         Typically 1.0
-
-#     Returns
-#     -------
-#     degradation : float
-#         Total degredation factor over time and wavelength.
-#     """
-#     # --- TO DO ---
-#     # unpack input-dataframe
-#     # spectra = df['spectra']
-#     # temp_module = df['temp_module']
-#     # rh_module = df['rh_module']
-
-#     # Constants
-#     R = 0.0083145  # Gas Constant in [kJ/mol*K]
-
-#     wav_bin = list(np.diff(wavelengths))
-#     wav_bin.append(wav_bin[-1])  # Adding a bin for the last wavelength
-
-#     # Integral over Wavelength
-#     try:
-#         irr = pd.DataFrame(spectra.tolist(), index=spectra.index)
-#         irr.columns = wavelengths
-#     except:
-#         # TODO: Fix this except it works on some cases, veto it by cases
-#         print("Removing brackets from spectral irradiance data")
-#         # irr = data['spectra'].str.strip('[]').str.split(',', expand=True).astype(float)
-#         irr = spectra.str.strip("[]").str.split(",", expand=True).astype(float)
-#         irr.columns = wavelengths
-
-
-#     # double integral calculation
-#     sensitivitywavelengths = np.exp(-C2 * wavelengths)
-#     irr = irr * sensitivitywavelengths
-#     irr *= np.array(wav_bin)
-#     irr = irr**p
-#     data = pd.DataFrame(index=spectra.index)
-#     data["G_integral"] = irr.sum(axis=1)
-
-#     EApR = -Ea / R
-#     C4 = np.exp(EApR / temp_module)
-
-#     RHn = rh_module**n
-
-#     data["Arr_integrand"] = C4 * RHn
-
-#     print("arr integral", data["Arr_integrand"])  
-#     print("wavelength integral", data["G_integral"] )
-
-#     data["dD"] = data["G_integral"] * data["Arr_integrand"]
-
-#     print(f"delta degradation ", data["dD"])
-
-#     degradation = C * data["dD"].sum(axis=0)
-
-#     return degradation
-
-
 # change it to take pd.DataFrame? instead of np.ndarray
 @njit
 def vecArrhenius(