Fixed indentation in run_model_from_poa function

Author: Chirag3841

pvlib/modelchain.py

@@ -19,13 +19,11 @@
 from pvlib.tools import _build_kwargs
 
 from pvlib._deprecation import deprecated
+
 # Keys used to detect input data and assign values to the appropriate
 # ModelChain attributes.
 
-#: tuple[str]
-#: Weather-related input columns used by :class:`ModelChain` to populate
-#: ``ModelChain.weather``. Missing ``temp_air`` or ``wind_speed`` are
-#: automatically filled (20 °C and 0 m/s).
+# Weather-related input columns for ModelChain.weather
 WEATHER_KEYS = (
     'ghi',               # Global Horizontal Irradiance (W/m^2)
     'dhi',               # Diffuse Horizontal Irradiance (W/m^2)
@@ -35,26 +33,22 @@
     'precipitable_water' # Column precipitable water (cm)
 )
 
-#: tuple[str]
-#: Plane-of-array irradiance components used to populate
-#: ``ModelChain.total_irrad`` when running from POA input.
+# Plane-of-array irradiance input columns for ModelChain.total_irrad
 POA_KEYS = (
     'poa_global',   # Total plane-of-array irradiance (W/m^2)
     'poa_direct',   # Direct POA irradiance (W/m^2)
     'poa_diffuse'   # Diffuse POA irradiance (W/m^2)
 )
 
-#: tuple[str]
-#: Temperature-related input columns that override or supplement the
-#: ModelChain temperature model. If ``cell_temperature`` is provided,
-#: the temperature model is skipped.
+# Temperature-related optional input columns for ModelChain
 TEMPERATURE_KEYS = (
     'module_temperature', # Back-surface module temperature (°C)
     'cell_temperature',   # Direct cell temperature input (°C)
 )
-#: tuple[str]
-#: All supported input keys recognized by ModelChain.
+
+# All supported input keys combined
 DATA_KEYS = WEATHER_KEYS + POA_KEYS + TEMPERATURE_KEYS
+
 # these dictionaries contain the default configuration for following
 # established modeling sequences. They can be used in combination with
 # ModelChain, particularly they are used by the methods
@@ -1730,7 +1724,6 @@ def run_model_from_poa(self, data):
             of Arrays in the PVSystem.
         ValueError
             If the DataFrames in `data` have different indexes.
-
         Notes
         -----
         Assigns attributes to results: ``times``, ``weather``,
@@ -1755,7 +1748,6 @@ def run_model_from_poa(self, data):
         self._run_from_effective_irrad(data)
 
         return self
-
     def _run_from_effective_irrad(self, data):
         """
         Executes the temperature, DC, losses and AC models.
@@ -1774,7 +1766,7 @@ def _run_from_effective_irrad(self, data):
 
         Notes
         -----
-        Assigns attributes:``cell_temperature``, ``dc``, ``ac``, ``losses``,
+        Assigns attributes:``cell_temperature, 'dc', ``ac', ``losses``,
         ``diode_params`` (if dc_model is a single diode model).
         """
         self._prepare_temperature(data)
@@ -1815,6 +1807,49 @@ def run_model_from_effective_irradiance(self, data):
             of Arrays in the PVSystem.
         ValueError
             If the DataFrames in `data` have different indexes.
+         Examples
+        --------
+        Single-array system:
+        
+        >>> import pandas as pd
+        >>> from pvlib.pvsystem import PVSystem
+        >>> from pvlib.location import Location
+        >>> from pvlib.modelchain import ModelChain
+        >>>
+        >>> system = PVSystem(module_parameters={'pdc0': 300})
+        >>> location = Location(35, -110)
+        >>> mc = ModelChain(system, location)
+        >>>
+        >>> eff = pd.DataFrame({
+        ...     'effective_irradiance': [900, 920],
+        ...     'temp_air': [25, 24],
+        ...     'wind_speed': [2.0, 1.5],
+        ... },
+        ... index=pd.date_range("2021-06-01", periods=2, freq="H"))
+        >>>
+        >>> mc.run_model_from_effective_irradiance(eff)
+        <pvlib.modelchain.ModelChain ...>
+        
+        Multi-array system:
+        >>> array1 = Array(tilt=30, azimuth=180)
+        >>> array2 = Array(tilt=10, azimuth=90)
+        >>> system = PVSystem(arrays=[array1, array2],
+        ...                   module_parameters={'pdc0': 300})
+        >>> mc = ModelChain(system, location)
+        >>> eff1 = pd.DataFrame({
+        ...     'effective_irradiance': [900, 920],
+        ...     'temp_air': [25, 24],
+        ...     'wind_speed': [2.0, 1.5],
+        ... },
+        ... index=pd.date_range("2021-06-01", periods=2, freq="H"))
+        >>> eff2 = pd.DataFrame({
+        ...     'effective_irradiance': [600, 630],
+        ...     'temp_air': [26, 25],
+        ...     'wind_speed': [1.8, 1.2],
+        ... },
+        ... index=eff1.index)
+        >>> mc.run_model_from_effective_irradiance([eff1, eff2])
+        <pvlib.modelchain.ModelChain ...>
 
         Notes
         -----
@@ -1853,6 +1888,7 @@ def run_model_from_effective_irradiance(self, data):
         return self
 
 
+
 def _irrad_for_celltemp(total_irrad, effective_irradiance):
     """
     Determine irradiance to use for cell temperature models, in order