8000 Update citation in pvlib readme (#1939) · NormanJost/pvlib-python@b67a668 · GitHub
[go: up one dir, main page]
Skip to content

Commit b67a668

Browse files
AdamRJensenAdamRJensen
authored
Update citation in pvlib readme (pvlib#1939)
* Update joss badge * Update citations section * Update index.rst * Update readme link to markdown * Update citations in index.rst * Remove clutter at bottom of index.rst page * Implement code review changes * Remove indices/tables and contents header
1 parent 009e913 commit b67a668

File tree

2 files changed

+59
-31
lines changed

2 files changed

+59
-31
lines changed

‎README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@
5050
<a href="https://doi.org/10.5281/zenodo.593284">
5151
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.593284.svg" alt="zenodo reference">
5252
</a>
53-
<a href="http://joss.theoj.org/papers/41187535cad22dd4b076c89b72f874b1">
54-
<img src="http://joss.theoj.org/papers/41187535cad22dd4b076c89b72f874b1/status.svg" alt="JOSS reference" />
53+
<a style="border-width:0" href="https://doi.org/10.21105/joss.05994">
54+
<img src="https://joss.theoj.org/papers/10.21105/joss.05994/status.svg" alt="DOI badge" >
5555
</a>
5656
</td>
5757
</tr>
@@ -88,17 +88,32 @@ The long-term success of pvlib-python requires substantial community support.
8888
Citing
8989
======
9090

91-
If you use pvlib-python in a published work, please cite:
91+
Many of the contributors to pvlib python work in institutions where
92+
citation metrics are used in performance or career evaluations. If you
93+
use pvlib python in a published work, please cite:
9294

93-
William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
95+
**Recommended citation for the pvlib python project**
96+
97+
Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A.
98+
"pvlib python: 2023 project update."
99+
Journal of Open Source Software, 8(92), 5994, (2023).
100+
https://doi.org/10.21105/joss.05994
101+
102+
103+
**Recommended citation for pvlib iotools**
104+
105+
Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R.
106+
"pvlib iotools —- Open-source Python functions for seamless access to solar irradiance data."
107+
Solar Energy, 266, 112092, (2023).
108+
https://doi.org/10.1016/j.solener.2023.112092
109+
110+
**Historical citation for pvlib python**
111+
112+
Holmgren, W., Hansen, C., and Mikofski, M.
94113
"pvlib python: a python package for modeling solar energy systems."
95114
Journal of Open Source Software, 3(29), 884, (2018).
96115
https://doi.org/10.21105/joss.00884
97116

98-
Please also cite the DOI corresponding to the specific version of
99-
pvlib-python that you used. pvlib-python DOIs are listed at
100-
[Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version)
101-
102117
If you use pvlib-python in a commercial or publicly-available application, please
103118
consider displaying one of the "powered by pvlib" logos:
104119

@@ -131,10 +146,10 @@ History and acknowledgement
131146
===========================
132147

133148
pvlib python started out as a Python translation of the PVLIB MATLAB
134-
toolbox (developed by the `PVPMC <https://pvpmc.sandia.gov/>`_ at
149+
toolbox (developed by the [PVPMC](https://pvpmc.sandia.gov/) at
135150
Sandia National Laboratories) in 2013 and has grown substantially since then.
136151
Today it contains code contributions from over a hundred individuals worldwide
137-
and is maintained by a core group of PV modelers from a variety institutions.
152+
and is maintained by a core group of PV modelers from a variety of institutions.
138153

139154
pvlib has been supported directly and indirectly by DOE, NumFOCUS, and
140155
Google Summer of Code funding, university research projects,

‎docs/sphinx/source/index.rst

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -48,28 +48,37 @@ companies that allow their employees to contribute, and from personal time.
4848
Citing pvlib python
4949
===================
5050

51-
Many of the contributors to pvlib-python work in institutions where
51+
Many of the contributors to pvlib python work in institutions where
5252
citation metrics are used in performance or career evaluations. If you
5353
use pvlib python in a published work, please cite:
5454

55-
William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
55+
**Recommended citation for the pvlib python project**
56+
57+
Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A.
58+
"pvlib python: 2023 project update."
59+
Journal of Open Source Software, 8(92), 5994, (2023).
60+
https://doi.org/10.21105/joss.05994
61+
62+
63+
**Recommended citation for pvlib iotools**
64+
65+
Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R.
66+
"pvlib iotools — Open-source Python functions for seamless access to solar irradiance data."
67+
Solar Energy, 266, 112092, (2023).
68+
https://doi.org/10.1016/j.solener.2023.112092
69+
70+
**Historical citation for pvlib python**
71+
72+
Holmgren, W., Hansen, C., and Mikofski, M.
5673
"pvlib python: a python package for modeling solar energy systems."
5774
Journal of Open Source Software, 3(29), 884, (2018).
5875
https://doi.org/10.21105/joss.00884
5976

77+
**Version specific citation**
6078
Please also cite the DOI corresponding to the specific version of
6179
pvlib python that you used. pvlib python DOIs are listed at
6280
`Zenodo.org <https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version>`_
6381

64-
If you use pvlib-python in a commercial or publicly-available
65-
application, please consider displaying one of the "powered by pvlib"
66-
logos:
67-
68-
.. image:: _images/pvlib_powered_logo_horiz.png
69-
:width: 300
70-
71-
.. image:: _images/pvlib_powered_logo_vert.png
72-
:width: 300
7382

7483
Additional pvlib python publications include:
7584

@@ -94,6 +103,19 @@ Additional pvlib python publications include:
94103
"An Open Source Solar Power Forecasting Tool Using PVLIB-Python,"
95104
in 43rd Photovoltaic Specialists Conference, 2016.
96105

106+
107+
Logo
108+
====
109+
If you use pvlib python in a commercial or publicly-available
110+
application, please consider displaying one of the "powered by pvlib"
111+
logos:
112+
113+
.. image:: _images/pvlib_powered_logo_horiz.png
114+
:width: 300
115+
116+
.. image:: _images/pvlib_powered_logo_vert.png
117+
:width: 300
118+
97119
License
98120
=======
99121

@@ -108,21 +130,12 @@ pvlib python is a `NumFOCUS Affiliated Project <https://numfocus.org/sponsored-p
108130
:target: https://numfocus.org/sponsored-projects/affiliated-projects
109131
:alt: NumFocus Affliated Projects
110132

111-
Contents
112-
========
113-
114133
.. toctree::
115134
:maxdepth: 1
135+
:hidden:
116136

117137
user_guide/index
118138
gallery/index
119139
reference/index
120140
whatsnew
121141
contributing
122-
123-
124-
Indices and tables
125-
==================
126-
127-
* :ref:`genindex`
128-
* :ref:`search`

0 commit comments

Comments
 (0)
0