diff --git a/README.md b/README.md index 199dead1ad..112731bb56 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -pvlib-python -============ + [![TravisCI](https://travis-ci.org/pvlib/pvlib-python.svg?branch=master)](https://travis-ci.org/pvlib/pvlib-python) [![Build status](https://ci.appveyor.com/api/projects/status/gr2eyhc84tvtkopk?svg=true)](https://ci.appveyor.com/project/wholmgren/pvlib-python-fv2to) @@ -13,9 +12,9 @@ pvlib-python [![Total Alerts](https://img.shields.io/lgtm/alerts/g/pvlib/pvlib-python.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pvlib/pvlib-python/alerts) -PVLIB Python is a community supported tool that provides a set of +pvlib python is a community supported tool that provides a set of functions and classes for simulating the performance of photovoltaic -energy systems. PVLIB Python was originally ported from the PVLIB MATLAB +energy systems. pvlib python was originally ported from the PVLIB MATLAB toolbox developed at Sandia National Laboratories and it implements many of the models and methods developed at the Labs. More information on Sandia Labs PV performance modeling programs can be found at diff --git a/docs/sphinx/source/_images/pvlib_logo_horiz.png b/docs/sphinx/source/_images/pvlib_logo_horiz.png new file mode 100644 index 0000000000..9f104871e0 Binary files /dev/null and b/docs/sphinx/source/_images/pvlib_logo_horiz.png differ diff --git a/docs/sphinx/source/_images/pvlib_logo_vert.png b/docs/sphinx/source/_images/pvlib_logo_vert.png new file mode 100644 index 0000000000..60ca0f2f2c Binary files /dev/null and b/docs/sphinx/source/_images/pvlib_logo_vert.png differ diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index c9a65c2f0c..eea01dd9df 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -1,28 +1,30 @@ -pvlib-python +.. image:: _images/pvlib_logo_horiz.png + :width: 600 + ======================================== -PVLIB Python is a community supported tool that provides a set of +pvlib python is a community supported tool that provides a set of functions and classes for simulating the performance of photovoltaic -energy systems. PVLIB Python was originally ported from the PVLIB MATLAB +energy systems. pvlib python was originally ported from the PVLIB MATLAB toolbox developed at Sandia National Laboratories and it implements many of the models and methods developed at the Labs. More information on Sandia Labs PV performance modeling programs can be found at https://pvpmc.sandia.gov/. We collaborate with the PVLIB MATLAB project, but operate independently of it. -The source code for pvlib-python is hosted on `github +The source code for pvlib python is hosted on `github `_. Please see the :ref:`installation` page for installation help. -For examples of how to use pvlib-python, please see +For examples of how to use pvlib python, please see :ref:`package_overview` and our `Jupyter Notebook tutorials `_. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages. -The pvlib-python GitHub wiki has a `Projects and publications that use +The pvlib python GitHub wiki has a `Projects and publications that use pvlib python `_ page for inspiration and listing of your @@ -31,12 +33,12 @@ application. There is a :ref:`variable naming convention ` to ensure consistency throughout the library. -Citing pvlib-python +Citing pvlib python =================== Many of the contributors to pvlib-python work in institutions where citation metrics are used in performance or career evaluations. If you -use pvlib-python in a published work, please cite: +use pvlib python in a published work, please cite: William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski. "pvlib python: a python package for modeling solar energy systems." @@ -44,10 +46,10 @@ use pvlib-python in a published work, please cite: https://doi.org/10.21105/joss.00884 Please also cite the DOI corresponding to the specific version of -pvlib-python that you used. pvlib-python DOIs are listed at +pvlib python that you used. pvlib python DOIs are listed at `Zenodo.org `_ -Additional pvlib-python publications include: +Additional pvlib python publications include: * J. S. Stein, “The photovoltaic performance modeling collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012. diff --git a/pvlib/clearsky.py b/pvlib/clearsky.py index 93f87a38e3..6543244e30 100644 --- a/pvlib/clearsky.py +++ b/pvlib/clearsky.py @@ -327,7 +327,7 @@ def _linearly_scale(inputmatrix, inputmin, inputmax, outputmin, outputmax): def haurwitz(apparent_zenith): ''' - Determine clear sky GHI from Haurwitz model. + Determine clear sky GHI using the Haurwitz model. Implements the Haurwitz clear sky model for global horizontal irradiance (GHI) as presented in [1, 2]. A report on clear @@ -343,11 +343,9 @@ def haurwitz(apparent_zenith): Returns ------- - pd.DataFrame - The modeled global horizonal irradiance in W/m^2 provided - by the Haurwitz clear-sky model. - - Initial implementation of this algorithm by Matthew Reno. + ghi : DataFrame + The modeled global horizonal irradiance in W/m^2 provided + by the Haurwitz clear-sky model. References ---------- diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index c79ce618a9..798bf69ae3 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -447,11 +447,10 @@ def get_sky_diffuse(surface_tilt, surface_azimuth, def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse): r''' - Determine the three components on in-plane irradiance + Determine in-plane irradiance components. - Combines in-plane irradaince compoents from the chosen diffuse - translation, ground reflection and beam irradiance algorithms into - the total in-plane irradiance. + Combines DNI with sky diffuse and ground-reflected irradiance to calculate + total, direct and diffuse irradiance components in the plane of array. Parameters ----------