10000 Edit project description in README, RTD, PyPI (#1913) · SamMahmoudoi/pvlib-python@c78ec3b · GitHub
[go: up one dir, main page]
Skip to content

Commit c78ec3b

Browse files
kandersolaradriesseAdamRJensenwholmgren
authored
Edit project description in README, RTD, PyPI (pvlib#1913)
* edit project description in README, RTD, PyPI * Apply suggestions from code review Co-authored-by: Anton Driesse <anton.driesse@pvperformancelabs.com> * adopt reviewer suggestions Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> Co-Authored-By: Will Holmgren <william.holmgren@gmail.com> * remove history and support statement from setup.py * add "university research projects" * README: move history/funding to separate section --------- Co-authored-by: Anton Driesse <anton.driesse@pvperformancelabs.com> Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> Co-authored-by: Will Holmgren <william.holmgren@gmail.com>
1 parent ecd8256 commit c78ec3b

File tree

3 files changed

+40
-21
lines changed

3 files changed

+40
-21
lines changed

‎README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,10 @@
6969
</table>
7070

7171

72-
pvlib python is a community supported tool that provides a set of
72+
pvlib python is a community developed toolbox that provides a set of
7373
functions and classes for simulating the performance of photovoltaic
74-
energy systems. pvlib python was originally ported from the PVLIB MATLAB
75-
toolbox developed at Sandia National Laboratories and it implements many
76-
of the models and methods developed at the Labs. More information on
77-
Sandia Labs PV performance modeling programs can be found at
78-
https://pvpmc.sandia.gov/. We collaborate with the PVLIB MATLAB project,
79-
but operate independently of it.
74+
energy systems and accomplishing related tasks. The core mission of pvlib python is to provide open,
75+
reliable, interoperable, and benchmark implementations of PV system models.
8076

8177

8278
Documentation
@@ -142,6 +138,20 @@ License
142138
BSD 3-clause.
143139

144140

141+
History and acknowledgement
142+
===========================
143+
144+
pvlib python started out as a Python translation of the PVLIB MATLAB
145+
toolbox (developed by the `PVPMC <https://pvpmc.sandia.gov/>`_ at
146+
Sandia National Laboratories) in 2013 and has grown substantially since then.
147+
Today it contains code contributions from over a hundred individuals worldwide
148+
and is maintained by a core group of PV modelers from a variety institutions.
149+
150+
pvlib has been supported directly and indirectly by DOE, NumFOCUS, and
151+
Google Summer of Code funding, university research projects,
152+
companies that allow their employees to contribute, and from personal time.
153+
154+
145155
NumFOCUS
146156
========
147157

‎docs/sphinx/source/index.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,14 @@
44
pvlib python
55
============
66

7-
pvlib python is a community supported tool that provides a set of
7+
pvlib python is a community developed toolbox that provides a set of
88
functions and classes for simulating the performance of photovoltaic
9-
energy systems. pvlib python was originally ported from the PVLIB MATLAB
10-
toolbox developed at Sandia National Laboratories and it implements many
11-
of the models and methods developed at the Labs. More information on
12-
Sandia Labs PV performance modeling programs can be found at the `PVPMC <https://pvpmc.sandia.gov/>`_. We collaborate with the PVLIB MATLAB project,
13-
but operate independently of it.
9+
energy systems and accomplishing related tasks.
10+
The core mission of pvlib python is to provide open,
11+
reliable, interoperable, and benchmark implementations of PV system models.
1412

1513
The source code for pvlib python is hosted on `github
1614
<https://github.com/pvlib/pvlib-python>`_.
17-
1815
Please see the :ref:`installation` page for installation help.
1916

2017
For examples of how to use pvlib python, please see
@@ -33,6 +30,21 @@ application.
3330
There is a :ref:`variable naming convention <variables_style_rules>` to
3431
ensure consistency throughout the library.
3532

33+
34+
History and acknowledgement
35+
===========================
36+
37+
pvlib python started out as a Python translation of the PVLIB MATLAB
38+
toolbox (developed by the `PVPMC <https://pvpmc.sandia.gov/>`_ at
39+
Sandia National Laboratories) in 2013 and has grown substantially since then.
40+
Today it contains code contributions from over a hundred individuals worldwide
41+
and is maintained by a core group of PV modelers from a variety institutions.
42+
43+
pvlib has been supported directly and indirectly by DOE, NumFOCUS, and
44+
Google Summer of Code funding, university research projects,
45+
companies that allow their employees to contribute, and from personal time.
46+
47+
3648
Citing pvlib python
3749
===================
3850

‎setup.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,11 @@
1212
DESCRIPTION = ('A set of functions and classes for simulating the ' +
1313
'performance of photovoltaic energy systems.')
1414
LONG_DESCRIPTION = """
15-
PVLIB Python is a community supported tool that provides a set of
15+
pvlib python is a community developed toolbox that provides a set of
1616
functions and classes for simulating the performance of photovoltaic
17-
energy systems. PVLIB Python was originally ported from the PVLIB MATLAB
18-
toolbox developed at Sandia National Laboratories and it implements many
19-
of the models and methods developed at the Labs. More information on
20-
Sandia Labs PV performance modeling programs can be found at
21-
https://pvpmc.sandia.gov/. We collaborate with the PVLIB MATLAB project,
22-
but operate independently of it.
17+
energy systems and accomplishing related tasks. The core mission of pvlib
18+
python is to provide open, reliable, interoperable, and benchmark
19+
implementations of PV system models.
2320
2421
We need your help to make pvlib-python a great tool!
2522

0 commit comments

Comments
 (0)
0