Merge branch 'single_axis_tracking' into Kempe-Edge-Seals

Author: MDKempe

pvdeg/spectral.py

@@ -65,6 +65,66 @@ def solar_position(weather_df: pd.DataFrame, meta: dict) -> pd.DataFrame:
     ],
 )
 def poa_irradiance(
+    weather_df: pd.DataFrame,
+    meta: dict,
+    module_mount="fixed",
+    sol_position=None,
+    **kwargs_irradiance,
+) -> pd.DataFrame:
+    """
+    Calculate plane-of-array (POA) irradiance using pvlib based on weather data from the
+    National Solar Radiation Database (NSRDB) for a given location (gid).
+
+    Parameters
+    ----------
+    weather_df : pd.DataFrame
+        The file path to the NSRDB file.
+    meta : dict
+        The geographical location ID in the NSRDB file.
+    module_mount: string
+        Module mounting configuration. Can either be `fixed` for fixed tilt systems or
+        `1_axis` for single-axis tracker systems.
+    sol_position : pd.DataFrame, optional
+        pvlib.solarposition.get_solarposition Dataframe. If none is given, it will be calculated.
+    kwargs_irradiance : dict
+        Contains kwarg arguments for the poa model based on mounting configuration. See
+        `poa_irradiance_fixed` or `poa_irradiance_tracker` for details.
+
+    Returns
+    -------
+    poa : pandas.DataFrame
+         Contains keys/columns 'poa_global', 'poa_direct', 'poa_diffuse',
+         'poa_sky_diffuse', 'poa_ground_diffuse'. [W/m2]
+    """
+
+    if sol_position is None:
+        sol_position = solar_position(weather_df, meta)
+
+    if module_mount == "fixed":
+        poa = poa_irradiance_fixed(weather_df, meta, sol_position, **kwargs_irradiance)
+    elif module_mount == "1_axis":
+        poa = poa_irradiance_tracker(
+            weather_df, meta, sol_position, **kwargs_irradiance
+        )
+    else:
+        raise NotImplementedError(
+            f"The input module_mount '{module_mount}' is not implemented"
+        )
+
+    return poa
+
+
+@geospatial_quick_shape(
+    1,
+    [
+        "poa_global",
+        "poa_direct",
+        "poa_diffuse",
+        "poa_sky_diffuse",
+        "poa_ground_diffuse",
+    ],
+)
+def poa_irradiance_fixed(
     weather_df: pd.DataFrame,
     meta: dict,
     sol_position=None,
@@ -137,6 +197,16 @@ def poa_irradiance(
     return poa
 
 
+@geospatial_quick_shape(
+    1,
+    [
+        "poa_global",
+        "poa_direct",
+        "poa_diffuse",
+        "poa_sky_diffuse",
+        "poa_ground_diffuse",
+    ],
+)
 def poa_irradiance_tracker(
     weather_df: pd.DataFrame,
     meta: dict,