Skip to content

Edit project description in README, RTD, PyPI #1913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 29, 2023
Merged

Edit project description in README, RTD, PyPI #1913

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
320886c
edit project description in README, RTD, PyPI
kandersolar Nov 15, 2023
091d47b
Apply suggestions from code review
kandersolar Nov 21, 2023
dfebe45
adopt reviewer suggestions
kandersolar Nov 21, 2023
6f135ee
remove history and support statement from setup.py
kandersolar Nov 29, 2023
e1d9b7f
add "university research projects"
kandersolar Nov 29, 2023
ba67502
README: move history/funding to separate section
kandersolar Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 8 additions & 6 deletions docs/sphinx/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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.
Copy link
Member

@adriesse adriesse Nov 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is downplaying the continuing major contributions/role of Sandia and DOE quite a bit, it seems.

Copy link
Member Author

@kandersolar kandersolar Nov 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@cwhanse cwhanse Nov 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would strike "With continued support....DoE" I'm not sure that's factual before 2018

Copy link
Member

@wholmgren wholmgren Nov 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DOE supported me as a postdoc 2015-2017. It wasn't the plan, but it made a big difference in pvlib's history.

Copy link
Member

@cwhanse cwhanse Nov 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not know that. I withdraw my suggestion.

Copy link
Member

@wholmgren wholmgren Nov 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@cwhanse cwhanse Nov 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to adding an Acknowledgement of support

The source code for pvlib python is hosted on `github
<https://github.com/pvlib/pvlib-python>`_.

Expand Down
16 changes: 9 additions & 7 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down