diff --git a/docs/sphinx/source/api.rst b/docs/sphinx/source/api.rst index 002e694985..4f293b337f 100644 --- a/docs/sphinx/source/api.rst +++ b/docs/sphinx/source/api.rst @@ -275,6 +275,7 @@ Functions relevant for the SAPM model. pvsystem.sapm_spectral_loss pvsystem.sapm_aoi_loss pvsystem.snlinverter + pvsystem.adrinverter temperature.sapm_cell Pvsyst model @@ -296,7 +297,6 @@ PVWatts model pvsystem.pvwatts_dc pvsystem.pvwatts_ac pvsystem.pvwatts_losses - pvsystem.pvwatts_losses Functions for fitting PV models ------------------------------- @@ -380,24 +380,6 @@ in some files. location.Location.from_epw -TMY -=== - -.. warning:: - - The :py:mod:`pvlib.tmy` module is deprecated; it will be removed - in pvlib 0.7. Please see the :ref:`pvlib.iotools ` package. - -Methods and functions for reading data from TMY files. - -.. autosummary:: - :toctree: generated/ - - location.Location.from_tmy - tmy.readtmy2 - tmy.readtmy3 - - Forecasting =========== diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 88b7b61678..d4de03fa5f 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -320,3 +320,7 @@ def setup(app): nbsphinx_allow_errors = True ipython_warning_is_error = False + +# suppress "WARNING: Footnote [1] is not referenced." messages +# https://github.com/pvlib/pvlib-python/issues/837 +suppress_warnings = ['ref.footnote'] diff --git a/docs/sphinx/source/whatsnew/v0.7.0.rst b/docs/sphinx/source/whatsnew/v0.7.0.rst index 0d9fa027db..c88400a5de 100644 --- a/docs/sphinx/source/whatsnew/v0.7.0.rst +++ b/docs/sphinx/source/whatsnew/v0.7.0.rst @@ -177,6 +177,11 @@ Documentation used. (:issue:`785`) * Note warning about _TMY3.epw files retrieved from energyplus.net in docstring of `epw.read_epw` +* Improved sphinx rendering of API reference entries for `clearsky.ineichen`, + `clearsky.haurwitz`, `tracking.singleaxis`, `iotools.read_midc`, + `Location.from_tmy`, `ModelChain.run_model`, `ModelChain.complete_irradiance`, + and `ModelChain.prepare_inputs` +* Removed duplicate `pvwatts_losses` entry in `api.rst` Removal of prior version deprecations ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -212,3 +217,4 @@ Contributors * Tony Lorenzo (:ghuser:`alorenzo175`) * Todd Karin (:ghuser:`toddkarin`) * Mark Mikofski (:ghuser:`mikofski`) +* Kevin Anderson (:ghuser:`kevinsa5`) diff --git a/pvlib/atmosphere.py b/pvlib/atmosphere.py index aca7449511..5c3cc69eaa 100644 --- a/pvlib/atmosphere.py +++ b/pvlib/atmosphere.py @@ -46,8 +46,8 @@ def pres2alt(pressure): References ----------- - [1] "A Quick Derivation relating altitude to air pressure" from - Portland State Aerospace Society, Version 1.03, 12/22/2004. + .. [1] "A Quick Derivation relating altitude to air pressure" from + Portland State Aerospace Society, Version 1.03, 12/22/2004. ''' alt = 44331.5 - 4946.62 * pressure ** (0.190263) @@ -86,8 +86,8 @@ def alt2pres(altitude): References ----------- - [1] "A Quick Derivation relating altitude to air pressure" from - Portland State Aerospace Society, Version 1.03, 12/22/2004. + .. [1] "A Quick Derivation relating altitude to air pressure" from + Portland State Aerospace Society, Version 1.03, 12/22/2004. ''' press = 100 * ((44331.514 - altitude) / 11880.516) ** (1 / 0.1902632) @@ -124,9 +124,9 @@ def get_absolute_airmass(airmass_relative, pressure=101325.): References ---------- - [1] C. Gueymard, "Critical analysis and performance assessment of - clear sky solar irradiance models using theoretical and measured - data," Solar Energy, vol. 51, pp. 121-138, 1993. + .. [1] C. Gueymard, "Critical analysis and performance assessment of + clear sky solar irradiance models using theoretical and measured + data," Solar Energy, vol. 51, pp. 121-138, 1993. ''' airmass_absolute = airmass_relative * pressure / 101325. @@ -178,29 +178,29 @@ def get_relative_airmass(zenith, model='kastenyoung1989'): References ---------- - [1] Fritz Kasten. "A New Table and Approximation Formula for the - Relative Optical Air Mass". Technical Report 136, Hanover, N.H.: - U.S. Army Material Command, CRREL. + .. [1] Fritz Kasten. "A New Table and Approximation Formula for the + Relative Optical Air Mass". Technical Report 136, Hanover, N.H.: + U.S. Army Material Command, CRREL. - [2] A. T. Young and W. M. Irvine, "Multicolor Photoelectric - Photometry of the Brighter Planets," The Astronomical Journal, vol. - 72, pp. 945-950, 1967. + .. [2] A. T. Young and W. M. Irvine, "Multicolor Photoelectric + Photometry of the Brighter Planets," The Astronomical Journal, vol. + 72, pp. 945-950, 1967. - [3] Fritz Kasten and Andrew Young. "Revised optical air mass tables - and approximation formula". Applied Optics 28:4735-4738 + .. [3] Fritz Kasten and Andrew Young. "Revised optical air mass tables + and approximation formula". Applied Optics 28:4735-4738 - [4] C. Gueymard, "Critical analysis and performance assessment of - clear sky solar irradiance models using theoretical and measured - data," Solar Energy, vol. 51, pp. 121-138, 1993. + .. [4] C. Gueymard, "Critical analysis and performance assessment of + clear sky solar irradiance models using theoretical and measured + data," Solar Energy, vol. 51, pp. 121-138, 1993. - [5] A. T. Young, "AIR-MASS AND REFRACTION," Applied Optics, vol. 33, - pp. 1108-1110, Feb 1994. + .. [5] A. T. Young, "AIR-MASS AND REFRACTION," Applied Optics, vol. 33, + pp. 1108-1110, Feb 1994. - [6] Keith A. Pickering. "The Ancient Star Catalog". DIO 12:1, 20, + .. [6] Keith A. Pickering. "The Ancient Star Catalog". DIO 12:1, 20, - [7] Matthew J. Reno, Clifford W. Hansen and Joshua S. Stein, "Global - Horizontal Irradiance Clear Sky Models: Implementation and Analysis" - Sandia Report, (2012). + .. [7] Matthew J. Reno, Clifford W. Hansen and Joshua S. Stein, "Global + Horizontal Irradiance Clear Sky Models: Implementation and Analysis" + Sandia Report, (2012). ''' # set zenith values greater than 90 to nans @@ -518,13 +518,13 @@ def bird_hulstrom80_aod_bb(aod380, aod500): References ---------- - [1] Bird and Hulstrom, "Direct Insolation Models" (1980) - `SERI/TR-335-344 `_ + .. [1] Bird and Hulstrom, "Direct Insolation Models" (1980) + `SERI/TR-335-344 `_ - [2] R. E. Bird and R. L. Hulstrom, "Review, Evaluation, and Improvement of - Direct Irradiance Models", Journal of Solar Energy Engineering 103(3), - pp. 182-192 (1981) - :doi:`10.1115/1.3266239` + .. [2] R. E. Bird and R. L. Hulstrom, "Review, Evaluation, and Improvement + of Direct Irradiance Models", Journal of Solar Energy Engineering + 103(3), pp. 182-192 (1981) + :doi:`10.1115/1.3266239` """ # approximate broadband AOD using (Bird-Hulstrom 1980) return 0.27583 * aod380 + 0.35 * aod500 @@ -565,32 +565,32 @@ def kasten96_lt(airmass_absolute, precipitable_water, aod_bb): References ---------- - [1] F. Linke, "Transmissions-Koeffizient und Trubungsfaktor", Beitrage - zur Physik der Atmosphare, Vol 10, pp. 91-103 (1922) - - [2] F. Kasten, "A simple parameterization of the pyrheliometric formula for - determining the Linke turbidity factor", Meteorologische Rundschau 33, - pp. 124-127 (1980) - - [3] Kasten, "The Linke turbidity factor based on improved values of the - integral Rayleigh optical thickness", Solar Energy, Vol. 56, No. 3, - pp. 239-244 (1996) - :doi:`10.1016/0038-092X(95)00114-7` - - [4] B. Molineaux, P. Ineichen, N. O'Neill, "Equivalence of pyrheliometric - and monochromatic aerosol optical depths at a single key wavelength", - Applied Optics Vol. 37, issue 10, 7008-7018 (1998) - :doi:`10.1364/AO.37.007008` - - [5] P. Ineichen, "Conversion function between the Linke turbidity and the - atmospheric water vapor and aerosol content", Solar Energy 82, - pp. 1095-1097 (2008) - :doi:`10.1016/j.solener.2008.04.010` - - [6] P. Ineichen and R. Perez, "A new airmass independent formulation for - the Linke Turbidity coefficient", Solar Energy, Vol. 73, no. 3, pp. 151-157 - (2002) - :doi:`10.1016/S0038-092X(02)00045-2` + .. [1] F. Linke, "Transmissions-Koeffizient und Trubungsfaktor", Beitrage + zur Physik der Atmosphare, Vol 10, pp. 91-103 (1922) + + .. [2] F. Kasten, "A simple parameterization of the pyrheliometric formula + for determining the Linke turbidity factor", Meteorologische Rundschau + 33, pp. 124-127 (1980) + + .. [3] Kasten, "The Linke turbidity factor based on improved values of the + integral Rayleigh optical thickness", Solar Energy, Vol. 56, No. 3, + pp. 239-244 (1996) + :doi:`10.1016/0038-092X(95)00114-7` + + .. [4] B. Molineaux, P. Ineichen, N. O'Neill, "Equivalence of + pyrheliometric and monochromatic aerosol optical depths at a single key + wavelength", Applied Optics Vol. 37, issue 10, 7008-7018 (1998) + :doi:`10.1364/AO.37.007008` + + .. [5] P. Ineichen, "Conversion function between the Linke turbidity and + the atmospheric water vapor and aerosol content", Solar Energy 82, + pp. 1095-1097 (2008) + :doi:`10.1016/j.solener.2008.04.010` + + .. [6] P. Ineichen and R. Perez, "A new airmass independent formulation for + the Linke Turbidity coefficient", Solar Energy, Vol. 73, no. 3, + pp. 151-157 (2002) + :doi:`10.1016/S0038-092X(02)00045-2` """ # "From numerically integrated spectral simulations done with Modtran # (Berk, 1989), Molineaux (1998) obtained for the broadband optical depth @@ -644,14 +644,15 @@ def angstrom_aod_at_lambda(aod0, lambda0, alpha=1.14, lambda1=700.0): References ---------- - [1] Anders Angstrom, "On the Atmospheric Transmission of Sun Radiation and - On Dust in the Air", Geografiska Annaler Vol. 11, pp. 156-166 (1929) JSTOR - :doi:`10.2307/519399` - - [2] Anders Angstrom, "Techniques of Determining the Turbidity of the - Atmosphere", Tellus 13:2, pp. 214-223 (1961) Taylor & Francis - :doi:`10.3402/tellusa.v13i2.9493` and Co-Action Publishing - :doi:`10.1111/j.2153-3490.1961.tb00078.x` + .. [1] Anders Angstrom, "On the Atmospheric Transmission of Sun Radiation + and On Dust in the Air", Geografiska Annaler Vol. 11, pp. 156-166 (1929) + JSTOR + :doi:`10.2307/519399` + + .. [2] Anders Angstrom, "Techniques of Determining the Turbidity of the + Atmosphere", Tellus 13:2, pp. 214-223 (1961) Taylor & Francis + :doi:`10.3402/tellusa.v13i2.9493` and Co-Action Publishing + :doi:`10.1111/j.2153-3490.1961.tb00078.x` """ return aod0 * ((lambda1 / lambda0) ** (-alpha)) diff --git a/pvlib/clearsky.py b/pvlib/clearsky.py index 24e8d80b9f..e4cb12f179 100644 --- a/pvlib/clearsky.py +++ b/pvlib/clearsky.py @@ -64,23 +64,23 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity, References ---------- - [1] P. Ineichen and R. Perez, "A New airmass independent formulation for - the Linke turbidity coefficient", Solar Energy, vol 73, pp. 151-157, - 2002. + .. [1] P. Ineichen and R. Perez, "A New airmass independent formulation for + the Linke turbidity coefficient", Solar Energy, vol 73, pp. 151-157, + 2002. - [2] R. Perez et. al., "A New Operational Model for Satellite-Derived - Irradiances: Description and Validation", Solar Energy, vol 73, pp. - 307-317, 2002. + .. [2] R. Perez et. al., "A New Operational Model for Satellite-Derived + Irradiances: Description and Validation", Solar Energy, vol 73, pp. + 307-317, 2002. - [3] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance Clear - Sky Models: Implementation and Analysis", Sandia National - Laboratories, SAND2012-2389, 2012. + .. [3] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance + Clear Sky Models: Implementation and Analysis", Sandia National + Laboratories, SAND2012-2389, 2012. - [4] http://www.soda-is.com/eng/services/climat_free_eng.php#c5 (obtained - July 17, 2012). + .. [4] http://www.soda-is.com/eng/services/climat_free_eng.php#c5 (obtained + July 17, 2012). - [5] J. Remund, et. al., "Worldwide Linke Turbidity Information", Proc. - ISES Solar World Congress, June 2003. Goteborg, Sweden. + .. [5] J. Remund, et. al., "Worldwide Linke Turbidity Information", Proc. + ISES Solar World Congress, June 2003. Goteborg, Sweden. ''' # ghi is calculated using either the equations in [1] by setting @@ -377,15 +377,15 @@ def haurwitz(apparent_zenith): References ---------- - [1] B. Haurwitz, "Insolation in Relation to Cloudiness and Cloud - Density," Journal of Meteorology, vol. 2, pp. 154-166, 1945. + .. [1] B. Haurwitz, "Insolation in Relation to Cloudiness and Cloud + Density," Journal of Meteorology, vol. 2, pp. 154-166, 1945. - [2] B. Haurwitz, "Insolation in Relation to Cloud Type," Journal of - Meteorology, vol. 3, pp. 123-124, 1946. + .. [2] B. Haurwitz, "Insolation in Relation to Cloud Type," Journal of + Meteorology, vol. 3, pp. 123-124, 1946. - [3] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance Clear - Sky Models: Implementation and Analysis", Sandia National - Laboratories, SAND2012-2389, 2012. + .. [3] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance + Clear Sky Models: Implementation and Analysis", Sandia National + Laboratories, SAND2012-2389, 2012. ''' cos_zenith = tools.cosd(apparent_zenith.values) @@ -673,9 +673,9 @@ def detect_clearsky(measured, clearsky, times, window_length, References ---------- - [1] Reno, M.J. and C.W. Hansen, "Identification of periods of clear - sky irradiance in time series of GHI measurements" Renewable Energy, - v90, p. 520-531, 2016. + .. [1] Reno, M.J. and C.W. Hansen, "Identification of periods of clear + sky irradiance in time series of GHI measurements" Renewable Energy, + v90, p. 520-531, 2016. Notes ----- @@ -853,18 +853,22 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water, References ---------- - [1] R. E. Bird and R. L Hulstrom, "A Simplified Clear Sky model for Direct - and Diffuse Insolation on Horizontal Surfaces" SERI Technical Report - SERI/TR-642-761, Feb 1981. Solar Energy Research Institute, Golden, CO. + .. [1] R. E. Bird and R. L Hulstrom, "A Simplified Clear Sky model for + Direct and Diffuse Insolation on Horizontal Surfaces" SERI Technical + Report SERI/TR-642-761, Feb 1981. Solar Energy Research Institute, + Golden, CO. - [2] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable - Energy Applications", pp. 46-51 CRC Press (2013) + .. [2] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable + Energy Applications", pp. 46-51 CRC Press (2013) - `NREL Bird Clear Sky Model `_ + .. [3] `NREL Bird Clear Sky Model `_ - `SERI/TR-642-761 `_ + .. [4] `SERI/TR-642-761 `_ - `Error Reports `_ + .. [5] `Error Reports `_ """ etr = dni_extra # extraradiation ze_rad = np.deg2rad(zenith) # zenith in radians diff --git a/pvlib/iam.py b/pvlib/iam.py index 6e40a6b2d6..5715e06762 100644 --- a/pvlib/iam.py +++ b/pvlib/iam.py @@ -30,7 +30,7 @@ def ashrae(aoi, b=0.05): The ASHRAE (American Society of Heating, Refrigeration, and Air Conditioning Engineers) transmission model is developed in - [1], and in [2]. The model has been used in software such as PVSyst [3]. + [1]_, and in [2]_. The model has been used in software such as PVSyst [3]_. Parameters ---------- @@ -61,15 +61,15 @@ def ashrae(aoi, b=0.05): References ---------- - [1] Souka A.F., Safwat H.H., "Determination of the optimum - orientations for the double exposure flat-plate collector and its - reflections". Solar Energy vol .10, pp 170-174. 1966. + .. [1] Souka A.F., Safwat H.H., "Determination of the optimum + orientations for the double exposure flat-plate collector and its + reflections". Solar Energy vol .10, pp 170-174. 1966. - [2] ASHRAE standard 93-77 + .. [2] ASHRAE standard 93-77 - [3] PVsyst Contextual Help. - https://files.pvsyst.com/help/index.html?iam_loss.htm retrieved on - October 14, 2019 + .. [3] PVsyst Contextual Help. + https://files.pvsyst.com/help/index.html?iam_loss.htm retrieved on + October 14, 2019 See Also -------- @@ -96,7 +96,7 @@ def physical(aoi, n=1.526, K=4., L=0.002): extinction coefficient ``K``, and glazing thickness ``L``. ``iam.physical`` calculates the incidence angle modifier as described in - [1], Section 3. The calculation is based on a physical model of absorbtion + [1]_, Section 3. The calculation is based on a physical model of absorbtion and transmission through a transparent cover. Parameters @@ -107,7 +107,7 @@ def physical(aoi, n=1.526, K=4., L=0.002): to ensure non-nan results. Angles of nan will result in nan. n : numeric, default 1.526 - The effective index of refraction (unitless). Reference [1] + The effective index of refraction (unitless). Reference [1]_ indicates that a value of 1.526 is acceptable for glass. K : numeric, default 4.0 @@ -116,7 +116,7 @@ def physical(aoi, n=1.526, K=4., L=0.002): "water white" glass. L : numeric, default 0.002 - The glazing thickness in units of meters. Reference [1] + The glazing thickness in units of meters. Reference [1]_ indicates that 0.002 meters (2 mm) is reasonable for most glass-covered PV panels. @@ -127,19 +127,19 @@ def physical(aoi, n=1.526, K=4., L=0.002): Notes ----- - The pvlib python authors believe that Eqn. 14 in [1] is + The pvlib python authors believe that Eqn. 14 in [1]_ is incorrect, which presents :math:`\theta_{r} = \arcsin(n \sin(AOI))`. Here, :math:`\theta_{r} = \arcsin(1/n \times \sin(AOI))` References ---------- - [1] W. De Soto et al., "Improvement and validation of a model for - photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, - 2006. + .. [1] W. De Soto et al., "Improvement and validation of a model for + photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, + 2006. - [2] Duffie, John A. & Beckman, William A.. (2006). Solar Engineering - of Thermal Processes, third edition. [Books24x7 version] Available - from http://common.books24x7.com/toc.aspx?bookid=17160. + .. [2] Duffie, John A. & Beckman, William A.. (2006). Solar Engineering + of Thermal Processes, third edition. [Books24x7 version] Available + from http://common.books24x7.com/toc.aspx?bookid=17160. See Also -------- @@ -206,7 +206,7 @@ def martin_ruiz(aoi, a_r=0.16): sun-beam vector in degrees. a_r : numeric - The angular losses coefficient described in equation 3 of [1]. + The angular losses coefficient described in equation 3 of [1]_. This is an empirical dimensionless parameter. Values of ``a_r`` are generally on the order of 0.08 to 0.25 for flat-plate PV modules. @@ -218,8 +218,8 @@ def martin_ruiz(aoi, a_r=0.16): Notes ----- `martin_ruiz` calculates the incidence angle modifier (IAM) as described in - [1]. The information required is the incident angle (AOI) and the angular - losses coefficient (a_r). Note that [1] has a corrigendum [2] which + [1]_. The information required is the incident angle (AOI) and the angular + losses coefficient (a_r). Note that [1]_ has a corrigendum [2]_ which clarifies a mix-up of 'alpha's and 'a's in the former. The incident angle modifier is defined as @@ -229,7 +229,7 @@ def martin_ruiz(aoi, a_r=0.16): IAM = \frac{1 - \exp(-\cos(\frac{aoi}{a_r}))} {1 - \exp(\frac{-1}{a_r}} - which is presented as :math:`AL(\alpha) = 1 - IAM` in equation 4 of [1], + which is presented as :math:`AL(\alpha) = 1 - IAM` in equation 4 of [1]_, with :math:`\alpha` representing the angle of incidence AOI. Thus IAM = 1 at AOI = 0, and IAM = 0 at AOI = 90. This equation is only valid for -90 <= aoi <= 90, therefore `iam` is constrained to 0.0 outside this @@ -237,14 +237,14 @@ def martin_ruiz(aoi, a_r=0.16): References ---------- - [1] N. Martin and J. M. Ruiz, "Calculation of the PV modules angular - losses under field conditions by means of an analytical model", Solar - Energy Materials & Solar Cells, vol. 70, pp. 25-38, 2001. + .. [1] N. Martin and J. M. Ruiz, "Calculation of the PV modules angular + losses under field conditions by means of an analytical model", Solar + Energy Materials & Solar Cells, vol. 70, pp. 25-38, 2001. - [2] N. Martin and J. M. Ruiz, "Corrigendum to 'Calculation of the PV - modules angular losses under field conditions by means of an - analytical model'", Solar Energy Materials & Solar Cells, vol. 110, - pp. 154, 2013. + .. [2] N. Martin and J. M. Ruiz, "Corrigendum to 'Calculation of the PV + modules angular losses under field conditions by means of an + analytical model'", Solar Energy Materials & Solar Cells, vol. 110, + pp. 154, 2013. See Also -------- @@ -288,7 +288,7 @@ def martin_ruiz_diffuse(surface_tilt, a_r=0.16, c1=0.4244, c2=None): surface_tilt must be in the range [0, 180] a_r : numeric - The angular losses coefficient described in equation 3 of [1]. + The angular losses coefficient described in equation 3 of [1]_. This is an empirical dimensionless parameter. Values of a_r are generally on the order of 0.08 to 0.25 for flat-plate PV modules. a_r must be greater than zero. @@ -296,13 +296,13 @@ def martin_ruiz_diffuse(surface_tilt, a_r=0.16, c1=0.4244, c2=None): c1 : float First fitting parameter for the expressions that approximate the integral of diffuse irradiance coming from different directions. - c1 is given as the constant 4 / 3 / pi (0.4244) in [1]. + c1 is given as the constant 4 / 3 / pi (0.4244) in [1]_. c2 : float Second fitting parameter for the expressions that approximate the integral of diffuse irradiance coming from different directions. If c2 is None, it will be calculated according to the linear - relationship given in [3]. + relationship given in [3]_. Returns ------- @@ -320,17 +320,17 @@ def martin_ruiz_diffuse(surface_tilt, a_r=0.16, c1=0.4244, c2=None): References ---------- - [1] N. Martin and J. M. Ruiz, "Calculation of the PV modules angular - losses under field conditions by means of an analytical model", Solar - Energy Materials & Solar Cells, vol. 70, pp. 25-38, 2001. + .. [1] N. Martin and J. M. Ruiz, "Calculation of the PV modules angular + losses under field conditions by means of an analytical model", Solar + Energy Materials & Solar Cells, vol. 70, pp. 25-38, 2001. - [2] N. Martin and J. M. Ruiz, "Corrigendum to 'Calculation of the PV - modules angular losses under field conditions by means of an - analytical model'", Solar Energy Materials & Solar Cells, vol. 110, - pp. 154, 2013. + .. [2] N. Martin and J. M. Ruiz, "Corrigendum to 'Calculation of the PV + modules angular losses under field conditions by means of an + analytical model'", Solar Energy Materials & Solar Cells, vol. 110, + pp. 154, 2013. - [3] "IEC 61853-3 Photovoltaic (PV) module performance testing and energy - rating - Part 3: Energy rating of PV modules". IEC, Geneva, 2018. + .. [3] "IEC 61853-3 Photovoltaic (PV) module performance testing and energy + rating - Part 3: Energy rating of PV modules". IEC, Geneva, 2018. See Also -------- @@ -480,28 +480,28 @@ def sapm(aoi, module, upper=None): Returns ------- iam : numeric - The SAPM angle of incidence loss coefficient, termed F2 in [1]. + The SAPM angle of incidence loss coefficient, termed F2 in [1]_. Notes ----- - The SAPM [1] traditionally does not define an upper limit on the AOI + The SAPM [1]_ traditionally does not define an upper limit on the AOI loss function and values slightly exceeding 1 may exist for moderate angles of incidence (15-40 degrees). However, users may consider imposing an upper limit of 1. References ---------- - [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance - Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, - NM. + .. [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance + Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, + NM. - [2] B.H. King et al, "Procedure to Determine Coefficients for the - Sandia Array Performance Model (SAPM)," SAND2016-5284, Sandia - National Laboratories (2016). + .. [2] B.H. King et al, "Procedure to Determine Coefficients for the + Sandia Array Performance Model (SAPM)," SAND2016-5284, Sandia + National Laboratories (2016). - [3] B.H. King et al, "Recent Advancements in Outdoor Measurement - Techniques for Angle of Incidence Effects," 42nd IEEE PVSC (2015). - DOI: 10.1109/PVSC.2015.7355849 + .. [3] B.H. King et al, "Recent Advancements in Outdoor Measurement + Techniques for Angle of Incidence Effects," 42nd IEEE PVSC (2015). + DOI: 10.1109/PVSC.2015.7355849 See Also -------- diff --git a/pvlib/iotools/epw.py b/pvlib/iotools/epw.py index 3fe7e8ab7d..22adbb0fc5 100644 --- a/pvlib/iotools/epw.py +++ b/pvlib/iotools/epw.py @@ -76,7 +76,7 @@ def read_epw(filename, coerce_year=None): day Day of the month, from original EPW file. hour Hour of the day from original EPW file. Note that EPW's convention of 1-24h is not taken over in the index dataframe used in PVLIB. minute Minute, from original EPW file. Not used. - data_source_unct Data source and uncertainty flags. See [1], chapter 2.13 + data_source_unct Data source and uncertainty flags. See [1]_, chapter 2.13 temp_air Dry bulb temperature at the time indicated, deg C temp_dew Dew-point temperature at the time indicated, deg C relative_humidity Relatitudeive humidity at the time indicated, percent @@ -111,8 +111,8 @@ def read_epw(filename, coerce_year=None): References ---------- - [1] EnergyPlus documentation, Auxiliary Programs - https://energyplus.net/documentation. + .. [1] EnergyPlus documentation, Auxiliary Programs + https://energyplus.net/documentation. ''' if filename.startswith('http'): diff --git a/pvlib/iotools/midc.py b/pvlib/iotools/midc.py index fc475ce73e..0cd9a26bfc 100644 --- a/pvlib/iotools/midc.py +++ b/pvlib/iotools/midc.py @@ -180,9 +180,9 @@ def read_midc(filename, variable_map={}, raw_data=False, **kwargs): The `variable_map` argument should map fields from MIDC data to pvlib names. - e.g. If a MIDC file contains the variable 'Global Horizontal [W/m^2]', - passing the dictionary below will rename the column to 'ghi' in - the returned Dataframe. + E.g. if a MIDC file contains the variable 'Global Horizontal [W/m^2]', + passing the dictionary below will rename the column to 'ghi' in + the returned Dataframe. {'Global Horizontal [W/m^2]': 'ghi'} diff --git a/pvlib/iotools/psm3.py b/pvlib/iotools/psm3.py index c9c2ed1201..c8445782e6 100644 --- a/pvlib/iotools/psm3.py +++ b/pvlib/iotools/psm3.py @@ -113,10 +113,10 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60, References ---------- - * `NREL Developer Network - Physical Solar Model (PSM) v3 - `_ - * `NREL National Solar Radiation Database (NSRDB) - `_ + .. [1] `NREL Developer Network - Physical Solar Model (PSM) v3 + `_ + .. [2] `NREL National Solar Radiation Database (NSRDB) + `_ """ # The well know text (WKT) representation of geometry notation is strict. diff --git a/pvlib/iotools/srml.py b/pvlib/iotools/srml.py index 6312dcd42e..3666d496b6 100644 --- a/pvlib/iotools/srml.py +++ b/pvlib/iotools/srml.py @@ -26,7 +26,7 @@ def read_srml(filename): """ - Read University of Oregon SRML[1] 1min .tsv file into pandas dataframe. + Read University of Oregon SRML[1]_ 1min .tsv file into pandas dataframe. Parameters ---------- @@ -55,8 +55,8 @@ def read_srml(filename): References ---------- - [1] University of Oregon Solar Radiation Monitoring Laboratory - `http://solardat.uoregon.edu/ `_ + .. [1] University of Oregon Solar Radiation Monitoring Laboratory + `http://solardat.uoregon.edu/ `_ """ tsv_data = pd.read_csv(filename, delimiter='\t') data = format_index(tsv_data) @@ -204,8 +204,8 @@ def read_srml_month_from_solardat(station, year, month, filetype='PO'): References ---------- - [1] University of Oregon Solar Radiation Measurement Laboratory - `http://solardat.uoregon.edu/ `_ + .. [1] University of Oregon Solar Radiation Measurement Laboratory + `http://solardat.uoregon.edu/ `_ """ file_name = "{station}{filetype}{year:02d}{month:02d}.txt".format( station=station, diff --git a/pvlib/iotools/surfrad.py b/pvlib/iotools/surfrad.py index 22e451cfeb..06f99cbd4f 100644 --- a/pvlib/iotools/surfrad.py +++ b/pvlib/iotools/surfrad.py @@ -38,7 +38,7 @@ def read_surfrad(filename, map_variables=True): - """Read in a daily NOAA SURFRAD[1] file. + """Read in a daily NOAA SURFRAD[1]_ file. Parameters ---------- @@ -112,14 +112,15 @@ def read_surfrad(filename, map_variables=True): ======================= ====== ========================================== See README files located in the station directories in the SURFRAD - data archives[2] for details on SURFRAD daily data files. + data archives[2]_ for details on SURFRAD daily data files. References ---------- - [1] NOAA Earth System Research Laboratory Surface Radiation Budget Network - `SURFRAD Homepage `_ - [2] NOAA SURFRAD Data Archive - `SURFRAD Archive `_ + .. [1] NOAA Earth System Research Laboratory Surface Radiation Budget + Network + `SURFRAD Homepage `_ + .. [2] NOAA SURFRAD Data Archive + `SURFRAD Archive `_ """ if filename.startswith('ftp'): req = Request(filename) diff --git a/pvlib/iotools/tmy.py b/pvlib/iotools/tmy.py index 767e18f570..bb9b74f250 100644 --- a/pvlib/iotools/tmy.py +++ b/pvlib/iotools/tmy.py @@ -17,7 +17,7 @@ def read_tmy3(filename=None, coerce_year=None, recolumn=True): Note that values contained in the metadata dictionary are unchanged from the TMY3 file (i.e. units are retained). In the case of any discrepencies between this documentation and the TMY3 User's Manual - [1], the TMY3 User's Manual takes precedence. + [1]_, the TMY3 User's Manual takes precedence. The TMY3 files were updated in Jan. 2015. This function requires the use of the updated files. @@ -72,82 +72,82 @@ def read_tmy3(filename=None, coerce_year=None, recolumn=True): TMYData.ETR Extraterrestrial horizontal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 TMYData.ETRN Extraterrestrial normal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 TMYData.GHI Direct and diffuse horizontal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 - TMYData.GHISource See [1], Table 1-4 - TMYData.GHIUncertainty Uncertainty based on random and bias error estimates see [2] + TMYData.GHISource See [1]_, Table 1-4 + TMYData.GHIUncertainty Uncertainty based on random and bias error estimates see [2]_ TMYData.DNI Amount of direct normal radiation (modeled) recv'd during 60 mintues prior to timestamp, Wh/m^2 - TMYData.DNISource See [1], Table 1-4 - TMYData.DNIUncertainty Uncertainty based on random and bias error estimates see [2] + TMYData.DNISource See [1]_, Table 1-4 + TMYData.DNIUncertainty Uncertainty based on random and bias error estimates see [2]_ TMYData.DHI Amount of diffuse horizontal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 - TMYData.DHISource See [1], Table 1-4 - TMYData.DHIUncertainty Uncertainty based on random and bias error estimates see [2] + TMYData.DHISource See [1]_, Table 1-4 + TMYData.DHIUncertainty Uncertainty based on random and bias error estimates see [2]_ TMYData.GHillum Avg. total horizontal illuminance recv'd during the 60 minutes prior to timestamp, lx - TMYData.GHillumSource See [1], Table 1-4 - TMYData.GHillumUncertainty Uncertainty based on random and bias error estimates see [2] + TMYData.GHillumSource See [1]_, Table 1-4 + TMYData.GHillumUncertainty Uncertainty based on random and bias error estimates see [2]_ TMYData.DNillum Avg. direct normal illuminance recv'd during the 60 minutes prior to timestamp, lx - TMYData.DNillumSource See [1], Table 1-4 - TMYData.DNillumUncertainty Uncertainty based on random and bias error estimates see [2] + TMYData.DNillumSource See [1]_, Table 1-4 + TMYData.DNillumUncertainty Uncertainty based on random and bias error estimates see [2]_ TMYData.DHillum Avg. horizontal diffuse illuminance recv'd during the 60 minutes prior to timestamp, lx - TMYData.DHillumSource See [1], Table 1-4 - TMYData.DHillumUncertainty Uncertainty based on random and bias error estimates see [2] + TMYData.DHillumSource See [1]_, Table 1-4 + TMYData.DHillumUncertainty Uncertainty based on random and bias error estimates see [2]_ TMYData.Zenithlum Avg. luminance at the sky's zenith during the 60 minutes prior to timestamp, cd/m^2 - TMYData.ZenithlumSource See [1], Table 1-4 - TMYData.ZenithlumUncertainty Uncertainty based on random and bias error estimates see [1] section 2.10 + TMYData.ZenithlumSource See [1]_, Table 1-4 + TMYData.ZenithlumUncertainty Uncertainty based on random and bias error estimates see [1]_ section 2.10 TMYData.TotCld Amount of sky dome covered by clouds or obscuring phenonema at time stamp, tenths of sky - TMYData.TotCldSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.TotCldUncertainty See [1], Table 1-6 + TMYData.TotCldSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.TotCldUncertainty See [1]_, Table 1-6 TMYData.OpqCld Amount of sky dome covered by clouds or obscuring phenonema that prevent observing the sky at time stamp, tenths of sky - TMYData.OpqCldSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.OpqCldUncertainty See [1], Table 1-6 + TMYData.OpqCldSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.OpqCldUncertainty See [1]_, Table 1-6 TMYData.DryBulb Dry bulb temperature at the time indicated, deg C - TMYData.DryBulbSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.DryBulbUncertainty See [1], Table 1-6 + TMYData.DryBulbSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.DryBulbUncertainty See [1]_, Table 1-6 TMYData.DewPoint Dew-point temperature at the time indicated, deg C - TMYData.DewPointSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.DewPointUncertainty See [1], Table 1-6 + TMYData.DewPointSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.DewPointUncertainty See [1]_, Table 1-6 TMYData.RHum Relatitudeive humidity at the time indicated, percent - TMYData.RHumSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.RHumUncertainty See [1], Table 1-6 + TMYData.RHumSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.RHumUncertainty See [1]_, Table 1-6 TMYData.Pressure Station pressure at the time indicated, 1 mbar - TMYData.PressureSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.PressureUncertainty See [1], Table 1-6 + TMYData.PressureSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.PressureUncertainty See [1]_, Table 1-6 TMYData.Wdir Wind direction at time indicated, degrees from north (360 = north; 0 = undefined,calm) - TMYData.WdirSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.WdirUncertainty See [1], Table 1-6 + TMYData.WdirSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.WdirUncertainty See [1]_, Table 1-6 TMYData.Wspd Wind speed at the time indicated, meter/second - TMYData.WspdSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.WspdUncertainty See [1], Table 1-6 + TMYData.WspdSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.WspdUncertainty See [1]_, Table 1-6 TMYData.Hvis Distance to discernable remote objects at time indicated (7777=unlimited), meter - TMYData.HvisSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.HvisUncertainty See [1], Table 1-6 + TMYData.HvisSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.HvisUncertainty See [1]_, Table 1-6 TMYData.CeilHgt Height of cloud base above local terrain (7777=unlimited), meter - TMYData.CeilHgtSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.CeilHgtUncertainty See [1], Table 1-6 + TMYData.CeilHgtSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.CeilHgtUncertainty See [1]_, Table 1-6 TMYData.Pwat Total precipitable water contained in a column of unit cross section from earth to top of atmosphere, cm - TMYData.PwatSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.PwatUncertainty See [1], Table 1-6 + TMYData.PwatSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.PwatUncertainty See [1]_, Table 1-6 TMYData.AOD The broadband aerosol optical depth per unit of air mass due to extinction by aerosol component of atmosphere, unitless - TMYData.AODSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.AODUncertainty See [1], Table 1-6 + TMYData.AODSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.AODUncertainty See [1]_, Table 1-6 TMYData.Alb The ratio of reflected solar irradiance to global horizontal irradiance, unitless - TMYData.AlbSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.AlbUncertainty See [1], Table 1-6 + TMYData.AlbSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.AlbUncertainty See [1]_, Table 1-6 TMYData.Lprecipdepth The amount of liquid precipitation observed at indicated time for the period indicated in the liquid precipitation quantity field, millimeter TMYData.Lprecipquantity The period of accumulatitudeion for the liquid precipitation depth field, hour - TMYData.LprecipSource See [1], Table 1-5, 8760x1 cell array of strings - TMYData.LprecipUncertainty See [1], Table 1-6 - TMYData.PresWth Present weather code, see [2]. - TMYData.PresWthSource Present weather code source, see [2]. - TMYData.PresWthUncertainty Present weather code uncertainty, see [2]. + TMYData.LprecipSource See [1]_, Table 1-5, 8760x1 cell array of strings + TMYData.LprecipUncertainty See [1]_, Table 1-6 + TMYData.PresWth Present weather code, see [2]_. + TMYData.PresWthSource Present weather code source, see [2]_. + TMYData.PresWthUncertainty Present weather code uncertainty, see [2]_. ============================= ====================================================================================================================================================== References ---------- - [1] Wilcox, S and Marion, W. "Users Manual for TMY3 Data Sets". - NREL/TP-581-43156, Revised May 2008. + .. [1] Wilcox, S and Marion, W. "Users Manual for TMY3 Data Sets". + NREL/TP-581-43156, Revised May 2008. - [2] Wilcox, S. (2007). National Solar Radiation Database 1991 2005 - Update: Users Manual. 472 pp.; NREL Report No. TP-581-41364. + .. [2] Wilcox, S. (2007). National Solar Radiation Database 1991 2005 + Update: Users Manual. 472 pp.; NREL Report No. TP-581-41364. ''' if filename is None: @@ -274,7 +274,7 @@ def read_tmy2(filename): form conforming to modern conventions (e.g. N latitude is postive, E longitude is positive, the "24th" hour of any day is technically the "0th" hour of the next day). In the case of any discrepencies - between this documentation and the TMY2 User's Manual [1], the TMY2 + between this documentation and the TMY2 User's Manual [1]_, the TMY2 User's Manual takes precedence. Parameters @@ -290,7 +290,7 @@ def read_tmy2(filename): data : DataFrame A dataframe with the columns described in the table below. For a more detailed descriptions of each component, please consult the - TMY2 User's Manual ([1]), especially tables 3-1 through 3-6, and + TMY2 User's Manual ([1]_), especially tables 3-1 through 3-6, and Appendix B. metadata : dict @@ -324,76 +324,76 @@ def read_tmy2(filename): ETR Extraterrestrial horizontal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 ETRN Extraterrestrial normal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 GHI Direct and diffuse horizontal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 - GHISource See [1], Table 3-3 - GHIUncertainty See [1], Table 3-4 + GHISource See [1]_, Table 3-3 + GHIUncertainty See [1]_, Table 3-4 DNI Amount of direct normal radiation (modeled) recv'd during 60 mintues prior to timestamp, Wh/m^2 - DNISource See [1], Table 3-3 - DNIUncertainty See [1], Table 3-4 + DNISource See [1]_, Table 3-3 + DNIUncertainty See [1]_, Table 3-4 DHI Amount of diffuse horizontal radiation recv'd during 60 minutes prior to timestamp, Wh/m^2 - DHISource See [1], Table 3-3 - DHIUncertainty See [1], Table 3-4 + DHISource See [1]_, Table 3-3 + DHIUncertainty See [1]_, Table 3-4 GHillum Avg. total horizontal illuminance recv'd during the 60 minutes prior to timestamp, units of 100 lux (e.g. value of 50 = 5000 lux) - GHillumSource See [1], Table 3-3 - GHillumUncertainty See [1], Table 3-4 + GHillumSource See [1]_, Table 3-3 + GHillumUncertainty See [1]_, Table 3-4 DNillum Avg. direct normal illuminance recv'd during the 60 minutes prior to timestamp, units of 100 lux - DNillumSource See [1], Table 3-3 - DNillumUncertainty See [1], Table 3-4 + DNillumSource See [1]_, Table 3-3 + DNillumUncertainty See [1]_, Table 3-4 DHillum Avg. horizontal diffuse illuminance recv'd during the 60 minutes prior to timestamp, units of 100 lux - DHillumSource See [1], Table 3-3 - DHillumUncertainty See [1], Table 3-4 + DHillumSource See [1]_, Table 3-3 + DHillumUncertainty See [1]_, Table 3-4 Zenithlum Avg. luminance at the sky's zenith during the 60 minutes prior to timestamp, units of 10 Cd/m^2 (e.g. value of 700 = 7,000 Cd/m^2) - ZenithlumSource See [1], Table 3-3 - ZenithlumUncertainty See [1], Table 3-4 + ZenithlumSource See [1]_, Table 3-3 + ZenithlumUncertainty See [1]_, Table 3-4 TotCld Amount of sky dome covered by clouds or obscuring phenonema at time stamp, tenths of sky - TotCldSource See [1], Table 3-5, 8760x1 cell array of strings - TotCldUncertainty See [1], Table 3-6 + TotCldSource See [1]_, Table 3-5, 8760x1 cell array of strings + TotCldUncertainty See [1]_, Table 3-6 OpqCld Amount of sky dome covered by clouds or obscuring phenonema that prevent observing the sky at time stamp, tenths of sky - OpqCldSource See [1], Table 3-5, 8760x1 cell array of strings - OpqCldUncertainty See [1], Table 3-6 + OpqCldSource See [1]_, Table 3-5, 8760x1 cell array of strings + OpqCldUncertainty See [1]_, Table 3-6 DryBulb Dry bulb temperature at the time indicated, in tenths of degree C (e.g. 352 = 35.2 C). - DryBulbSource See [1], Table 3-5, 8760x1 cell array of strings - DryBulbUncertainty See [1], Table 3-6 + DryBulbSource See [1]_, Table 3-5, 8760x1 cell array of strings + DryBulbUncertainty See [1]_, Table 3-6 DewPoint Dew-point temperature at the time indicated, in tenths of degree C (e.g. 76 = 7.6 C). - DewPointSource See [1], Table 3-5, 8760x1 cell array of strings - DewPointUncertainty See [1], Table 3-6 + DewPointSource See [1]_, Table 3-5, 8760x1 cell array of strings + DewPointUncertainty See [1]_, Table 3-6 RHum Relative humidity at the time indicated, percent - RHumSource See [1], Table 3-5, 8760x1 cell array of strings - RHumUncertainty See [1], Table 3-6 + RHumSource See [1]_, Table 3-5, 8760x1 cell array of strings + RHumUncertainty See [1]_, Table 3-6 Pressure Station pressure at the time indicated, 1 mbar - PressureSource See [1], Table 3-5, 8760x1 cell array of strings - PressureUncertainty See [1], Table 3-6 + PressureSource See [1]_, Table 3-5, 8760x1 cell array of strings + PressureUncertainty See [1]_, Table 3-6 Wdir Wind direction at time indicated, degrees from east of north (360 = 0 = north; 90 = East; 0 = undefined,calm) - WdirSource See [1], Table 3-5, 8760x1 cell array of strings - WdirUncertainty See [1], Table 3-6 + WdirSource See [1]_, Table 3-5, 8760x1 cell array of strings + WdirUncertainty See [1]_, Table 3-6 Wspd Wind speed at the time indicated, in tenths of meters/second (e.g. 212 = 21.2 m/s) - WspdSource See [1], Table 3-5, 8760x1 cell array of strings - WspdUncertainty See [1], Table 3-6 + WspdSource See [1]_, Table 3-5, 8760x1 cell array of strings + WspdUncertainty See [1]_, Table 3-6 Hvis Distance to discernable remote objects at time indicated (7777=unlimited, 9999=missing data), in tenths of kilometers (e.g. 341 = 34.1 km). - HvisSource See [1], Table 3-5, 8760x1 cell array of strings - HvisUncertainty See [1], Table 3-6 + HvisSource See [1]_, Table 3-5, 8760x1 cell array of strings + HvisUncertainty See [1]_, Table 3-6 CeilHgt Height of cloud base above local terrain (7777=unlimited, 88888=cirroform, 99999=missing data), in meters - CeilHgtSource See [1], Table 3-5, 8760x1 cell array of strings - CeilHgtUncertainty See [1], Table 3-6 + CeilHgtSource See [1]_, Table 3-5, 8760x1 cell array of strings + CeilHgtUncertainty See [1]_, Table 3-6 Pwat Total precipitable water contained in a column of unit cross section from Earth to top of atmosphere, in millimeters - PwatSource See [1], Table 3-5, 8760x1 cell array of strings - PwatUncertainty See [1], Table 3-6 + PwatSource See [1]_, Table 3-5, 8760x1 cell array of strings + PwatUncertainty See [1]_, Table 3-6 AOD The broadband aerosol optical depth (broadband turbidity) in thousandths on the day indicated (e.g. 114 = 0.114) - AODSource See [1], Table 3-5, 8760x1 cell array of strings - AODUncertainty See [1], Table 3-6 + AODSource See [1]_, Table 3-5, 8760x1 cell array of strings + AODUncertainty See [1]_, Table 3-6 SnowDepth Snow depth in centimeters on the day indicated, (999 = missing data). - SnowDepthSource See [1], Table 3-5, 8760x1 cell array of strings - SnowDepthUncertainty See [1], Table 3-6 + SnowDepthSource See [1]_, Table 3-5, 8760x1 cell array of strings + SnowDepthUncertainty See [1]_, Table 3-6 LastSnowfall Number of days since last snowfall (maximum value of 88, where 88 = 88 or greater days; 99 = missing data) - LastSnowfallSource See [1], Table 3-5, 8760x1 cell array of strings - LastSnowfallUncertainty See [1], Table 3-6 - PresentWeather See [1], Appendix B, an 8760x1 cell array of strings. Each string contains 10 numeric values. The string can be parsed to determine each of 10 observed weather metrics. + LastSnowfallSource See [1]_, Table 3-5, 8760x1 cell array of strings + LastSnowfallUncertainty See [1]_, Table 3-6 + PresentWeather See [1]_, Appendix B, an 8760x1 cell array of strings. Each string contains 10 numeric values. The string can be parsed to determine each of 10 observed weather metrics. ============================ ========================================================================================================================================================================== References ---------- - [1] Marion, W and Urban, K. "Wilcox, S and Marion, W. "User's Manual - for TMY2s". NREL 1995. + .. [1] Marion, W and Urban, K. "Wilcox, S and Marion, W. "User's Manual + for TMY2s". NREL 1995. ''' if filename is None: diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 9c62a01828..23e38d8f1f 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -65,22 +65,22 @@ def get_extra_radiation(datetime_or_doy, solar_constant=1366.1, References ---------- - [1] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance - Clear Sky Models: Implementation and Analysis", Sandia National - Laboratories, SAND2012-2389, 2012. + .. [1] M. Reno, C. Hansen, and J. Stein, "Global Horizontal Irradiance + Clear Sky Models: Implementation and Analysis", Sandia National + Laboratories, SAND2012-2389, 2012. - [2] , Eqs. - SR1 and SR2 + .. [2] , Eqs. + SR1 and SR2 - [3] Partridge, G. W. and Platt, C. M. R. 1976. Radiative Processes - in Meteorology and Climatology. + .. [3] Partridge, G. W. and Platt, C. M. R. 1976. Radiative Processes + in Meteorology and Climatology. - [4] Duffie, J. A. and Beckman, W. A. 1991. Solar Engineering of - Thermal Processes, 2nd edn. J. Wiley and Sons, New York. + .. [4] Duffie, J. A. and Beckman, W. A. 1991. Solar Engineering of + Thermal Processes, 2nd edn. J. Wiley and Sons, New York. - [5] ASCE, 2005. The ASCE Standardized Reference Evapotranspiration - Equation, Environmental and Water Resources Institute of the American - Civil Engineers, Ed. R. G. Allen et al. + .. [5] ASCE, 2005. The ASCE Standardized Reference Evapotranspiration + Equation, Environmental and Water Resources Institute of the American + Civil Engineers, Ed. R. G. Allen et al. """ to_doy, to_datetimeindex, to_output = \ @@ -535,18 +535,18 @@ def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None): References ---------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to compute - solar irradiance on inclined surfaces for building energy simulation" - 2007, Solar Energy vol. 81. pp. 254-267. + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to compute + solar irradiance on inclined surfaces for building energy simulation" + 2007, Solar Energy vol. 81. pp. 254-267. The calculation is the last term of equations 3, 4, 7, 8, 10, 11, and 12. - [2] albedos from: - http://files.pvsyst.com/help/albedo.htm - and - http://en.wikipedia.org/wiki/Albedo - and - https://doi.org/10.1175/1520-0469(1972)029<0959:AOTSS>2.0.CO;2 + .. [2] albedos from: + http://files.pvsyst.com/help/albedo.htm + and + http://en.wikipedia.org/wiki/Albedo + and + https://doi.org/10.1175/1520-0469(1972)029<0959:AOTSS>2.0.CO;2 ''' if surface_type is not None: @@ -594,12 +594,12 @@ def isotropic(surface_tilt, dhi): References ---------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to - compute solar irradiance on inclined surfaces for building energy - simulation" 2007, Solar Energy vol. 81. pp. 254-267 + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to + compute solar irradiance on inclined surfaces for building energy + simulation" 2007, Solar Energy vol. 81. pp. 254-267 - [2] Hottel, H.C., Woertz, B.B., 1942. Evaluation of flat-plate solar - heat collector. Trans. ASME 64, 91. + .. [2] Hottel, H.C., Woertz, B.B., 1942. Evaluation of flat-plate solar + heat collector. Trans. ASME 64, 91. ''' sky_diffuse = dhi * (1 + tools.cosd(surface_tilt)) * 0.5 @@ -665,12 +665,12 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, References ---------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to compute - solar irradiance on inclined surfaces for building energy simulation" - 2007, Solar Energy vol. 81. pp. 254-267 + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to compute + solar irradiance on inclined surfaces for building energy simulation" + 2007, Solar Energy vol. 81. pp. 254-267 - [2] Klucher, T.M., 1979. Evaluation of models to predict insolation on - tilted surfaces. Solar Energy 23 (2), 111-114. + .. [2] Klucher, T.M., 1979. Evaluation of models to predict insolation on + tilted surfaces. Solar Energy 23 (2), 111-114. ''' # zenith angle with respect to panel normal. @@ -756,14 +756,14 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra, References ----------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to - compute solar irradiance on inclined surfaces for building energy - simulation" 2007, Solar Energy vol. 81. pp. 254-267 - - [2] Hay, J.E., Davies, J.A., 1980. Calculations of the solar - radiation incident on an inclined surface. In: Hay, J.E., Won, T.K. - (Eds.), Proc. of First Canadian Solar Radiation Data Workshop, 59. - Ministry of Supply and Services, Canada. + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to + compute solar irradiance on inclined surfaces for building energy + simulation" 2007, Solar Energy vol. 81. pp. 254-267 + + .. [2] Hay, J.E., Davies, J.A., 1980. Calculations of the solar + radiation incident on an inclined surface. In: Hay, J.E., Won, T.K. + (Eds.), Proc. of First Canadian Solar Radiation Data Workshop, 59. + Ministry of Supply and Services, Canada. ''' # if necessary, calculate ratio of titled and horizontal beam irradiance @@ -854,15 +854,15 @@ def reindl(surface_tilt, surface_azimuth, dhi, dni, ghi, dni_extra, References ---------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to - compute solar irradiance on inclined surfaces for building energy - simulation" 2007, Solar Energy vol. 81. pp. 254-267 + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to + compute solar irradiance on inclined surfaces for building energy + simulation" 2007, Solar Energy vol. 81. pp. 254-267 - [2] Reindl, D.T., Beckmann, W.A., Duffie, J.A., 1990a. Diffuse - fraction correlations. Solar Energy 45(1), 1-7. + .. [2] Reindl, D.T., Beckmann, W.A., Duffie, J.A., 1990a. Diffuse + fraction correlations. Solar Energy 45(1), 1-7. - [3] Reindl, D.T., Beckmann, W.A., Duffie, J.A., 1990b. Evaluation of - hourly tilted surface radiation models. Solar Energy 45(1), 9-17. + .. [3] Reindl, D.T., Beckmann, W.A., Duffie, J.A., 1990b. Evaluation of + hourly tilted surface radiation models. Solar Energy 45(1), 9-17. ''' cos_tt = aoi_projection(surface_tilt, surface_azimuth, @@ -1029,20 +1029,20 @@ def perez(surface_tilt, surface_azimuth, dhi, dni, dni_extra, References ---------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to - compute solar irradiance on inclined surfaces for building energy - simulation" 2007, Solar Energy vol. 81. pp. 254-267 + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to + compute solar irradiance on inclined surfaces for building energy + simulation" 2007, Solar Energy vol. 81. pp. 254-267 - [2] Perez, R., Seals, R., Ineichen, P., Stewart, R., Menicucci, D., - 1987. A new simplified version of the Perez diffuse irradiance model - for tilted surfaces. Solar Energy 39(3), 221-232. + .. [2] Perez, R., Seals, R., Ineichen, P., Stewart, R., Menicucci, D., + 1987. A new simplified version of the Perez diffuse irradiance model + for tilted surfaces. Solar Energy 39(3), 221-232. - [3] Perez, R., Ineichen, P., Seals, R., Michalsky, J., Stewart, R., - 1990. Modeling daylight availability and irradiance components from - direct and global irradiance. Solar Energy 44 (5), 271-289. + .. [3] Perez, R., Ineichen, P., Seals, R., Michalsky, J., Stewart, R., + 1990. Modeling daylight availability and irradiance components from + direct and global irradiance. Solar Energy 44 (5), 271-289. - [4] Perez, R. et. al 1988. "The Development and Verification of the - Perez Diffuse Radiation Model". SAND88-7030 + .. [4] Perez, R. et. al 1988. "The Development and Verification of the + Perez Diffuse Radiation Model". SAND88-7030 ''' kappa = 1.041 # for solar_zenith in radians @@ -1486,13 +1486,13 @@ def dirint(ghi, solar_zenith, times, pressure=101325., use_delta_kt_prime=True, References ---------- - [1] Perez, R., P. Ineichen, E. Maxwell, R. Seals and A. Zelenka, - (1992). "Dynamic Global-to-Direct Irradiance Conversion Models". - ASHRAE Transactions-Research Series, pp. 354-369 + .. [1] Perez, R., P. Ineichen, E. Maxwell, R. Seals and A. Zelenka, + (1992). "Dynamic Global-to-Direct Irradiance Conversion Models". + ASHRAE Transactions-Research Series, pp. 354-369 - [2] Maxwell, E. L., "A Quasi-Physical Model for Converting Hourly - Global Horizontal to Direct Normal Insolation", Technical Report No. - SERI/TR-215-3087, Golden, CO: Solar Energy Research Institute, 1987. + .. [2] Maxwell, E. L., "A Quasi-Physical Model for Converting Hourly + Global Horizontal to Direct Normal Insolation", Technical Report No. + SERI/TR-215-3087, Golden, CO: Solar Energy Research Institute, 1987. """ disc_out = disc(ghi, solar_zenith, times, pressure=pressure, @@ -1734,9 +1734,9 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325., References ---------- - [1] Perez, R., Ineichen, P., Moore, K., Kmiecik, M., Chain, C., George, R., - & Vignola, F. (2002). A new operational model for satellite-derived - irradiances: description and validation. Solar Energy, 73(5), 307-317. + .. [1] Perez, R., Ineichen, P., Moore, K., Kmiecik, M., Chain, C., George, + R., & Vignola, F. (2002). A new operational model for satellite-derived + irradiances: description and validation. Solar Energy, 73(5), 307-317. """ dni_dirint = dirint(ghi, zenith, times, pressure=pressure, @@ -2214,12 +2214,12 @@ def liujordan(zenith, transmittance, airmass, dni_extra=1367.0): References ---------- - [1] Campbell, G. S., J. M. Norman (1998) An Introduction to - Environmental Biophysics. 2nd Ed. New York: Springer. + .. [1] Campbell, G. S., J. M. Norman (1998) An Introduction to + Environmental Biophysics. 2nd Ed. New York: Springer. - [2] Liu, B. Y., R. C. Jordan, (1960). "The interrelationship and - characteristic distribution of direct, diffuse, and total solar - radiation". Solar Energy 4:1-19 + .. [2] Liu, B. Y., R. C. Jordan, (1960). "The interrelationship and + characteristic distribution of direct, diffuse, and total solar + radiation". Solar Energy 4:1-19 ''' tau = transmittance @@ -2274,20 +2274,20 @@ def _get_perez_coefficients(perezmodel): References ---------- - [1] Loutzenhiser P.G. et. al. "Empirical validation of models to - compute solar irradiance on inclined surfaces for building energy - simulation" 2007, Solar Energy vol. 81. pp. 254-267 + .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to + compute solar irradiance on inclined surfaces for building energy + simulation" 2007, Solar Energy vol. 81. pp. 254-267 - [2] Perez, R., Seals, R., Ineichen, P., Stewart, R., Menicucci, D., - 1987. A new simplified version of the Perez diffuse irradiance model - for tilted surfaces. Solar Energy 39(3), 221-232. + .. [2] Perez, R., Seals, R., Ineichen, P., Stewart, R., Menicucci, D., + 1987. A new simplified version of the Perez diffuse irradiance model + for tilted surfaces. Solar Energy 39(3), 221-232. - [3] Perez, R., Ineichen, P., Seals, R., Michalsky, J., Stewart, R., - 1990. Modeling daylight availability and irradiance components from - direct and global irradiance. Solar Energy 44 (5), 271-289. + .. [3] Perez, R., Ineichen, P., Seals, R., Michalsky, J., Stewart, R., + 1990. Modeling daylight availability and irradiance components from + direct and global irradiance. Solar Energy 44 (5), 271-289. - [4] Perez, R. et. al 1988. "The Development and Verification of the - Perez Diffuse Radiation Model". SAND88-7030 + .. [4] Perez, R. et. al 1988. "The Development and Verification of the + Perez Diffuse Radiation Model". SAND88-7030 ''' coeffdict = { diff --git a/pvlib/ivtools.py b/pvlib/ivtools.py index 4806b2ed16..6f101324f7 100644 --- a/pvlib/ivtools.py +++ b/pvlib/ivtools.py @@ -40,36 +40,35 @@ def fit_sdm_cec_sam(celltype, v_mp, i_mp, v_oc, i_sc, alpha_sc, beta_voc, Returns ------- - tuple of the following elements: + I_L_ref : float + The light-generated current (or photocurrent) at reference + conditions [A] - * I_L_ref : float - The light-generated current (or photocurrent) at reference - conditions [A] + I_o_ref : float + The dark or diode reverse saturation current at reference + conditions [A] - * I_o_ref : float - The dark or diode reverse saturation current at reference - conditions [A] + R_sh_ref : float + The shunt resistance at reference conditions, in ohms. - * R_sh_ref : float - The shunt resistance at reference conditions, in ohms. + R_s : float + The series resistance at reference conditions, in ohms. - * R_s : float - The series resistance at reference conditions, in ohms. + a_ref : float + The product of the usual diode ideality factor ``n`` (unitless), + number of cells in series ``Ns``, and cell thermal voltage at + reference conditions [V] - * a_ref : float - The product of the usual diode ideality factor ``n`` (unitless), - number of cells in series ``Ns``, and cell thermal voltage at - reference conditions [V] - - * Adjust : float - The adjustment to the temperature coefficient for short circuit - current, in percent. + Adjust : float + The adjustment to the temperature coefficient for short circuit + current, in percent. Raises ------ - ImportError if NREL-PySAM is not installed. - - RuntimeError if parameter extraction is not successful. + ImportError + If NREL-PySAM is not installed. + RuntimeError + If parameter extraction is not successful. Notes ----- @@ -82,9 +81,9 @@ def fit_sdm_cec_sam(celltype, v_mp, i_mp, v_oc, i_sc, alpha_sc, beta_voc, References ---------- - [1] A. Dobos, "An Improved Coefficient Calculator for the California - Energy Commission 6 Parameter Photovoltaic Module Model", Journal of - Solar Energy Engineering, vol 134, 2012. + .. [1] A. Dobos, "An Improved Coefficient Calculator for the California + Energy Commission 6 Parameter Photovoltaic Module Model", Journal of + Solar Energy Engineering, vol 134, 2012. """ try: @@ -147,23 +146,22 @@ def fit_sde_sandia(voltage, current, v_oc=None, i_sc=None, v_mp_i_mp=None, Returns ------- - tuple of the following elements: - - * photocurrent : float - photocurrent [A] - * saturation_current : float - dark (saturation) current [A] - * resistance_shunt : float - shunt (parallel) resistance, in ohms - * resistance_series : float - series resistance, in ohms - * nNsVth : float - product of thermal voltage ``Vth`` [V], diode ideality factor - ``n``, and number of series cells ``Ns`` + photocurrent : float + photocurrent [A] + saturation_current : float + dark (saturation) current [A] + resistance_shunt : float + shunt (parallel) resistance, in ohms + resistance_series : float + series resistance, in ohms + nNsVth : float + product of thermal voltage ``Vth`` [V], diode ideality factor + ``n``, and number of series cells ``Ns`` Raises ------ - RuntimeError if parameter extraction is not successful. + RuntimeError + If parameter extraction is not successful. Notes ----- @@ -172,7 +170,7 @@ def fit_sde_sandia(voltage, current, v_oc=None, i_sc=None, v_mp_i_mp=None, temperature. :py:func:`fit_single_diode_sandia` obtains values for the five parameters - for the single diode equation [1]: + for the single diode equation [1]_: .. math:: @@ -181,7 +179,7 @@ def fit_sde_sandia(voltage, current, v_oc=None, i_sc=None, v_mp_i_mp=None, See :py:func:`pvsystem.singlediode` for definition of the parameters. - The extraction method [2] proceeds in six steps. + The extraction method [2]_ proceeds in six steps. 1. In the single diode equation, replace :math:`R_{sh} = 1/G_{p}` and re-arrange @@ -233,11 +231,11 @@ def fit_sde_sandia(voltage, current, v_oc=None, i_sc=None, v_mp_i_mp=None, References ---------- - [1] S.R. Wenham, M.A. Green, M.E. Watt, "Applied Photovoltaics" ISBN - 0 86758 909 4 - [2] C. B. Jones, C. W. Hansen, Single Diode Parameter Extraction from - In-Field Photovoltaic I-V Curves on a Single Board Computer, 46th IEEE - Photovoltaic Specialist Conference, Chicago, IL, 2019 + .. [1] S.R. Wenham, M.A. Green, M.E. Watt, "Applied Photovoltaics" ISBN + 0 86758 909 4 + .. [2] C. B. Jones, C. W. Hansen, Single Diode Parameter Extraction from + In-Field Photovoltaic I-V Curves on a Single Board Computer, 46th IEEE + Photovoltaic Specialist Conference, Chicago, IL, 2019 """ # If not provided, extract v_oc, i_sc, v_mp and i_mp from the IV curve data @@ -267,7 +265,7 @@ def fit_sdm_desoto(v_mp, i_mp, v_oc, i_sc, alpha_sc, beta_voc, temp_ref=25, irrad_ref=1000, root_kwargs={}): """ Calculates the parameters for the De Soto single diode model using the - procedure described in [1]. This procedure has the advantage of + procedure described in [1]_. This procedure has the advantage of using common specifications given by manufacturers in the datasheets of PV modules. @@ -314,45 +312,43 @@ def fit_sdm_desoto(v_mp, i_mp, v_oc, i_sc, alpha_sc, beta_voc, Returns ------- - Tuple of the following elements: - - * Dictionary with the following elements: - I_L_ref: float - Light-generated current at reference conditions [A] - I_o_ref: float - Diode saturation current at reference conditions [A] - R_s: float - Series resistance [ohms] - R_sh_ref: float - Shunt resistance at reference conditions [ohms]. - a_ref: float - Modified ideality factor at reference conditions. - The product of the usual diode ideality factor (n, unitless), - number of cells in series (Ns), and cell thermal voltage at - specified effective irradiance and cell temperature. - alpha_sc: float - The short-circuit current (i_sc) temperature coefficient of the - module [A/K]. - EgRef: float - Energy of bandgap of semi-conductor used [eV] - dEgdT: float - Variation of bandgap according to temperature [eV/K] - irrad_ref: float - Reference irradiance condition [W/m2] - temp_ref: float - Reference temperature condition [C] - * scipy.optimize.OptimizeResult - Optimization result of scipy.optimize.root(). - See scipy.optimize.OptimizeResult for more details. + Dictionary with the following elements: + * ``I_L_ref`` (float) -- + Light-generated current at reference conditions [A] + * ``I_o_ref`` (float) -- + Diode saturation current at reference conditions [A] + * ``R_s`` (float) -- + Series resistance [ohms] + * ``R_sh_ref`` (float) -- + Shunt resistance at reference conditions [ohms]. + * ``a_ref`` (float) -- + Modified ideality factor at reference conditions. + The product of the usual diode ideality factor (n, unitless), + number of cells in series (Ns), and cell thermal voltage at + specified effective irradiance and cell temperature. + * ``alpha_sc`` (float) -- + The short-circuit current (i_sc) temperature coefficient of the + module [A/K]. + * ``EgRef`` (float) -- + Energy of bandgap of semi-conductor used [eV] + * ``dEgdT`` (float) -- + Variation of bandgap according to temperature [eV/K] + * ``irrad_ref`` (float) -- + Reference irradiance condition [W/m2] + * ``temp_ref`` (float) -- + Reference temperature condition [C] + scipy.optimize.OptimizeResult + Optimization result of scipy.optimize.root(). + See scipy.optimize.OptimizeResult for more details. References ---------- - [1] W. De Soto et al., "Improvement and validation of a model for - photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, - 2006. + .. [1] W. De Soto et al., "Improvement and validation of a model for + photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, + 2006. - [2] John A Duffie, William A Beckman, "Solar Engineering of Thermal - Processes", Wiley, 2013 + .. [2] John A Duffie, William A Beckman, "Solar Engineering of Thermal + Processes", Wiley, 2013 """ try: @@ -512,12 +508,12 @@ def _system_of_equations_desoto(params, specs): References ---------- - [1] W. De Soto et al., "Improvement and validation of a model for - photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, - 2006. + .. [1] W. De Soto et al., "Improvement and validation of a model for + photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, + 2006. - [2] John A Duffie, William A Beckman, "Solar Engineering of Thermal - Processes", Wiley, 2013 + .. [2] John A Duffie, William A Beckman, "Solar Engineering of Thermal + Processes", Wiley, 2013 """ # six input known variables diff --git a/pvlib/location.py b/pvlib/location.py index 95029ca166..38140c355a 100644 --- a/pvlib/location.py +++ b/pvlib/location.py @@ -99,8 +99,7 @@ def from_tmy(cls, tmy_metadata, tmy_data=None, **kwargs): Returns ------- - Location object (or the child class of Location that you - called this method from). + Location """ # not complete, but hopefully you get the idea. # might need code to handle the difference between tmy2 and tmy3 diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index 1ab916cd77..2b9c093a67 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -757,7 +757,9 @@ def complete_irradiance(self, weather, times=None): ------- self - Assigns attributes: weather + Notes + ----- + Assigns attributes: ``weather`` Examples -------- @@ -833,7 +835,7 @@ def prepare_inputs(self, weather, times=None): Notes ----- Assigns attributes: ``solar_position``, ``airmass``, - ``total_irrad``, `aoi` + ``total_irrad``, ``aoi`` See also -------- @@ -924,9 +926,12 @@ def run_model(self, weather, times=None): ------- self - Assigns attributes: solar_position, airmass, irradiance, - total_irrad, effective_irradiance, weather, cell_temperature, aoi, - aoi_modifier, spectral_modifier, dc, ac, losses. + Notes + ----- + Assigns attributes: ``solar_position``, ``airmass``, ``irradiance``, + ``total_irrad``, ``effective_irradiance``, ``weather``, + ``cell_temperature``, ``aoi``, ``aoi_modifier``, ``spectral_modifier``, + ``dc``, ``ac``, ``losses``. """ if times is not None: warnings.warn('times keyword argument is deprecated and will be ' diff --git a/pvlib/pvsystem.py b/pvlib/pvsystem.py index 850339b861..e1a8e66d8c 100644 --- a/pvlib/pvsystem.py +++ b/pvlib/pvsystem.py @@ -966,7 +966,7 @@ def calcparams_desoto(effective_irradiance, temp_cell, ''' Calculates five parameter values for the single diode equation at effective irradiance and cell temperature using the De Soto et al. - model described in [1]. The five values returned by calcparams_desoto + model described in [1]_. The five values returned by calcparams_desoto can be used by singlediode to calculate an IV curve. Parameters @@ -1009,7 +1009,7 @@ def calcparams_desoto(effective_irradiance, temp_cell, dEgdT : float The temperature dependence of the energy bandgap at reference conditions in units of 1/K. May be either a scalar value - (e.g. -0.0002677 as in [1]) or a DataFrame (this may be useful if + (e.g. -0.0002677 as in [1]_) or a DataFrame (this may be useful if dEgdT is a modeled as a function of temperature). For parameters from the SAM CEC module database, dEgdT=-0.0002677 is implicit for all cell types in the parameter estimation algorithm used by NREL. @@ -1043,18 +1043,18 @@ def calcparams_desoto(effective_irradiance, temp_cell, References ---------- - [1] W. De Soto et al., "Improvement and validation of a model for - photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, - 2006. + .. [1] W. De Soto et al., "Improvement and validation of a model for + photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, + 2006. - [2] System Advisor Model web page. https://sam.nrel.gov. + .. [2] System Advisor Model web page. https://sam.nrel.gov. - [3] A. Dobos, "An Improved Coefficient Calculator for the California - Energy Commission 6 Parameter Photovoltaic Module Model", Journal of - Solar Energy Engineering, vol 134, 2012. + .. [3] A. Dobos, "An Improved Coefficient Calculator for the California + Energy Commission 6 Parameter Photovoltaic Module Model", Journal of + Solar Energy Engineering, vol 134, 2012. - [4] O. Madelung, "Semiconductors: Data Handbook, 3rd ed." ISBN - 3-540-40488-0 + .. [4] O. Madelung, "Semiconductors: Data Handbook, 3rd ed." ISBN + 3-540-40488-0 See Also -------- @@ -1186,8 +1186,8 @@ def calcparams_cec(effective_irradiance, temp_cell, ''' Calculates five parameter values for the single diode equation at effective irradiance and cell temperature using the CEC - model described in [1]. The CEC model differs from the De soto et al. - model [3] by the parameter Adjust. The five values returned by + model described in [1]_. The CEC model differs from the De soto et al. + model [3]_ by the parameter Adjust. The five values returned by calcparams_cec can be used by singlediode to calculate an IV curve. Parameters @@ -1268,15 +1268,15 @@ def calcparams_cec(effective_irradiance, temp_cell, References ---------- - [1] A. Dobos, "An Improved Coefficient Calculator for the California - Energy Commission 6 Parameter Photovoltaic Module Model", Journal of - Solar Energy Engineering, vol 134, 2012. + .. [1] A. Dobos, "An Improved Coefficient Calculator for the California + Energy Commission 6 Parameter Photovoltaic Module Model", Journal of + Solar Energy Engineering, vol 134, 2012. - [2] System Advisor Model web page. https://sam.nrel.gov. + .. [2] System Advisor Model web page. https://sam.nrel.gov. - [3] W. De Soto et al., "Improvement and validation of a model for - photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, - 2006. + .. [3] W. De Soto et al., "Improvement and validation of a model for + photovoltaic array performance", Solar Energy, vol 80, pp. 78-88, + 2006. See Also -------- @@ -1306,8 +1306,8 @@ def calcparams_pvsyst(effective_irradiance, temp_cell, ''' Calculates five parameter values for the single diode equation at effective irradiance and cell temperature using the PVsyst v6 - model described in [1,2,3]. The five values returned by calcparams_pvsyst - can be used by singlediode to calculate an IV curve. + model described in [1]_, [2]_, [3]_. The five values returned by + calcparams_pvsyst can be used by singlediode to calculate an IV curve. Parameters ---------- @@ -1384,16 +1384,16 @@ def calcparams_pvsyst(effective_irradiance, temp_cell, References ---------- - [1] K. Sauer, T. Roessler, C. W. Hansen, Modeling the Irradiance and - Temperature Dependence of Photovoltaic Modules in PVsyst, - IEEE Journal of Photovoltaics v5(1), January 2015. + .. [1] K. Sauer, T. Roessler, C. W. Hansen, Modeling the Irradiance and + Temperature Dependence of Photovoltaic Modules in PVsyst, + IEEE Journal of Photovoltaics v5(1), January 2015. - [2] A. Mermoud, PV modules modelling, Presentation at the 2nd PV - Performance Modeling Workshop, Santa Clara, CA, May 2013 + .. [2] A. Mermoud, PV modules modelling, Presentation at the 2nd PV + Performance Modeling Workshop, Santa Clara, CA, May 2013 - [3] A. Mermoud, T. Lejeune, Performance Assessment of a Simulation Model - for PV modules of any available technology, 25th European Photovoltaic - Solar Energy Conference, Valencia, Spain, Sept. 2010 + .. [3] A. Mermoud, T. Lejeune, Performance Assessment of a Simulation Model + for PV modules of any available technology, 25th European Photovoltaic + Solar Energy Conference, Valencia, Spain, Sept. 2010 See Also -------- @@ -1661,9 +1661,9 @@ def sapm(effective_irradiance, temp_cell, module): References ---------- - [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance - Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, - NM. + .. [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance + Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, + NM. See Also -------- @@ -1895,9 +1895,9 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi, Notes ----- - The SAPM model for effective irradiance [1] translates broadband direct and - diffuse irradiance on the plane of array to the irradiance absorbed by a - module's cells. + The SAPM model for effective irradiance [1]_ translates broadband direct + and diffuse irradiance on the plane of array to the irradiance absorbed by + a module's cells. The model is .. math:: @@ -1913,8 +1913,8 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi, References ---------- - [1] D. King et al, "Sandia Photovoltaic Array Performance Model", - SAND2004-3535, Sandia National Laboratories, Albuquerque, NM + .. [1] D. King et al, "Sandia Photovoltaic Array Performance Model", + SAND2004-3535, Sandia National Laboratories, Albuquerque, NM See also -------- @@ -1937,7 +1937,7 @@ def singlediode(photocurrent, saturation_current, resistance_series, """ Solve the single-diode model to obtain a photovoltaic IV curve. - Singlediode solves the single diode equation [1] + Singlediode solves the single diode equation [1]_ .. math:: @@ -1946,7 +1946,7 @@ def singlediode(photocurrent, saturation_current, resistance_series, for ``I`` and ``V`` when given ``IL, I0, Rs, Rsh,`` and ``nNsVth (nNsVth = n*Ns*Vth)`` which are described later. Returns a DataFrame which contains the 5 points on the I-V curve specified in - SAND2004-3535 [3]. If all IL, I0, Rs, Rsh, and nNsVth are scalar, a + SAND2004-3535 [3]_. If all IL, I0, Rs, Rsh, and nNsVth are scalar, a single curve will be returned, if any are Series (of the same length), multiple IV curves will be calculated. @@ -2023,7 +2023,7 @@ def singlediode(photocurrent, saturation_current, resistance_series, ----- If the method is ``'lambertw'`` then the solution employed to solve the implicit diode equation utilizes the Lambert W function to obtain an - explicit function of :math:`V=f(I)` and :math:`I=f(V)` as shown in [2]. + explicit function of :math:`V=f(I)` and :math:`I=f(V)` as shown in [2]_. If the method is ``'newton'`` then the root-finding Newton-Raphson method is used. It should be safe for well behaved IV-curves, but the ``'brentq'`` @@ -2034,7 +2034,7 @@ def singlediode(photocurrent, saturation_current, resistance_series, open-circuit. If the method is either ``'newton'`` or ``'brentq'`` and ``ivcurve_pnts`` - are indicated, then :func:`pvlib.singlediode.bishop88` [4] is used to + are indicated, then :func:`pvlib.singlediode.bishop88` [4]_ is used to calculate the points on the IV curve points at diode voltages from zero to open-circuit voltage with a log spacing that gets closer as voltage increases. If the method is ``'lambertw'`` then the calculated points on @@ -2042,19 +2042,19 @@ def singlediode(photocurrent, saturation_current, resistance_series, References ---------- - [1] S.R. Wenham, M.A. Green, M.E. Watt, "Applied Photovoltaics" ISBN - 0 86758 909 4 + .. [1] S.R. Wenham, M.A. Green, M.E. Watt, "Applied Photovoltaics" ISBN + 0 86758 909 4 - [2] A. Jain, A. Kapoor, "Exact analytical solutions of the - parameters of real solar cells using Lambert W-function", Solar - Energy Materials and Solar Cells, 81 (2004) 269-277. + .. [2] A. Jain, A. Kapoor, "Exact analytical solutions of the + parameters of real solar cells using Lambert W-function", Solar + Energy Materials and Solar Cells, 81 (2004) 269-277. - [3] D. King et al, "Sandia Photovoltaic Array Performance Model", - SAND2004-3535, Sandia National Laboratories, Albuquerque, NM + .. [3] D. King et al, "Sandia Photovoltaic Array Performance Model", + SAND2004-3535, Sandia National Laboratories, Albuquerque, NM - [4] "Computer simulation of the effects of electrical mismatches in - photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988) - https://doi.org/10.1016/0379-6787(88)90059-2 + .. [4] "Computer simulation of the effects of electrical mismatches in + photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988) + https://doi.org/10.1016/0379-6787(88)90059-2 See also -------- @@ -2190,14 +2190,14 @@ def v_from_i(resistance_shunt, resistance_series, nNsVth, current, Device voltage at the given device current for the single diode model. Uses the single diode model (SDM) as described in, e.g., - Jain and Kapoor 2004 [1]. - The solution is per Eq 3 of [1] except when resistance_shunt=numpy.inf, - in which case the explict solution for voltage is used. + Jain and Kapoor 2004 [1]_. + The solution is per Eq 3 of [1]_ except when resistance_shunt=numpy.inf, + in which case the explict solution for voltage is used. Ideal device parameters are specified by resistance_shunt=np.inf and - resistance_series=0. + resistance_series=0. Inputs to this function can include scalars and pandas.Series, but it is - the caller's responsibility to ensure that the arguments are all float64 - and within the proper ranges. + the caller's responsibility to ensure that the arguments are all float64 + and within the proper ranges. Parameters ---------- @@ -2244,9 +2244,9 @@ def v_from_i(resistance_shunt, resistance_series, nNsVth, current, References ---------- - [1] A. Jain, A. Kapoor, "Exact analytical solutions of the - parameters of real solar cells using Lambert W-function", Solar - Energy Materials and Solar Cells, 81 (2004) 269-277. + .. [1] A. Jain, A. Kapoor, "Exact analytical solutions of the + parameters of real solar cells using Lambert W-function", Solar + Energy Materials and Solar Cells, 81 (2004) 269-277. ''' if method.lower() == 'lambertw': return _singlediode._lambertw_v_from_i( @@ -2278,7 +2278,7 @@ def i_from_v(resistance_shunt, resistance_series, nNsVth, voltage, Device current at the given device voltage for the single diode model. Uses the single diode model (SDM) as described in, e.g., - Jain and Kapoor 2004 [1]. + Jain and Kapoor 2004 [1]_. The solution is per Eq 2 of [1] except when resistance_series=0, in which case the explict solution for current is used. Ideal device parameters are specified by resistance_shunt=np.inf and @@ -2332,9 +2332,9 @@ def i_from_v(resistance_shunt, resistance_series, nNsVth, voltage, References ---------- - [1] A. Jain, A. Kapoor, "Exact analytical solutions of the - parameters of real solar cells using Lambert W-function", Solar - Energy Materials and Solar Cells, 81 (2004) 269-277. + .. [1] A. Jain, A. Kapoor, "Exact analytical solutions of the + parameters of real solar cells using Lambert W-function", Solar + Energy Materials and Solar Cells, 81 (2004) 269-277. ''' if method.lower() == 'lambertw': return _singlediode._lambertw_i_from_v( @@ -2386,9 +2386,9 @@ def snlinverter(v_dc, p_dc, inverter): inverter : dict-like A dict-like object defining the inverter to be used, giving the inverter performance parameters according to the Sandia - Grid-Connected Photovoltaic Inverter Model (SAND 2007-5036) [1]. + Grid-Connected Photovoltaic Inverter Model (SAND 2007-5036) [1]_. A set of inverter performance parameters are provided with - pvlib, or may be generated from a System Advisor Model (SAM) [2] + pvlib, or may be generated from a System Advisor Model (SAM) [2]_ library using retrievesam. See Notes for required keys. Returns @@ -2436,11 +2436,11 @@ def snlinverter(v_dc, p_dc, inverter): References ---------- - [1] SAND2007-5036, "Performance Model for Grid-Connected - Photovoltaic Inverters by D. King, S. Gonzalez, G. Galbraith, W. - Boyson + .. [1] SAND2007-5036, "Performance Model for Grid-Connected + Photovoltaic Inverters by D. King, S. Gonzalez, G. Galbraith, W. + Boyson - [2] System Advisor Model web page. https://sam.nrel.gov. + .. [2] System Advisor Model web page. https://sam.nrel.gov. See also -------- @@ -2543,8 +2543,8 @@ def adrinverter(v_dc, p_dc, inverter, vtol=0.10): References ---------- - [1] Beyond the Curves: Modeling the Electrical Efficiency - of Photovoltaic Inverters, PVSC 2008, Anton Driesse et. al. + .. [1] Beyond the Curves: Modeling the Electrical Efficiency + of Photovoltaic Inverters, PVSC 2008, Anton Driesse et. al. See also -------- diff --git a/pvlib/singlediode.py b/pvlib/singlediode.py index d466c778ce..d51de5158a 100644 --- a/pvlib/singlediode.py +++ b/pvlib/singlediode.py @@ -61,7 +61,7 @@ def estimate_voc(photocurrent, saturation_current, nNsVth): V_{oc, est}=n Ns V_{th} \\log \\left( \\frac{I_L}{I_0} + 1 \\right) - [1] http://www.pveducation.org/pvcdrom/open-circuit-voltage + .. [1] http://www.pveducation.org/pvcdrom/open-circuit-voltage """ return nNsVth * np.log(np.asarray(photocurrent) / saturation_current + 1.0) diff --git a/pvlib/solarposition.py b/pvlib/solarposition.py index 7a51fc6cc9..64e46d8e50 100644 --- a/pvlib/solarposition.py +++ b/pvlib/solarposition.py @@ -73,13 +73,14 @@ def get_solarposition(time, latitude, longitude, References ---------- - [1] I. Reda and A. Andreas, Solar position algorithm for solar radiation - applications. Solar Energy, vol. 76, no. 5, pp. 577-589, 2004. + .. [1] I. Reda and A. Andreas, Solar position algorithm for solar radiation + applications. Solar Energy, vol. 76, no. 5, pp. 577-589, 2004. - [2] I. Reda and A. Andreas, Corrigendum to Solar position algorithm for - solar radiation applications. Solar Energy, vol. 81, no. 6, p. 838, 2007. + .. [2] I. Reda and A. Andreas, Corrigendum to Solar position algorithm for + solar radiation applications. Solar Energy, vol. 81, no. 6, p. 838, + 2007. - [3] NREL SPA code: http://rredc.nrel.gov/solar/codesandalgorithms/spa/ + .. [3] NREL SPA code: http://rredc.nrel.gov/solar/codesandalgorithms/spa/ """ if altitude is None and pressure is None: @@ -163,16 +164,17 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0, References ---------- - NREL SPA reference: http://rredc.nrel.gov/solar/codesandalgorithms/spa/ - NREL SPA C files: https://midcdmz.nrel.gov/spa/ + .. [1] NREL SPA reference: + http://rredc.nrel.gov/solar/codesandalgorithms/spa/ + NREL SPA C files: https://midcdmz.nrel.gov/spa/ Note: The ``timezone`` field in the SPA C files is replaced with ``time_zone`` to avoid a nameclash with the function ``__timezone`` that is redefined by Python>=3.5. This issue is `Python bug 24643 `_. - USNO delta T: - http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term + .. [2] USNO delta T: + http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term See also -------- @@ -314,14 +316,15 @@ def spa_python(time, latitude, longitude, References ---------- - [1] I. Reda and A. Andreas, Solar position algorithm for solar - radiation applications. Solar Energy, vol. 76, no. 5, pp. 577-589, 2004. + .. [1] I. Reda and A. Andreas, Solar position algorithm for solar + radiation applications. Solar Energy, vol. 76, no. 5, pp. 577-589, 2004. - [2] I. Reda and A. Andreas, Corrigendum to Solar position algorithm for - solar radiation applications. Solar Energy, vol. 81, no. 6, p. 838, 2007. + .. [2] I. Reda and A. Andreas, Corrigendum to Solar position algorithm for + solar radiation applications. Solar Energy, vol. 81, no. 6, p. 838, + 2007. - [3] USNO delta T: - http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term + .. [3] USNO delta T: + http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term See also -------- @@ -404,9 +407,9 @@ def sun_rise_set_transit_spa(times, latitude, longitude, how='numpy', References ---------- - [1] Reda, I., Andreas, A., 2003. Solar position algorithm for solar - radiation applications. Technical report: NREL/TP-560- 34302. Golden, - USA, http://www.nrel.gov. + .. [1] Reda, I., Andreas, A., 2003. Solar position algorithm for solar + radiation applications. Technical report: NREL/TP-560- 34302. Golden, + USA, http://www.nrel.gov. """ # Added by Tony Lorenzo (@alorenzo175), University of Arizona, 2015 @@ -690,8 +693,8 @@ def ephemeris(time, latitude, longitude, pressure=101325, temperature=12): References ----------- - Grover Hughes' class and related class materials on Engineering - Astronomy at Sandia National Laboratories, 1985. + .. [1] Grover Hughes' class and related class materials on Engineering + Astronomy at Sandia National Laboratories, 1985. See also -------- @@ -1044,10 +1047,10 @@ def equation_of_time_spencer71(dayofyear): .. [3] Frank Vignola et al., "Solar And Infrared Radiation Measurements", p. 13, CRC Press (2012) - .. [5] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable + .. [4] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable Energy Applications", p. 5 CRC Press (2013) - .. [4] Roland Hulstrom, "Solar Resources" p. 66, MIT Press (1989) + .. [5] Roland Hulstrom, "Solar Resources" p. 66, MIT Press (1989) See Also -------- @@ -1083,8 +1086,8 @@ def equation_of_time_pvcdrom(dayofyear): References ---------- - [1] Soteris A. Kalogirou, "Solar Energy Engineering Processes and - Systems, 2nd Edition" Elselvier/Academic Press (2009). + .. [1] Soteris A. Kalogirou, "Solar Energy Engineering Processes and + Systems, 2nd Edition" Elselvier/Academic Press (2009). See Also -------- @@ -1117,14 +1120,14 @@ def declination_spencer71(dayofyear): References ---------- - [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal - Processes, 3rd Edition" pp. 13-14, J. Wiley and Sons, New York (2006) + .. [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal + Processes, 3rd Edition" pp. 13-14, J. Wiley and Sons, New York (2006) - [2] J. W. Spencer, "Fourier series representation of the position of the - sun" in Search 2 (5), p. 172 (1971) + .. [2] J. W. Spencer, "Fourier series representation of the position of the + sun" in Search 2 (5), p. 172 (1971) - [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable - Energy Applications", p. 4 CRC Press (2013) + .. [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable + Energy Applications", p. 4 CRC Press (2013) See Also -------- @@ -1166,14 +1169,14 @@ def declination_cooper69(dayofyear): References ---------- - [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal - Processes, 3rd Edition" pp. 13-14, J. Wiley and Sons, New York (2006) + .. [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal + Processes, 3rd Edition" pp. 13-14, J. Wiley and Sons, New York (2006) - [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and Physics" - p. 129, J. Wiley (1998) + .. [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and Physics" + p. 129, J. Wiley (1998) - [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable - Energy Applications", p. 4 CRC Press (2013) + .. [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable + Energy Applications", p. 4 CRC Press (2013) See Also -------- @@ -1207,17 +1210,17 @@ def solar_azimuth_analytical(latitude, hourangle, declination, zenith): References ---------- - [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal - Processes, 3rd Edition" pp. 14, J. Wiley and Sons, New York (2006) + .. [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal + Processes, 3rd Edition" pp. 14, J. Wiley and Sons, New York (2006) - [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and Physics" - p. 132, J. Wiley (1998) + .. [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and Physics" + p. 132, J. Wiley (1998) - [3] `Wikipedia: Solar Azimuth Angle - `_ + .. [3] `Wikipedia: Solar Azimuth Angle + `_ - [4] `PVCDROM: Azimuth Angle `_ + .. [4] `PVCDROM: Azimuth Angle `_ See Also -------- @@ -1278,20 +1281,21 @@ def solar_zenith_analytical(latitude, hourangle, declination): References ---------- - [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal - Processes, 3rd Edition" pp. 14, J. Wiley and Sons, New York (2006) + .. [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal + Processes, 3rd Edition" pp. 14, J. Wiley and Sons, New York (2006) - [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and - Physics" p. 132, J. Wiley (1998) + .. [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and + Physics" p. 132, J. Wiley (1998) - [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for - Renewable Energy Applications", p. 5 CRC Press (2013) + .. [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for + Renewable Energy Applications", p. 5 CRC Press (2013) - `Wikipedia: Solar Zenith Angle - `_ + .. [4] `Wikipedia: Solar Zenith Angle + `_ - `PVCDROM: Sun's Position - `_ + .. [5] `PVCDROM: Sun's Position + `_ See Also -------- @@ -1326,14 +1330,14 @@ def hour_angle(times, longitude, equation_of_time): References ---------- - [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal - Processes, 3rd Edition" pp. 13, J. Wiley and Sons, New York (2006) + .. [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal + Processes, 3rd Edition" pp. 13, J. Wiley and Sons, New York (2006) - [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and Physics" - p. 132, J. Wiley (1998) + .. [2] J. H. Seinfeld and S. N. Pandis, "Atmospheric Chemistry and Physics" + p. 132, J. Wiley (1998) - [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable - Energy Applications", p. 5 CRC Press (2013) + .. [3] Daryl R. Myers, "Solar Radiation: Practical Modeling for Renewable + Energy Applications", p. 5 CRC Press (2013) See Also -------- @@ -1416,11 +1420,11 @@ def sun_rise_set_transit_geometric(times, latitude, longitude, declination, References ---------- - [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal - Processes, 3rd Edition," J. Wiley and Sons, New York (2006) + .. [1] J. A. Duffie and W. A. Beckman, "Solar Engineering of Thermal + Processes, 3rd Edition," J. Wiley and Sons, New York (2006) - [2] Frank Vignola et al., "Solar And Infrared Radiation Measurements," - CRC Press (2012) + .. [2] Frank Vignola et al., "Solar And Infrared Radiation Measurements," + CRC Press (2012) """ latitude_rad = np.radians(latitude) # radians diff --git a/pvlib/temperature.py b/pvlib/temperature.py index 326c67726a..fed5cdca89 100644 --- a/pvlib/temperature.py +++ b/pvlib/temperature.py @@ -33,7 +33,7 @@ def _temperature_model_params(model, parameter_set): def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT, irrad_ref=1000): r''' - Calculate cell temperature per the Sandia PV Array Performance Model [1]. + Calculate cell temperature per the Sandia PV Array Performance Model [1]_. Parameters ---------- @@ -66,7 +66,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT, Notes ----- The model for cell temperature :math:`T_{C}` is given by a pair of - equations (Eq. 11 and 12 in [1]). + equations (Eq. 11 and 12 in [1]_). .. math:: :label: sapm1 @@ -84,7 +84,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT, Inputs to the model are plane-of-array irradiance :math:`E` (W/m2) and ambient air temperature :math:`T_{a}` (C). Model parameters depend both on the module construction and its mounting. Parameter sets are provided in - [1] for representative modules and mounting, and are coded for convenience + [1]_ for representative modules and mounting, and are coded for convenience in ``pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS``. +---------------+----------------+-------+---------+---------------------+ @@ -101,9 +101,9 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT, References ---------- - [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance - Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, - NM. + .. [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance + Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, + NM. Examples -------- @@ -120,7 +120,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT, def sapm_module(poa_global, temp_air, wind_speed, a, b): r''' Calculate module back surface temperature per the Sandia PV Array - Performance Model [1]. + Performance Model [1]_. Parameters ---------- @@ -145,7 +145,7 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b): Notes ----- - The model for module temperature :math:`T_{m}` is given by Eq. 11 in [1]. + The model for module temperature :math:`T_{m}` is given by Eq. 11 in [1]_. .. math:: :label: sapm1mod @@ -156,8 +156,8 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b): ambient air temperature :math:`T_{a}` (C). Model outputs are surface temperature at the back of the module :math:`T_{m}` and cell temperature :math:`T_{C}`. Model parameters depend both on the module construction and - its mounting. Parameter sets are provided in [1] for representative modules - and mounting, and are coded for convenience in + its mounting. Parameter sets are provided in [1]_ for representative + modules and mounting, and are coded for convenience in ``temperature.TEMPERATURE_MODEL_PARAMETERS``. +---------------+----------------+-------+---------+---------------------+ @@ -174,9 +174,9 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b): References ---------- - [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance - Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, - NM. + .. [1] King, D. et al, 2004, "Sandia Photovoltaic Array Performance + Model", SAND Report 3535, Sandia National Laboratories, Albuquerque, + NM. ''' return poa_global * np.exp(a + b * wind_speed) + temp_air @@ -235,7 +235,7 @@ def pvsyst_cell(poa_global, temp_air, wind_speed=1.0, u_c=29.0, u_v=0.0, air temperature :math:`T_{a}` (C) and wind speed :math:`WS` (m/s). Model output is cell temperature :math:`T_{C}`. Model parameters depend both on the module construction and its mounting. Parameters are provided in - [1] for open (freestanding) and close (insulated) mounting configurations, + [1]_ for open (freestanding) and close (insulated) mounting configurations, , and are coded for convenience in ``temperature.TEMPERATURE_MODEL_PARAMETERS``. The heat loss factors provided represent the combined effect of convection, radiation and @@ -251,11 +251,11 @@ def pvsyst_cell(poa_global, temp_air, wind_speed=1.0, u_c=29.0, u_v=0.0, References ---------- - [1]"PVsyst 6 Help", Files.pvsyst.com, 2018. [Online]. Available: - http://files.pvsyst.com/help/index.html. [Accessed: 10- Dec- 2018]. + .. [1] "PVsyst 6 Help", Files.pvsyst.com, 2018. [Online]. Available: + http://files.pvsyst.com/help/index.html. [Accessed: 10- Dec- 2018]. - [2] Faiman, D. (2008). "Assessing the outdoor operating temperature of - photovoltaic modules." Progress in Photovoltaics 16(4): 307-315. + .. [2] Faiman, D. (2008). "Assessing the outdoor operating temperature of + photovoltaic modules." Progress in Photovoltaics 16(4): 307-315. Examples -------- diff --git a/pvlib/tracking.py b/pvlib/tracking.py index 40160cada8..c35bf85206 100644 --- a/pvlib/tracking.py +++ b/pvlib/tracking.py @@ -250,7 +250,7 @@ def singleaxis(apparent_zenith, apparent_azimuth, backtrack=True, gcr=2.0/7.0): """ Determine the rotation angle of a single axis tracker using the - equations in [1] when given a particular sun zenith and azimuth + equations in [1]_ when given a particular sun zenith and azimuth angle. backtracking may be specified, and if so, a ground coverage ratio is required. @@ -305,22 +305,21 @@ def singleaxis(apparent_zenith, apparent_azimuth, Returns ------- dict or DataFrame with the following columns: - - * tracker_theta: The rotation angle of the tracker. - tracker_theta = 0 is horizontal, and positive rotation angles are - clockwise. - * aoi: The angle-of-incidence of direct irradiance onto the - rotated panel surface. - * surface_tilt: The angle between the panel surface and the earth - surface, accounting for panel rotation. - * surface_azimuth: The azimuth of the rotated panel, determined by - projecting the vector normal to the panel's surface to the earth's - surface. + * `tracker_theta`: The rotation angle of the tracker. + tracker_theta = 0 is horizontal, and positive rotation angles are + clockwise. + * `aoi`: The angle-of-incidence of direct irradiance onto the + rotated panel surface. + * `surface_tilt`: The angle between the panel surface and the earth + surface, accounting for panel rotation. + * `surface_azimuth`: The azimuth of the rotated panel, determined by + projecting the vector normal to the panel's surface to the earth's + surface. References ---------- - [1] Lorenzo, E et al., 2011, "Tracking and back-tracking", Prog. in - Photovoltaics: Research and Applications, v. 19, pp. 747-753. + .. [1] Lorenzo, E et al., 2011, "Tracking and back-tracking", Prog. in + Photovoltaics: Research and Applications, v. 19, pp. 747-753. """ # MATLAB to Python conversion by diff --git a/setup.py b/setup.py index ca18970d82..35543bf7e0 100755 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ EXTRAS_REQUIRE = { 'optional': ['ephem', 'cython', 'netcdf4', 'nrel-pysam', 'numba', 'pvfactors', 'scipy', 'siphon', 'tables'], - 'doc': ['ipython', 'matplotlib', 'sphinx', 'sphinx_rtd_theme'], + 'doc': ['ipython', 'matplotlib', 'sphinx == 1.8.5', 'sphinx_rtd_theme'], 'test': TESTS_REQUIRE } EXTRAS_REQUIRE['all'] = sorted(set(sum(EXTRAS_REQUIRE.values(), [])))