From 320886cad61bd8ab6c9d98108f41e6422e15ab5e Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 15 Nov 2023 13:49:08 -0500 Subject: [PATCH 1/6] edit project description in README, RTD, PyPI --- README.md | 14 ++++++++------ docs/sphinx/source/index.rst | 14 ++++++++------ setup.py | 16 +++++++++------- 3 files changed, 25 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6a1c68683a..1a0ef14374 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,14 @@ 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 -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. +energy systems. The core mission of pvlib python is to provide open, +reliable, interoperable, and benchmark implementations of PV system models. + +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. Documentation diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 2810d76ce0..0d7dff7650 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -6,12 +6,14 @@ pvlib python 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 -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 the `PVPMC `_. We collaborate with the PVLIB MATLAB project, -but operate independently of it. - +energy systems. The core mission of pvlib python is to provide open, +reliable, interoperable, and benchmark implementations of PV system models. + +pvlib python started out as a Python translation of the PVLIB MATLAB +toolbox (developed by the `PVPMC `_ 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. The source code for pvlib python is hosted on `github `_. diff --git a/setup.py b/setup.py index 5d9b1a69fd..14ded5a366 100755 --- a/setup.py +++ b/setup.py @@ -12,14 +12,16 @@ DESCRIPTION = ('A set of functions and classes for simulating the ' + 'performance of photovoltaic energy systems.') LONG_DESCRIPTION = """ -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 -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. +energy systems. The core mission of pvlib python is to provide open, +reliable, interoperable, and benchmark implementations of PV system models. + +pvlib python started out as a Python translation of the PVLIB MATLAB +toolbox (developed by the PVPMC 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. We need your help to make pvlib-python a great tool! From 091d47b5ba3a840970d351a501c5233719a2adb0 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Tue, 21 Nov 2023 10:59:34 -0500 Subject: [PATCH 2/6] Apply suggestions from code review Co-authored-by: Anton Driesse --- README.md | 4 ++-- docs/sphinx/source/index.rst | 2 +- setup.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1a0ef14374..499e422f70 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,9 @@ -pvlib python is a community supported tool that provides a set of +pvlib python is a community supported toolbox that provides a set of functions and classes for simulating the performance of photovoltaic -energy systems. The core mission of pvlib python is to provide open, +energy systems and accomplishing related tasks. The core mission of pvlib python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. pvlib python started out as a Python translation of the PVLIB MATLAB diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 0d7dff7650..2b46a4f2b0 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -4,7 +4,7 @@ pvlib python ============ -pvlib python is a community supported tool that provides a set of +pvlib python is a community supported toolbox that provides a set of functions and classes for simulating the performance of photovoltaic energy systems. The core mission of pvlib python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. diff --git a/setup.py b/setup.py index 14ded5a366..57b4d18510 100755 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ DESCRIPTION = ('A set of functions and classes for simulating the ' + 'performance of photovoltaic energy systems.') LONG_DESCRIPTION = """ -pvlib python is a community supported tool that provides a set of +pvlib python is a community supported toolbox that provides a set of functions and classes for simulating the performance of photovoltaic energy systems. The core mission of pvlib python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. From dfebe455f5ea36d7d8f48c7facb38245a5755641 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Tue, 21 Nov 2023 11:50:25 -0500 Subject: [PATCH 3/6] adopt reviewer suggestions Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> Co-Authored-By: Will Holmgren --- README.md | 6 +++++- docs/sphinx/source/index.rst | 26 ++++++++++++++++++-------- setup.py | 11 ++++++++--- 3 files changed, 31 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 499e422f70..a27cf353d3 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ -pvlib python is a community supported toolbox that provides a set of +pvlib python is a community developed toolbox that provides a set of functions and classes for simulating the performance of photovoltaic energy systems and accomplishing related tasks. The core mission of pvlib python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. @@ -80,6 +80,10 @@ 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. +pvlib has been supported directly and indirectly by DOE, NumFOCUS, and +Google Summer of Code funding, companies that allow their employees to +contribute, and from personal time. + Documentation ============= diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 2b46a4f2b0..dd46c31908 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -4,19 +4,14 @@ pvlib python ============ -pvlib python is a community supported toolbox that provides a set of +pvlib python is a community developed toolbox that provides a set of functions and classes for simulating the performance of photovoltaic -energy systems. The core mission of pvlib python is to provide open, +energy systems and accomplishing related tasks. +The core mission of pvlib python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. -pvlib python started out as a Python translation of the PVLIB MATLAB -toolbox (developed by the `PVPMC `_ 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. The source code for pvlib python is hosted on `github `_. - Please see the :ref:`installation` page for installation help. For examples of how to use pvlib python, please see @@ -35,6 +30,21 @@ application. There is a :ref:`variable naming convention ` to ensure consistency throughout the library. + +History and acknowledgement +=========================== + +pvlib python started out as a Python translation of the PVLIB MATLAB +toolbox (developed by the `PVPMC `_ 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. + +pvlib has been supported directly and indirectly by DOE, NumFOCUS, and +Google Summer of Code funding, companies that allow their employees to +contribute, and from personal time. + + Citing pvlib python =================== diff --git a/setup.py b/setup.py index 57b4d18510..7db13941ad 100755 --- a/setup.py +++ b/setup.py @@ -12,10 +12,11 @@ DESCRIPTION = ('A set of functions and classes for simulating the ' + 'performance of photovoltaic energy systems.') LONG_DESCRIPTION = """ -pvlib python is a community supported toolbox that provides a set of +pvlib python is a community developed toolbox that provides a set of functions and classes for simulating the performance of photovoltaic -energy systems. The core mission of pvlib python is to provide open, -reliable, interoperable, and benchmark implementations of PV system models. +energy systems and accomplishing related tasks. The core mission of pvlib +python is to provide open, reliable, interoperable, and benchmark +implementations of PV system models. pvlib python started out as a Python translation of the PVLIB MATLAB toolbox (developed by the PVPMC at Sandia National Laboratories) in 2013 and @@ -23,6 +24,10 @@ 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. +pvlib has been supported directly and indirectly by DOE, NumFOCUS, and +Google Summer of Code funding, companies that allow their employees to +contribute, and from personal time. + We need your help to make pvlib-python a great tool! Documentation: http://pvlib-python.readthedocs.io From 6f135ee5de58cc99e53a687d88ce52686aa00592 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Nov 2023 11:34:51 -0500 Subject: [PATCH 4/6] remove history and support statement from setup.py --- setup.py | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/setup.py b/setup.py index 7db13941ad..e031a4ee1f 100755 --- a/setup.py +++ b/setup.py @@ -18,16 +18,6 @@ python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. -pvlib python started out as a Python translation of the PVLIB MATLAB -toolbox (developed by the PVPMC 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. - -pvlib has been supported directly and indirectly by DOE, NumFOCUS, and -Google Summer of Code funding, companies that allow their employees to -contribute, and from personal time. - We need your help to make pvlib-python a great tool! Documentation: http://pvlib-python.readthedocs.io From e1d9b7faf2fb63322b99ee52891e844f481dfb94 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Nov 2023 11:35:41 -0500 Subject: [PATCH 5/6] add "university research projects" --- docs/sphinx/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index dd46c31908..d8d8d9debd 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -41,8 +41,8 @@ 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. pvlib has been supported directly and indirectly by DOE, NumFOCUS, and -Google Summer of Code funding, companies that allow their employees to -contribute, and from personal time. +Google Summer of Code funding, university research projects, +companies that allow their employees to contribute, and from personal time. Citing pvlib python From ba675020603d520bb3bc16249659c38456b04a28 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Nov 2023 11:39:01 -0500 Subject: [PATCH 6/6] README: move history/funding to separate section --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a27cf353d3..7a7d94500f 100644 --- a/README.md +++ b/README.md @@ -74,16 +74,6 @@ functions and classes for simulating the performance of photovoltaic energy systems and accomplishing related tasks. The core mission of pvlib python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. -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. - -pvlib has been supported directly and indirectly by DOE, NumFOCUS, and -Google Summer of Code funding, companies that allow their employees to -contribute, and from personal time. - Documentation ============= @@ -148,6 +138,20 @@ License BSD 3-clause. +History and acknowledgement +=========================== + +pvlib python started out as a Python translation of the PVLIB MATLAB +toolbox (developed by the `PVPMC `_ 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. + +pvlib has been supported directly and indirectly by DOE, NumFOCUS, and +Google Summer of Code funding, university research projects, +companies that allow their employees to contribute, and from personal time. + + NumFOCUS ========