8000 Add logos and clarify some docstrings (#688) · FranziPl/pvlib-python@b61e149 · GitHub
[go: up one dir, main page]
Skip to content

Commit b61e149

Browse files
cwhansewholmgren
cwhanse
authored and
wholmgren
committed
Add logos and clarify some docstrings (pvlib#688)
* typos in irradiance.poa_components * add logos, edit README.md * more docstring edits * add logo, edit pvlib-python and PVLIB Python * add ! * image sizing * adjust images * fix typo in branch typos * remove underscore line * add size to index.rst
1 parent 0e9d25c commit b61e149

File tree

6 files changed

+22
-24
lines changed

6 files changed

+22
-24
lines changed

‎README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
pvlib-python
2-
============
1+
<img src="docs/sphinx/source/_images/pvlib_logo_horiz.png" width="600" height="260">
32

43
[![TravisCI](https://travis-ci.org/pvlib/pvlib-python.svg?branch=master)](https://travis-ci.org/pvlib/pvlib-python)
54
[![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
1312
[![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)
1413

1514

16-
PVLIB Python is a community supported tool that provides a set of
15+
pvlib python is a community supported tool that provides a set of
1716
functions and classes for simulating the performance of photovoltaic
18-
energy systems. PVLIB Python was originally ported from the PVLIB MATLAB
17+
energy systems. pvlib python was originally ported from the PVLIB MATLAB
1918
toolbox developed at Sandia National Laboratories and it implements many
2019
of the models and methods developed at the Labs. More information on
2120
Sandia Labs PV performance modeling programs can be found at

‎docs/sphinx/source/_images/pvlib_logo_horiz.png

81.8 KB
Loading

‎docs/sphinx/source/_images/pvlib_logo_vert.png

111 KB
Loading

‎docs/sphinx/source/index.rst

Lines changed: 12 additions & 10 deletions
8000
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
1-
pvlib-python
1+
.. image:: _images/pvlib_logo_horiz.png
2+
:width: 600
3+
24
========================================
35

4-
PVLIB Python is a community supported tool that provides a set of
6+
pvlib python is a community supported tool that provides a set of
57
functions and classes for simulating the performance of photovoltaic
6-
energy systems. PVLIB Python was originally ported from the PVLIB MATLAB
8+
energy systems. pvlib python was originally ported from the PVLIB MATLAB
79
toolbox developed at Sandia National Laboratories and it implements many
810
of the models and methods developed at the Labs. More information on
911
Sandia Labs PV performance modeling programs can be found at
1012
https://pvpmc.sandia.gov/. We collaborate with the PVLIB MATLAB project,
1113
but operate independently of it.
1214

13-
The source code for pvlib-python is hosted on `github
15+
The source code for pvlib python is hosted on `github
1416
<https://github.com/pvlib/pvlib-python>`_.
1517

1618
Please see the :ref:`installation` page for installation help.
1719

18-
For examples of how to use pvlib-python, please see
20+
For examples of how to use pvlib python, please see
1921
:ref:`package_overview` and our `Jupyter Notebook tutorials
2022
<http://nbviewer.ipython.org/github/pvlib/pvlib-python/tree/master/docs/
2123
tutorials/>`_. The documentation assumes general familiarity with
2224
Python, NumPy, and Pandas. Google searches will yield many
2325
excellent tutorials for these packages.
2426

25-
The pvlib-python GitHub wiki has a `Projects and publications that use
27+
The pvlib python GitHub wiki has a `Projects and publications that use
2628
pvlib python
2729
<https://github.com/pvlib/pvlib-python/wiki/Projects-and-publications-
2830
that-use-pvlib-python>`_ page for inspiration and listing of your
@@ -31,23 +33,23 @@ application.
3133
There is a :ref:`variable naming convention <variables_style_rules>` to
3234
ensure consistency throughout the library.
3335

34-
Citing pvlib-python
36+
Citing pvlib python
3537
===================
3638

3739
Many of the contributors to pvlib-python work in institutions where
3840
citation metrics are used in performance or career evaluations. If you
39-
use pvlib-python in a published work, please cite:
41+
use pvlib python in a published work, please cite:
4042

4143
William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
4244
"pvlib python: a python package for modeling solar energy systems."
4345
Journal of Open Source Software, 3(29), 884, (2018).
4446
https://doi.org/10.21105/joss.00884
4547

4648
Please also cite the DOI corresponding to the specific version of
47-
pvlib-python that you used. pvlib-python DOIs are listed at
49+
pvlib python that you used. pvlib python DOIs are listed at
4850
`Zenodo.org <https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version>`_
4951

50-
Additional pvlib-python publications include:
52+
Additional pvlib python publications include:
5153

5254
* J. S. Stein, “The photovoltaic performance modeling
5355
collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.

‎pvlib/clearsky.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ def _linearly_scale(inputmatrix, inputmin, inputmax, outputmin, outputmax):
327327

328328
def haurwitz(apparent_zenith):
329329
'''
330-
Determine clear sky GHI from Haurwitz model.
330+
Determine clear sky GHI using the Haurwitz model.
331331
332332
Implements the Haurwitz clear sky model for global horizontal
333333
irradiance (GHI) as presented in [1, 2]. A report on clear
@@ -343,11 +343,9 @@ def haurwitz(apparent_zenith):
343343
344344
Returns
345345
-------
346-
pd.DataFrame
347-
The modeled global horizonal irradiance in W/m^2 provided
348-
by the Haurwitz clear-sky model.
349-
350-
Initial implementation of this algorithm by Matthew Reno.
346+
ghi : DataFrame
347+
The modeled global horizonal irradiance in W/m^2 provided
348+
by the Haurwitz clear-sky model.
351349
352350
References
353351
----------

‎pvlib/irradiance.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,11 +447,10 @@ def get_sky_diffuse(surface_tilt, surface_azimuth,
447447

448448
def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse):
449449
r'''
450-
Determine the three components on in-plane irradiance
450+
Determine in-plane irradiance components.
451451
452-
Combines in-plane irradaince compoents from the chosen diffuse
453-
translation, ground reflection and beam irradiance algorithms into
454-
the total in-plane irradiance.
452+
Combines DNI with sky diffuse and ground-reflected irradiance to calculate
453+
total, direct and diffuse irradiance components in the plane of array.
455454
456455
Parameters
457456
----------

0 commit comments

Comments
 (0)
0