Skip to content

Commit

Permalink
Update citation in pvlib readme (pvlib#1939)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
AdamRJensen authored Jan 18, 2024
1 parent 009e913 commit b67a668
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 31 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
<a href="https://doi.org/10.5281/zenodo.593284">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.593284.svg" alt="zenodo reference">
</a>
<a href="http://joss.theoj.org/papers/41187535cad22dd4b076c89b72f874b1">
<img src="http://joss.theoj.org/papers/41187535cad22dd4b076c89b72f874b1/status.svg" alt="JOSS reference" />
<a style="border-width:0" href="https://doi.org/10.21105/joss.05994">
<img src="https://joss.theoj.org/papers/10.21105/joss.05994/status.svg" alt="DOI badge" >
</a>
</td>
</tr>
Expand Down Expand Up @@ -88,17 +88,32 @@ The long-term success of pvlib-python requires substantial community support.
Citing
======

If you use pvlib-python in a published work, please cite:
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:

William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
**Recommended citation for the pvlib python project**

Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A.
"pvlib python: 2023 project update."
Journal of Open Source Software, 8(92), 5994, (2023).
https://doi.org/10.21105/joss.05994


**Recommended citation for pvlib iotools**

Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R.
"pvlib iotools —- Open-source Python functions for seamless access to solar irradiance data."
Solar Energy, 266, 112092, (2023).
https://doi.org/10.1016/j.solener.2023.112092

**Historical citation for pvlib python**

Holmgren, W., Hansen, C., and Mikofski, M.
"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
[Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version)

If you use pvlib-python in a commercial or publicly-available application, please
consider displaying one of the "powered by pvlib" logos:

Expand Down Expand Up @@ -131,10 +146,10 @@ History and acknowledgement
===========================

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

pvlib has been supported directly and indirectly by DOE, NumFOCUS, and
Google Summer of Code funding, university research projects,
Expand Down
55 changes: 34 additions & 21 deletions docs/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,37 @@ companies that allow their employees to contribute, and from personal time.
Citing pvlib python
===================

Many of the contributors to pvlib-python work in institutions where
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:

William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
**Recommended citation for the pvlib python project**

Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A.
"pvlib python: 2023 project update."
Journal of Open Source Software, 8(92), 5994, (2023).
https://doi.org/10.21105/joss.05994


**Recommended citation for pvlib iotools**

Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R.
"pvlib iotools — Open-source Python functions for seamless access to solar irradiance data."
Solar Energy, 266, 112092, (2023).
https://doi.org/10.1016/j.solener.2023.112092

**Historical citation for pvlib python**

Holmgren, W., Hansen, C., and Mikofski, M.
"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

**Version specific citation**
Please also cite the DOI corresponding to the specific version of
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>`_

If you use pvlib-python in a commercial or publicly-available
application, please consider displaying one of the "powered by pvlib"
logos:

.. image:: _images/pvlib_powered_logo_horiz.png
:width: 300

.. image:: _images/pvlib_powered_logo_vert.png
:width: 300

Additional pvlib python publications include:

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


Logo
====
If you use pvlib python in a commercial or publicly-available
application, please consider displaying one of the "powered by pvlib"
logos:

.. image:: _images/pvlib_powered_logo_horiz.png
:width: 300

.. image:: _images/pvlib_powered_logo_vert.png
:width: 300

License
=======

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

Contents
========

.. toctree::
:maxdepth: 1
:hidden:

user_guide/index
gallery/index
reference/index
whatsnew
contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

0 comments on commit b67a668

Please sign in to comment.