Skip to content

Fix in ModelChain POA methods by adding examples #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Chirag3841 wants to merge 1 commit into
base: main
Choose a base branch
from
+88 −2
Open

Fix in ModelChain POA methods by adding examples #2602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 88 additions & 2 deletions pvlib/modelchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
# ModelChain, particularly they are used by the methods
# ModelChain.with_pvwatts, ModelChain.with_sapm, etc.



# pvwatts documentation states that it uses the following reference for
# a temperature model: Fuentes, M. K. (1987). A Simplified Thermal Model
# for Flat-Plate Photovoltaic Arrays. SAND85-0330. Albuquerque, NM:
Expand Down Expand Up @@ -1713,6 +1715,48 @@ def run_model_from_poa(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)
>>>
>>> poa = pd.DataFrame({
... 'poa_global': [900, 850],
... 'poa_direct': [600, 560],
... 'poa_diffuse': [300, 290],
... },
... index=pd.date_range("2021-06-01", periods=2, freq="H"))
>>>
>>> mc.run_model_from_poa(poa)
<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)
>>> poa1 = pd.DataFrame({
... 'poa_global': [900, 880],
... 'poa_direct': [600, 580],
... 'poa_diffuse': [300, 300],
... },
... index=pd.date_range("2021-06-01", periods=2, freq="H"))
>>> poa2 = pd.DataFrame({
... 'poa_global': [700, 720],
... 'poa_direct': [400, 420],
... 'poa_diffuse': [300, 300],
... },
... index=poa1.index)
>>> mc.run_model_from_poa([poa1, poa2])
<pvlib.modelchain.ModelChain ...>

Notes
-----
Expand All @@ -1738,7 +1782,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.
Expand All @@ -1757,7 +1800,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)
Expand Down Expand Up @@ -1798,6 +1841,48 @@ 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
-----
Expand Down Expand Up @@ -1836,6 +1921,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
Expand Down