8000 add "powered by pvlib" logos (#1277) · RoyCoding8/pvlib-python@cdb0b12 · GitHub
[go: up one dir, main page]

Skip to content

Commit cdb0b12

Browse files
cwhansewholmgren
andauthored
add "powered by pvlib" logos (pvlib#1277)
* add powered logos * change README, whatsnew * add powered by logos, license to docs * blank line * link formatting * move logos to citing. move citing up, license down * one line for less vert space * typo Co-authored-by: Will Holmgren <william.holmgren@gmail.com>
1 parent 238146d commit cdb0b12

File tree

5 files changed

+35
-16
lines changed

5 files changed

+35
-16
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,24 @@ Please see the [Contributing page](http://pvlib-python.readthedocs.io/en/stable/
111111
The long-term success of pvlib-python requires substantial community support.
112112

113113

114-
License
115-
=======
114+
Citing
115+
======
116+
117+
If you use pvlib-python in a published work, please cite:
118+
119+
William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
120+
"pvlib python: a python package for modeling solar energy systems."
121+
Journal of Open Source Software, 3(29), 884, (2018).
122+
https://doi.org/10.21105/joss.00884
116123

117-
BSD 3-clause
124+
Please also cite the DOI corresponding to the specific version of
125+
pvlib-python that you used. pvlib-python DOIs are listed at
126+
[Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version)
118127

128+
If you use pvlib-python in a commercial or publicly-available application, please
129+
consider displaying one of the "powered by pvlib" logos:
130+
131+
<img src="docs/sphinx/source/_images/pvlib_powered_logo_vert.png" width="300"><img src="docs/sphinx/source/_images/pvlib_powered_logo_horiz.png" width="300">
119132

120133
Getting support
121134
===============
@@ -133,19 +146,12 @@ change something about pvlib, then please make an issue on our
133146
[GitHub issues page](https://github.com/pvlib/pvlib-python/issues).
134147

135148

136-
Citing
137-
======
138149

139-
If you use pvlib-python in a published work, please cite:
150+
License
151+
=======
140152

141-
William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
142-
"pvlib python: a python package for modeling solar energy systems."
143-
Journal of Open Source Software, 3(29), 884, (2018).
144-
https://doi.org/10.21105/joss.00884
153+
BSD 3-clause.
145154

146-
Please also cite the DOI corresponding to the specific version of
147-
pvlib-python that you used. pvlib-python DOIs are listed at
148-
[Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version)
149155

150156
NumFOCUS
151157
========
Loading
Loading

docs/sphinx/source/index.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ functions and classes for simulating the performance of photovoltaic
99
energy systems. pvlib python was originally ported from the PVLIB MATLAB
1010
toolbox developed at Sandia National Laboratories and it implements many
1111
of the models and methods developed at the Labs. More information on
12-
Sandia Labs PV performance modeling programs can be found at
13-
https://pvpmc.sandia.gov/. We collaborate with the PVLIB MATLAB project,
12+
Sandia Labs PV performance modeling programs can be found at the `PVPMC <https://pvpmc.sandia.gov/>`_. We collaborate with the PVLIB MATLAB project,
1413
but operate independently of it.
1514

1615
The source code for pvlib python is hosted on `github
@@ -50,6 +49,16 @@ Please also cite the DOI corresponding to the specific version of
5049
pvlib python that you used. pvlib python DOIs are listed at
5150
`Zenodo.org <https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version>`_
5251

52+
If you use pvlib-python in a commercial or publicly-available
53+
application, please consider displaying one of the "powered by pvlib"
54+
logos:
55+
56+
.. image:: _images/pvlib_powered_logo_horiz.png
57+
:width: 300
58+
59+
.. image:: _images/pvlib_powered_logo_vert.png
60+
:width: 300
61+
5362
Additional pvlib python publications include:
5463

5564
* J. S. Stein, “The photovoltaic performance modeling
@@ -73,6 +82,10 @@ Additional pvlib python publications include:
7382
"An Open Source Solar Power Forecasting Tool Using PVLIB-Python,"
7483
in 43rd Photovoltaic Specialists Conference, 2016.
7584

85+
License
86+
=======
87+
88+
`BSD 3-clause <https://github.com/pvlib/pvlib-python/LICENSE>`_.
7689

7790
NumFOCUS
7891
========
@@ -83,7 +96,6 @@ pvlib python is a `NumFOCUS Affiliated Project <https://numfocus.org/sponsored-p
8396
:target: https://numfocus.org/sponsored-projects/affiliated-projects
8497
:alt: NumFocus Affliated Projects
8598

86-
8799
Contents
88100
========
89101

docs/sphinx/source/whatsnew/v0.9.0.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,7 @@ Documentation
226226
* Clarified how statistics are calculated for :py:func:`pvlib.clearsky.detect_clearsky`
227227
(:issue:`1070`, :pull:`1243`)
228228
* Add gallery examples using the new ``Mount`` classes (:pull:`1266`)
229+
* Add "powered by pvlib" logos (:pull:`1277`)
229230

230231
Requirements
231232
~~~~~~~~~~~~

0 commit comments

Comments
 (0)
0