Skip to content

Add logos and clarify some docstrings #688

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 11, 2019
Merged

Add logos and clarify some docstrings #688

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
66d8e3b
typos in irradiance.poa_components
cwhanse Mar 19, 2019
887d6b4
add logos, edit README.md
cwhanse Apr 10, 2019
ae4e917
more docstring edits
cwhanse Apr 10, 2019
ea00e4b
add logo, edit pvlib-python and PVLIB Python
cwhanse Apr 10, 2019
fcfebe6
add !
cwhanse Apr 10, 2019
c28654a
image sizing
cwhanse Apr 10, 2019
1254b38
adjust images
cwhanse Apr 10, 2019
46bd450
fix typo in branch typos
cwhanse Apr 10, 2019
3583480
remove underscore line
cwhanse Apr 10, 2019
6c6dec4
add size to index.rst
cwhanse Apr 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pvlib-python
[pvlib-python](docs/sphinx/source/_images/pvlib_logo_horiz.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add preceding exclamation mark for image to render, see GitHub Markdown guide

![pvlib-python](docs/sphinx/source/_images/pvlib_logo_horiz.png)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Do you know how to specify a display size?

I can make a pre-release tag that will build on readthedocs. Otherwise I don't know how to view the change to index.rst

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can go into your readthedocs account and set up a new project that points to your fork. cwhanse-pvlib-python or something like that. Then you have to go into your new project's settings and turn on the build for your branch.

Alternatively, I can test locally if we're ready for that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set up a readthedocs for my fork, that is the long-term solution.

Copy link
Member Author

@cwhanse cwhanse Apr 10, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The index.rst file renders in the viewer here.

Ready for review.

============

[![TravisCI](https://travis-ci.org/pvlib/pvlib-python.svg?branch=master)](https://travis-ci.org/pvlib/pvlib-python)
Expand All @@ -13,9 +13,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
Expand Down
Binary file added docs/sphinx/source/_images/pvlib_logo_horiz.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sphinx/source/_images/pvlib_logo_vert.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions docs/sphinx/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
pvlib-python
.. image:: _images/pvlib_log_horiz.png
========================================

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
<https://github.com/pvlib/pvlib-python>`_.

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
<http://nbviewer.ipython.org/github/pvlib/pvlib-python/tree/master/docs/
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
<https://github.com/pvlib/pvlib-python/wiki/Projects-and-publications-
that-use-pvlib-python>`_ page for inspiration and listing of your
Expand All @@ -31,23 +31,23 @@ application.
There is a :ref:`variable naming convention <variables_style_rules>` 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."
Journal of Open Source Software, 3(29), 884, (2018).
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 <https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version>`_

Additional pvlib-python publications include:
Additional pvlib python publications include:

* J. S. Stein, “The photovoltaic performance modeling
collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.
Expand Down
10 changes: 4 additions & 6 deletions pvlib/clearsky.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
----------
Expand Down
7 changes: 3 additions & 4 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down