From 1d6422e22f30ef218b85200a841101286d7a02d2 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Fri, 22 Dec 2023 20:47:23 +0100 Subject: [PATCH 1/8] Update joss badge --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a7d94500f..521184123d 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,8 @@ zenodo reference - - JOSS reference + + DOI badge From 7bc18838aa5b91e0b6b05472bd3e0a83cc7c810a Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Fri, 22 Dec 2023 20:52:10 +0100 Subject: [PATCH 2/8] Update citations section --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 521184123d..93030bc562 100644 --- a/README.md +++ b/README.md @@ -101,15 +101,21 @@ Citing If you 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 + Anderson et al., (2023). pvlib python: 2023 project update. + Journal of Open Source Software, 8(92), 5994. + https://doi.org/10.21105/joss.05994 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) +Also, if you use the pvlib iotools for data retrieval, please cite: + + Jensen et al., (2023). pvlib iotools—Open-source Python + functions for seamless access to solar irradiance data. + Solar Energy, 266, 112092. + https://doi.org/10.1016/j.solener.2023.112092 + If you use pvlib-python in a commercial or publicly-available application, please consider displaying one of the "powered by pvlib" logos: From 8828ad3f865eb823b60c23f88832d5b82c9e2906 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Fri, 22 Dec 2023 20:56:21 +0100 Subject: [PATCH 3/8] Update index.rst --- README.md | 2 +- docs/sphinx/source/index.rst | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 93030bc562..9e3a68d50b 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ pvlib-python that you used. pvlib-python DOIs are listed at Also, if you use the pvlib iotools for data retrieval, please cite: - Jensen et al., (2023). pvlib iotools—Open-source Python + Jensen et al., (2023). "pvlib iotools—Open-source Python". functions for seamless access to solar irradiance data. Solar Energy, 266, 112092. https://doi.org/10.1016/j.solener.2023.112092 diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index d8d8d9debd..1b1a299888 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -52,10 +52,9 @@ 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. - "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 + Anderson et al., (2023). "pvlib python: 2023 project update." + Journal of Open Source Software, 8(92), 5994. + https://doi.org/10.21105/joss.05994 Please also cite the DOI corresponding to the specific version of pvlib python that you used. pvlib python DOIs are listed at From 6775a206aa87f2aa9b8d5a23db76dbbc4a91daf4 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 25 Dec 2023 11:51:52 +0100 Subject: [PATCH 4/8] Update readme link to markdown --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e3a68d50b..76714272ad 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ History and acknowledgement =========================== pvlib python started out as a Python translation of the PVLIB MATLAB -toolbox (developed by the `PVPMC `_ 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. From 31043a6903af37440c87faf4e2f06fc0e30d42a5 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 25 Dec 2023 11:52:05 +0100 Subject: [PATCH 5/8] Update citations in index.rst --- docs/sphinx/source/index.rst | 47 +++++++++++++++++++++++++++--------- 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 1b1a299888..b5e09b32c4 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -48,27 +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: - Anderson et al., (2023). "pvlib python: 2023 project update." - Journal of Open Source Software, 8(92), 5994. +**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 `_ -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: @@ -93,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 ======= From f78f2625480f5877475578daf89f1e2a654e1171 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 25 Dec 2023 11:59:58 +0100 Subject: [PATCH 6/8] Remove clutter at bottom of index.rst page --- docs/sphinx/source/index.rst | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index b5e09b32c4..6bb6411387 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -129,22 +129,3 @@ pvlib python is a `NumFOCUS Affiliated Project Date: Tue, 2 Jan 2024 14:10:04 +0100 Subject: [PATCH 7/8] Implement code review changes --- README.md | 31 ++++++++++++++++++++----------- docs/sphinx/source/index.rst | 21 ++++++++++++++++++++- 2 files changed, 40 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 76714272ad..aa1545c738 100644 --- a/README.md +++ b/README.md @@ -99,23 +99,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: - Anderson et al., (2023). pvlib python: 2023 project update. - Journal of Open Source Software, 8(92), 5994. +**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 -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) -Also, if you use the pvlib iotools for data retrieval, please cite: +**Recommended citation for pvlib iotools** - Jensen et al., (2023). "pvlib iotools—Open-source Python". - functions for seamless access to solar irradiance data. - Solar Energy, 266, 112092. + 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 + If you use pvlib-python in a commercial or publicly-available application, please consider displaying one of the "powered by pvlib" logos: @@ -151,7 +160,7 @@ pvlib python started out as a Python translation of the PVLIB MATLAB 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, diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 6bb6411387..679be9e83c 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -63,7 +63,7 @@ use pvlib python in a published work, please cite: **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." + "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 @@ -129,3 +129,22 @@ pvlib python is a `NumFOCUS Affiliated Project Date: Tue, 2 Jan 2024 14:25:47 +0100 Subject: [PATCH 8/8] Remove indices/tables and contents header --- docs/sphinx/source/index.rst | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 679be9e83c..8e5773d639 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -130,9 +130,6 @@ pvlib python is a `NumFOCUS Affiliated Project