pvlib 0.9.4a1__tar.gz → 0.10.0__tar.gz

pvlib-0.10.0/AUTHORS.md

@@ -0,0 +1,35 @@
+About the Copyright Holders
+===========================
+
+*   Copyright (c) 2023 pvlib python Contributors
+*   Copyright (c) 2014 PVLIB python Development Team
+*   Copyright (c) 2013 Sandia National Laboratories
+
+    The pvlib python Contributors comprises all authors of content of the pvlib python project.
+    A complete list of contributors can be found in the documentation.
+
+    The PVLIB python Development Team is the collection of developers of the
+    pvlib python project. Members of this team are included in the pvlib python Contributors.
+
+    Sandia National Laboratories originally developed pvlib python based on code in
+    PVLib MATLAB.
+
+
+Our Copyright Policy
+====================
+
+pvlib python uses a shared copyright model. Each contributor maintains copyright
+over their contributions to pvlib python. However, it is important to note that
+these contributions are typically only changes to the repositories. Thus,
+the pvlib python source code, in its entirety, is not the copyright of any single
+person or institution. Instead, it is the collective copyright of the
+Contributors. If individual contributors want to make explicit their copyright
+of the contributions they have made,
+they should indicate their copyright using in-line comments in the code submitted
+to the pvlib python repository, with the understanding that by contributing, they
+grant the pvlib-python license.
+
+License
+=======
+
+pvlib python is distributed under a 3-clause BSD license.

{pvlib-0.9.4a1 → pvlib-0.10.0}/LICENSE

@@ -1,6 +1,9 @@
 BSD 3-Clause License
 
-Copyright (c) 2013-2021, Sandia National Laboratories and pvlib python Development Team
+Copyright (c) 2023 pvlib python Contributors
+Copyright (c) 2014 PVLIB python Development Team
+Copyright (c) 2013 Sandia National Laboratories
+
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -13,7 +16,7 @@ are permitted provided that the following conditions are met:
   list of conditions and the following disclaimer in the documentation and/or
   other materials provided with the distribution.
 
-  Neither the name of the {organization} nor the names of its
+  Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 

{pvlib-0.9.4a1 → pvlib-0.10.0}/MANIFEST.in

@@ -19,7 +19,6 @@ global-exclude \#*
 global-exclude .ipynb_checkpoints
 
 exclude .coveragerc
-exclude .lgtm.yml
 exclude .stickler.yml
 exclude codecov.yml
 exclude readthedocs.yml

{pvlib-0.9.4a1/pvlib.egg-info → pvlib-0.10.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: pvlib
-Version: 0.9.4a1
+Version: 0.10.0
 Summary: A set of functions and classes for simulating the performance of photovoltaic energy systems.
 Home-page: https://github.com/pvlib/pvlib-python
 Author: pvlib python Developers
-Maintainer-email: holmgren@email.arizona.edu
+Maintainer-email: pvlib-admin@googlegroups.com
 License: BSD 3-Clause
 Project-URL: Bug Tracker, https://github.com/pvlib/pvlib-python/issues
 Project-URL: Documentation, https://pvlib-python.readthedocs.io/

{pvlib-0.9.4a1 → pvlib-0.10.0}/README.md

@@ -17,7 +17,7 @@
 <tr>
   <td>License</td>
   <td>
-    <a href="https://github.com/pvlib/pvlib-python/blob/master/LICENSE">
+    <a href="https://github.com/pvlib/pvlib-python/blob/main/LICENSE">
     <img src="https://img.shields.io/pypi/l/pvlib.svg" alt="license" />
     </a>
 </td>
@@ -28,29 +28,18 @@
     <a href="http://pvlib-python.readthedocs.org/en/stable/">
     <img src="https://readthedocs.org/projects/pvlib-python/badge/?version=stable" alt="documentation build status" />
     </a>
-    <a href="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml?query=branch%3Amaster">
-      <img src="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml/badge.svg?branch=master" alt="GitHub Actions Testing Status" />
+    <a href="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml?query=branch%3Amain">
+      <img src="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml/badge.svg?branch=main" alt="GitHub Actions Testing Status" />
     </a>
     <a href="https://codecov.io/gh/pvlib/pvlib-python">
-    <img src="https://codecov.io/gh/pvlib/pvlib-python/branch/master/graph/badge.svg" alt="codecov coverage" />
-    </a>
-  </td>
-</tr>
-<tr>
-  <td>Code Quality</td>
-  <td>
-    <a href="https://lgtm.com/projects/g/pvlib/pvlib-python/context:python">
-    <img src="https://img.shields.io/lgtm/grade/python/g/pvlib/pvlib-python.svg?logo=lgtm&logoWidth=18" alt="lgtm quality grade" />
-    </a>
-    <a href="https://lgtm.com/projects/g/pvlib/pvlib-python/alerts">
-    <img src="https://img.shields.io/lgtm/alerts/g/pvlib/pvlib-python.svg?logo=lgtm&logoWidth=18" alt="lgtm alters" />
+    <img src="https://codecov.io/gh/pvlib/pvlib-python/branch/main/graph/badge.svg" alt="codecov coverage" />
     </a>
   </td>
 </tr>
 <tr>
   <td>Benchmarks</td>
   <td>
-    <a href="https://pvlib-benchmarker.github.io/pvlib-benchmarks/">
+    <a href="https://pvlib.github.io/pvlib-benchmarks/">
     <img src="https://img.shields.io/badge/benchmarks-asv-lightgrey" />
     </a>
   </td>
@@ -93,8 +82,8 @@ but operate independently of it.
 Documentation
 =============
 
-Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs.io/en/stable/).
-
+Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs.io/en/stable/),
+including an [FAQ](http://pvlib-python.readthedocs.io/en/stable/user_guide/faq.html) page.
 
 Installation
 ============

{pvlib-0.9.4a1 → pvlib-0.10.0}/docs/examples/README.rst

@@ -1,3 +1,5 @@
+.. _example_gallery:
+
 Example Gallery
 ===============
 

pvlib-0.10.0/docs/examples/adr-pvarray/README.rst

@@ -0,0 +1,3 @@
+ADR Model for PV Module Efficiency
+----------------------------------
+

pvlib-0.10.0/docs/examples/adr-pvarray/plot_fit_to_matrix.py

@@ -0,0 +1,108 @@
+"""
+Obtaining ADR model parameters from IEC 61853 matrix measurements
+=================================================================
+
+There's a fitting function provided in pvlib to do exactly that.
+
+Since PV module efficiency varies with irradiance and temperature
+what better way to train a model than using efficiency measurement
+over a broad range of temperature and irradiance levels?
+The standard IEC 61853-1 defines a standard matrix of conditions
+for such measurements and this example shows how the ADR model
+parameters can be determined with just a few lines of code using
+functions in pvlib-python.
+
+Author: Anton Driesse
+"""
+
+from io import StringIO
+import pandas as pd
+import matplotlib.pyplot as plt
+
+from pvlib.pvarray import pvefficiency_adr, fit_pvefficiency_adr
+
+# %% The text on this line is not displayed
+#
+# Here are some matrix measurements:
+#
+
+iec61853data = '''
+    irradiance  temperature     p_mp
+0          100         15.0   30.159
+1          200         15.0   63.057
+2          400         15.0  129.849
+3          600         15.0  197.744
+4          800         15.0  264.825
+5         1000         15.0  330.862
+6          100         25.0   29.250
+7          200         25.0   61.137
+8          400         25.0  126.445
+9          600         25.0  192.278
+10         800         25.0  257.561
+11        1000         25.0  322.305
+12        1100         25.0  354.174
+15         400         50.0  117.062
+16         600         50.0  177.959
+17         800         50.0  238.626
+18        1000         50.0  298.954
+19        1100         50.0  328.413
+23         600         75.0  162.966
+24         800         75.0  218.585
+25        1000         75.0  273.651
+26        1100         75.0  301.013
+'''
+df = pd.read_csv(StringIO(iec61853data), delim_whitespace=True)
+
+# %%
+#
+# Now calculate the normalized or relative efficiency values
+# and use the fitting function to determine the parameters.
+# The parameters (shown below) can now be used to
+# simulate the module operating in a PV system.
+#
+
+P_REF = 322.305   # (W) STC value from the table above
+G_REF = 1000.     # (W/m2)
+
+df['eta_rel'] = (df['p_mp'] / P_REF) / (df['irradiance'] / G_REF)
+
+adr_params = fit_pvefficiency_adr(df['irradiance'], df['temperature'],
+                                  df['eta_rel'])
+
+for k, v in adr_params.items():
+    print('%-5s = %8.5f' % (k, v))
+
+# %%
+#
+# Compare the model output to the original measurements.
+# The chart below shows minor differences but due to their random nature
+# they are most likely evidence of the limitations of measurement accuracy.
+#
+
+eta_rel_adr = pvefficiency_adr(df['irradiance'],
+                               df['temperature'], **adr_params)
+
+plt.figure()
+plt.plot(df['irradiance'], df['eta_rel'], 'oc', ms=8)
+plt.plot(df['irradiance'], eta_rel_adr, '.k')
+plt.legend(['Lab measurements', 'ADR model fit'], loc='lower right')
+plt.xlabel('Irradiance [W/m²]')
+plt.ylabel('Relative efficiency [-]')
+plt.grid(alpha=0.5)
+plt.xlim(0, 1200)
+plt.ylim(0.7, 1.1)
+plt.show()
+
+# %%
+#
+# References
+# ----------
+# .. [1] A. Driesse and J. S. Stein, "From IEC 61853 power measurements
+#    to PV system simulations", Sandia Report No. SAND2020-3877, 2020.
+#    :doi:`10.2172/1615179`
+#
+# .. [2] A. Driesse, M. Theristis and J. S. Stein, "A New Photovoltaic Module
+#    Efficiency Model for Energy Prediction and Rating," in IEEE Journal
+#    of Photovoltaics, vol. 11, no. 2, pp. 527-534, March 2021.
+#    :doi:`10.1109/JPHOTOV.2020.3045677`
+#

pvlib-0.10.0/docs/examples/adr-pvarray/plot_simulate_fast.py

@@ -0,0 +1,176 @@
+"""
+Fast simulation using the ADR efficiency model starting from PVsyst parameters
+==============================================================================
+
+Would you like to increase simulation speed by a factor of 4000+?
+
+Simulation using single-diode models can be slow because the maximum
+power point is usually found by an iterative search.
+In this example we use the PVsyst single diode model to generate
+a matrix of efficiency values, then determine the ADR model
+parameters to approximate the behavior of the PVsyst model.
+This way both PVsyst and ADR models can simulate the same PV module type.
+
+To compare simulation speed, we run them using ``timeit``.
+
+Author: Anton Driesse
+"""
+
+import numpy as np
+import matplotlib.pyplot as plt
+
+from pvlib.pvsystem import calcparams_pvsyst, max_power_point
+from pvlib.pvarray import fit_pvefficiency_adr, pvefficiency_adr
+
+from timeit import timeit
+
+# %% The text on this line is not displayed
+#
+# Generate a matrix of power values
+#
+
+pvsyst_params = {'alpha_sc': 0.0015,
+                 'gamma_ref': 1.20585,
+                 'mu_gamma': -9.41066e-05,
+                 'I_L_ref': 5.9301,
+                 'I_o_ref': 2.9691e-10,
+                 'R_sh_ref': 1144,
+                 'R_sh_0': 3850,
+                 'R_s': 0.6,
+                 'cells_in_series': 96,
+                 'R_sh_exp': 5.5,
+                 'EgRef': 1.12,
+                 }
+
+G_REF = 1000
+T_REF = 25
+
+params_stc = calcparams_pvsyst(G_REF, T_REF, **pvsyst_params)
+mpp_stc = max_power_point(*params_stc)
+
+P_REF = mpp_stc['p_mp']
+
+g, t = np.meshgrid(np.linspace(100, 1100, 11),
+                   np.linspace(0, 75, 4))
+
+adjusted_params = calcparams_pvsyst(g, t, **pvsyst_params)
+mpp = max_power_point(*adjusted_params)
+p_mp = mpp['p_mp']
+
+print('irradiance')
+print(g[:1].round(0))
+
+print('maximum power')
+print(p_mp.round(1))
+
+# %%
+#
+# Convert power matrix to efficiency and fit the ADR model to all the points
+#
+
+eta_rel_pvs = (p_mp / P_REF) / (g / G_REF)
+
+adr_params = fit_pvefficiency_adr(g, t, eta_rel_pvs, dict_output=True)
+
+for k, v in adr_params.items():
+    print('%-5s = %8.5f' % (k, v))
+
+# %%
+#
+# Compare the ADR model output to the PVsyst model output
+#
+
+eta_rel_adr = pvefficiency_adr(g, t, **adr_params)
+mbe = np.mean(eta_rel_adr - eta_rel_pvs)
+rmse = np.sqrt(np.mean(np.square(eta_rel_adr - eta_rel_pvs)))
+
+plt.figure()
+plt.plot(g.flat, eta_rel_pvs.flat, 'oc', ms=8)
+plt.plot(g.flat, eta_rel_adr.flat, '.k')
+plt.grid(alpha=0.5)
+plt.xlim(0, 1200)
+plt.ylim(0.7, 1.1)
+
+plt.xlabel('Irradiance [W/m²]')
+plt.ylabel('Relative efficiency [-]')
+plt.legend(['PVsyst model output', 'ADR model fit'], loc='lower right')
+plt.title('Differences: mean %.5f, RMS %.5f' % (mbe, rmse))
+plt.show()
+
+# %%
+#
+# Generate some random irradiance and temperature data
+#
+
+g = np.random.uniform(0, 1200, 8760)
+t = np.random.uniform(20,  80, 8760)
+
+
+def run_adr():
+    eta_rel = pvefficiency_adr(g, t, **adr_params)
+    p_adr = P_REF * eta_rel * (g / G_REF)
+    return p_adr
+
+
+def run_pvsyst():
+    adjusted_params = calcparams_pvsyst(g, t, **pvsyst_params)
+    mpp = max_power_point(*adjusted_params)
+    p_pvs = mpp['p_mp']
+    return p_pvs
+
+
+elapsed_adr = timeit('run_adr()', number=1, globals=globals())
+elapsed_pvs = timeit('run_pvsyst()', number=1, globals=globals())
+
+print('Elapsed time for the PVsyst model: %9.6f s' % elapsed_pvs)
+print('Elapsed time for the ADR    model: %9.6f s' % elapsed_adr)
+print('ADR acceleration ratio:           %9.0f x' % (elapsed_pvs/elapsed_adr))
+
+# %%
+#
+# That's fast, but is it accurate?
+# Run them again to compare the simulated power values
+#
+
+p_pvs = run_pvsyst()
+p_adr = run_adr()
+
+mbe = np.mean(p_adr - p_pvs)
+rmse = np.sqrt(np.mean(np.square(p_adr - p_pvs)))
+
+# sphinx_gallery_thumbnail_number = 2
+plt.figure()
+pc = plt.scatter(p_pvs, p_adr-p_pvs, c=t, cmap='jet')
+plt.colorbar()
+pc.set_alpha(0.25)
+plt.ylim(-1.4, 1.4)
+plt.grid(alpha=0.5)
+
+plt.xlabel('Power calculated using the PVsyst model [W]')
+plt.ylabel('ADR model power - PVsyst model power [W]')
+plt.title('Differences: mean %.2f W, RMS %.2f W' % (mbe, rmse))
+plt.show()
+
+# %%
+#
+# There are some small systematic differences between the original
+# PVsyst model output and the ADR fit.  But these differences are
+# much smaller than the typical uncertainty in measured output
+# of modules of this type. The PVsyst model and the parameters
+# we started with are of course also only approximations of the
+# true module behavior.
+#
+
+# %%
+#
+# References
+# ----------
+# .. [1] A. Driesse and J. S. Stein, "From IEC 61853 power measurements
+#    to PV system simulations", Sandia Report No. SAND2020-3877, 2020.
+#    :doi:`10.2172/1615179`
+#
+# .. [2] A. Driesse, M. Theristis and J. S. Stein, "A New Photovoltaic Module
+#    Efficiency Model for Energy Prediction and Rating," in IEEE Journal
+#    of Photovoltaics, vol. 11, no. 2, pp. 527-534, March 2021.
+#    :doi:`10.1109/JPHOTOV.2020.3045677`
+#

pvlib-0.10.0/docs/examples/adr-pvarray/plot_simulate_system.py

@@ -0,0 +1,158 @@
+"""
+Simulating PV system DC output using the ADR module efficiency model
+====================================================================
+
+Time series processing with the ADR model is really easy.
+
+This example reads a TMY3 weather file, and runs a basic simulation
+on a fixed latitude-tilt system.
+Efficiency is independent of system size, so adjusting the system
+capacity is just a matter of setting the desired value, e.g. P_STC = 5000.
+
+Author: Anton Driesse
+"""
+
+import os
+import pandas as pd
+import matplotlib.pyplot as plt
+
+import pvlib
+from pvlib import iotools, location
+from pvlib.irradiance import get_total_irradiance
+from pvlib.pvarray import pvefficiency_adr
+
+# %%
+#
+# Read a TMY3 file containing weather data and select needed columns
+#
+
+PVLIB_DIR = pvlib.__path__[0]
+DATA_FILE = os.path.join(PVLIB_DIR, 'data', '723170TYA.CSV')
+
+tmy, metadata = iotools.read_tmy3(DATA_FILE, coerce_year=1990,
+                                  map_variables=True)
+
+df = pd.DataFrame({'ghi': tmy['ghi'], 'dhi': tmy['dhi'], 'dni': tmy['dni'],
+                   'temp_air': tmy['temp_air'],
+                   'wind_speed': tmy['wind_speed'],
+                   })
+
+# %%
+#
+# Shift timestamps to middle of hour and then calculate sun positions
+#
+
+df.index = df.index - pd.Timedelta(minutes=30)
+
+loc = location.Location.from_tmy(metadata)
+solpos = loc.get_solarposition(df.index)
+
+# %%
+#
+# Determine  total irradiance on a fixed-tilt array
+#
+
+TILT = metadata['latitude']
+ORIENT = 180
+
+total_irrad = get_total_irradiance(TILT, ORIENT,
+                                   solpos.apparent_zenith, solpos.azimuth,
+                                   df.dni, df.ghi, df.dhi)
+
+df['poa_global'] = total_irrad.poa_global
+
+# %%
+#
+# Estimate the expected operating temperature of the PV modules
+#
+
+df['temp_pv'] = pvlib.temperature.faiman(df.poa_global, df.temp_air,
+                                         df.wind_speed)
+
+# %%
+#
+# Now we're ready to calculate PV array DC output power based
+# on POA irradiance and PV module operating temperature.
+# Among the models available in pvlib-python to do this are:
+#
+#  - PVWatts
+#  - SAPM
+#  - single-diode model variations
+#
+# And now also the ADR PV efficiency model
+#
+# Simulation is done in two steps:
+#
+#  - first calculate efficiency using the ADR model,
+#  - then convert (scale up) efficiency to power.
+#
+
+# Borrow the ADR model parameters from the other example:
+
+adr_params = {'k_a': 0.99924,
+              'k_d': -5.49097,
+              'tc_d': 0.01918,
+              'k_rs': 0.06999,
+              'k_rsh': 0.26144
+              }
+
+df['eta_rel'] = pvefficiency_adr(df['poa_global'], df['temp_pv'], **adr_params)
+
+# Set the desired array size:
+P_STC = 5000.   # (W)
+
+# and the irradiance level needed to achieve this output:
+G_STC = 1000.   # (W/m2)
+
+df['p_mp'] = P_STC * df['eta_rel'] * (df['poa_global'] / G_STC)
+
+# %%
+#
+# Show how power and efficiency vary with both irradiance and temperature
+#
+
+plt.figure()
+pc = plt.scatter(df['poa_global'], df['eta_rel'], c=df['temp_pv'], cmap='jet')
+plt.colorbar(label='Temperature [C]', ax=plt.gca())
+pc.set_alpha(0.25)
+plt.grid(alpha=0.5)
+plt.ylim(0.48)
+plt.xlabel('Irradiance [W/m²]')
+plt.ylabel('Relative efficiency [-]')
+plt.show()
+
+plt.figure()
+pc = plt.scatter(df['poa_global'], df['p_mp'], c=df['temp_pv'], cmap='jet')
+plt.colorbar(label='Temperature [C]', ax=plt.gca())
+pc.set_alpha(0.25)
+plt.grid(alpha=0.5)
+plt.xlabel('Irradiance [W/m²]')
+plt.ylabel('Array power [W]')
+plt.show()
+
+# %%
+#
+# One day:
+#
+
+DEMO_DAY = '1990-08-05'
+
+plt.figure()
+plt.plot(df['p_mp'][DEMO_DAY])
+plt.xticks(rotation=30)
+plt.ylabel('Power [W]')
+plt.show()
+
+# %%
+#
+# References
+# ----------
+# .. [1] A. Driesse and J. S. Stein, "From IEC 61853 power measurements
+#    to PV system simulations", Sandia Report No. SAND2020-3877, 2020.
+#    :doi:`10.2172/1615179`
+#
+# .. [2] A. Driesse, M. Theristis and J. S. Stein, "A New Photovoltaic Module
+#    Efficiency Model for Energy Prediction and Rating," in IEEE Journal
+#    of Photovoltaics, vol. 11, no. 2, pp. 527-534, March 2021.
+#    :doi:`10.1109/JPHOTOV.2020.3045677`
+#

pvlib-0.10.0/docs/examples/irradiance-decomposition/README.rst

@@ -0,0 +1,3 @@
+Irradiance Decomposition
+------------------------
+