Edit project description in README, RTD, PyPI #1913
Conversation
docs/sphinx/source/index.rst
Outdated
| 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. |
There was a problem hiding this comment.
This is downplaying the continuing major contributions/role of Sandia and DOE quite a bit, it seems.
There was a problem hiding this comment.
Fair. Does this strike a better balance?
pvlib python started out as a Python translation of the PVLIB MATLAB toolbox
(developed by the PVPMC at Sandia National
Laboratories) in 2013. With continued support from the U.S. Department of
Energy since then, the project has attracted a diverse and growing community
of users and contributors across industry and academia.
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.
There was a problem hiding this comment.
I would strike "With continued support....DoE" I'm not sure that's factual before 2018
There was a problem hiding this comment.
DOE supported me as a postdoc 2015-2017. It wasn't the plan, but it made a big difference in pvlib's history.
There was a problem hiding this comment.
I did not know that. I withdraw my suggestion.
There was a problem hiding this comment.
I think a separate sentence or two on funding would be better than that "With..." clause. Suggestion to get us started: pvlib has been supported directly and indirectly by DOE and Numfocus funding, companies that allow their employees to contribute, and from personal time.
There was a problem hiding this comment.
+1 to adding an Acknowledgement of support
|
I would suggest having a separate "History and acknowledgment" section and focusing the main description on what pvlib is and can do instead of wasting the prime real estate on describing the MATLAB port. The fact that pvlib came from a MATLAB port 10 years ago is pretty uninteresting to most users... See my suggestion below pvlib pythonpvlib python is a community supported tool 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. The source code for pvlib python is hosted on github. Please see the Installation page for installation help. For examples of how to use pvlib python, please see Package Overview and our Jupyter Notebook tutorials. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages. The pvlib python GitHub wiki has a Projects and publications that use pvlib python page for inspiration and listing of your application. There is a variable naming convention to ensure consistency throughout the library. History and acknowledgementpvlib 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 of institutions. add stuff about DOE support of Will perhaps acknowledge Rob Andrews |
Co-authored-by: Anton Driesse <[email protected]>
Co-Authored-By: Adam R. Jensen <[email protected]> Co-Authored-By: Will Holmgren <[email protected]>
|
Any other reviews before this is merged? |
|
Thanks everyone for the input! |
|
I wish I had made the below suggestion, as mentioning "functions and classes" seems only to complicate the description without adding any particularly useful information. In my opinion, the very first line should convey what pvlib is as clearly and simply as possible. If this gets enough thumbs up, I'll go ahead an make a PR suggestion.
|
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.This PR follows up on this comment regarding clarifying that pvlib-python is the product of a community, not just Sandia: #1898 (reply in thread)
Feedback on these changes from said community is requested :)